| blob | 13caa16cf17c3288d5437c4726c517ca3eaaeb8b |
1 *eval.txt* For Vim version 7.1. Last change: 2008 Feb 20
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:operator* *operator-variable*
1405 v:operator The last operator given in Normal mode. This is a single
1406 character except for commands starting with <g> or <z>,
1407 in which case it is two characters. Best used alongside
1408 |v:prevcount| and |v:register|. Useful if you want to cancel
1409 Operator-pending mode and then use the operator, e.g.: >
1410 :omap O <Esc>:call MyMotion(v:operator)<CR>
1411 < The value remains set until another operator is entered, thus
1412 don't expect it to be empty.
1413 v:operator is not set for |:delete|, |:yank| or other Ex
1414 commands.
1415 Read-only.
1417 *v:prevcount* *prevcount-variable*
1418 v:prevcount The count given for the last but one Normal mode command.
1419 This is the v:count value of the previous command. Useful if
1420 you want to cancel Visual or Operator-pending mode and then
1421 use the count, e.g.: >
1422 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
1423 < Read-only.
1425 *v:profiling* *profiling-variable*
1426 v:profiling Normally zero. Set to one after using ":profile start".
1427 See |profiling|.
1429 *v:progname* *progname-variable*
1430 v:progname Contains the name (with path removed) with which Vim was
1431 invoked. Allows you to do special initialisations for "view",
1432 "evim" etc., or any other name you might symlink to Vim.
1433 Read-only.
1435 *v:register* *register-variable*
1436 v:register The name of the register supplied to the last normal mode
1437 command. Empty if none were supplied. |getreg()| |setreg()|
1439 *v:scrollstart* *scrollstart-variable*
1440 v:scrollstart String describing the script or function that caused the
1441 screen to scroll up. It's only set when it is empty, thus the
1442 first reason is remembered. It is set to "Unknown" for a
1443 typed command.
1444 This can be used to find out why your script causes the
1445 hit-enter prompt.
1447 *v:servername* *servername-variable*
1448 v:servername The resulting registered |x11-clientserver| name if any.
1449 Read-only.
1451 *v:shell_error* *shell_error-variable*
1452 v:shell_error Result of the last shell command. When non-zero, the last
1453 shell command had an error. When zero, there was no problem.
1454 This only works when the shell returns the error code to Vim.
1455 The value -1 is often used when the command could not be
1456 executed. Read-only.
1457 Example: >
1458 :!mv foo bar
1459 :if v:shell_error
1460 : echo 'could not rename "foo" to "bar"!'
1461 :endif
1462 < "shell_error" also works, for backwards compatibility.
1464 *v:statusmsg* *statusmsg-variable*
1465 v:statusmsg Last given status message. It's allowed to set this variable.
1467 *v:swapname* *swapname-variable*
1468 v:swapname Only valid when executing |SwapExists| autocommands: Name of
1469 the swap file found. Read-only.
1471 *v:swapchoice* *swapchoice-variable*
1472 v:swapchoice |SwapExists| autocommands can set this to the selected choice
1473 for handling an existing swap file:
1474 'o' Open read-only
1475 'e' Edit anyway
1476 'r' Recover
1477 'd' Delete swapfile
1478 'q' Quit
1479 'a' Abort
1480 The value should be a single-character string. An empty value
1481 results in the user being asked, as would happen when there is
1482 no SwapExists autocommand. The default is empty.
1484 *v:swapcommand* *swapcommand-variable*
1485 v:swapcommand Normal mode command to be executed after a file has been
1486 opened. Can be used for a |SwapExists| autocommand to have
1487 another Vim open the file and jump to the right place. For
1488 example, when jumping to a tag the value is ":tag tagname\r".
1489 For ":edit +cmd file" the value is ":cmd\r".
1491 *v:termresponse* *termresponse-variable*
1492 v:termresponse The escape sequence returned by the terminal for the |t_RV|
1493 termcap entry. It is set when Vim receives an escape sequence
1494 that starts with ESC [ or CSI and ends in a 'c', with only
1495 digits, ';' and '.' in between.
1496 When this option is set, the TermResponse autocommand event is
1497 fired, so that you can react to the response from the
1498 terminal.
1499 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
1500 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
1501 patch level (since this was introduced in patch 95, it's
1502 always 95 or bigger). Pc is always zero.
1503 {only when compiled with |+termresponse| feature}
1505 *v:this_session* *this_session-variable*
1506 v:this_session Full filename of the last loaded or saved session file. See
1507 |:mksession|. It is allowed to set this variable. When no
1508 session file has been saved, this variable is empty.
1509 "this_session" also works, for backwards compatibility.
1511 *v:throwpoint* *throwpoint-variable*
1512 v:throwpoint The point where the exception most recently caught and not
1513 finished was thrown. Not set when commands are typed. See
1514 also |v:exception| and |throw-variables|.
1515 Example: >
1516 :try
1517 : throw "oops"
1518 :catch /.*/
1519 : echo "Exception from" v:throwpoint
1520 :endtry
1521 < Output: "Exception from test.vim, line 2"
1523 *v:val* *val-variable*
1524 v:val Value of the current item of a |List| or |Dictionary|. Only
1525 valid while evaluating the expression used with |map()| and
1526 |filter()|. Read-only.
1528 *v:version* *version-variable*
1529 v:version Version number of Vim: Major version number times 100 plus
1530 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
1531 is 501. Read-only. "version" also works, for backwards
1532 compatibility.
1533 Use |has()| to check if a certain patch was included, e.g.: >
1534 if has("patch123")
1535 < Note that patch numbers are specific to the version, thus both
1536 version 5.0 and 5.1 may have a patch 123, but these are
1537 completely different.
1539 *v:warningmsg* *warningmsg-variable*
1540 v:warningmsg Last given warning message. It's allowed to set this variable.
1542 ==============================================================================
1543 4. Builtin Functions *functions*
1545 See |function-list| for a list grouped by what the function is used for.
1547 (Use CTRL-] on the function name to jump to the full explanation.)
1549 USAGE RESULT DESCRIPTION ~
1551 add( {list}, {item}) List append {item} to |List| {list}
1552 append( {lnum}, {string}) Number append {string} below line {lnum}
1553 append( {lnum}, {list}) Number append lines {list} below line {lnum}
1554 argc() Number number of files in the argument list
1555 argidx() Number current index in the argument list
1556 argv( {nr}) String {nr} entry of the argument list
1557 argv( ) List the argument list
1558 browse( {save}, {title}, {initdir}, {default})
1559 String put up a file requester
1560 browsedir( {title}, {initdir}) String put up a directory requester
1561 bufexists( {expr}) Number TRUE if buffer {expr} exists
1562 buflisted( {expr}) Number TRUE if buffer {expr} is listed
1563 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
1564 bufname( {expr}) String Name of the buffer {expr}
1565 bufnr( {expr}) Number Number of the buffer {expr}
1566 bufwinnr( {expr}) Number window number of buffer {expr}
1567 byte2line( {byte}) Number line number at byte count {byte}
1568 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
1569 call( {func}, {arglist} [, {dict}])
1570 any call {func} with arguments {arglist}
1571 changenr() Number current change number
1572 char2nr( {expr}) Number ASCII value of first char in {expr}
1573 cindent( {lnum}) Number C indent for line {lnum}
1574 clearmatches() None clear all matches
1575 col( {expr}) Number column nr of cursor or mark
1576 complete({startcol}, {matches}) String set Insert mode completion
1577 complete_add( {expr}) Number add completion match
1578 complete_check() Number check for key typed during completion
1579 confirm( {msg} [, {choices} [, {default} [, {type}]]])
1580 Number number of choice picked by user
1581 copy( {expr}) any make a shallow copy of {expr}
1582 count( {list}, {expr} [, {start} [, {ic}]])
1583 Number count how many {expr} are in {list}
1584 cscope_connection( [{num} , {dbpath} [, {prepend}]])
1585 Number checks existence of cscope connection
1586 cursor( {lnum}, {col} [, {coladd}])
1587 Number move cursor to {lnum}, {col}, {coladd}
1588 cursor( {list}) Number move cursor to position in {list}
1589 deepcopy( {expr}) any make a full copy of {expr}
1590 delete( {fname}) Number delete file {fname}
1591 did_filetype() Number TRUE if FileType autocommand event used
1592 diff_filler( {lnum}) Number diff filler lines about {lnum}
1593 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
1594 empty( {expr}) Number TRUE if {expr} is empty
1595 escape( {string}, {chars}) String escape {chars} in {string} with '\'
1596 eval( {string}) any evaluate {string} into its value
1597 eventhandler( ) Number TRUE if inside an event handler
1598 executable( {expr}) Number 1 if executable {expr} exists
1599 exists( {expr}) Number TRUE if {expr} exists
1600 extend({expr1}, {expr2} [, {expr3}])
1601 List/Dict insert items of {expr2} into {expr1}
1602 expand( {expr}) String expand special keywords in {expr}
1603 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer
1604 filereadable( {file}) Number TRUE if {file} is a readable file
1605 filewritable( {file}) Number TRUE if {file} is a writable file
1606 filter( {expr}, {string}) List/Dict remove items from {expr} where
1607 {string} is 0
1608 finddir( {name}[, {path}[, {count}]])
1609 String find directory {name} in {path}
1610 findfile( {name}[, {path}[, {count}]])
1611 String find file {name} in {path}
1612 fnamemodify( {fname}, {mods}) String modify file name
1613 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
1614 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
1615 foldlevel( {lnum}) Number fold level at {lnum}
1616 foldtext( ) String line displayed for closed fold
1617 foldtextresult( {lnum}) String text for closed fold at {lnum}
1618 foreground( ) Number bring the Vim window to the foreground
1619 function( {name}) Funcref reference to function {name}
1620 garbagecollect( [at_exit]) none free memory, breaking cyclic references
1621 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
1622 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
1623 getbufline( {expr}, {lnum} [, {end}])
1624 List lines {lnum} to {end} of buffer {expr}
1625 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr}
1626 getchar( [expr]) Number get one character from the user
1627 getcharmod( ) Number modifiers for the last typed character
1628 getcmdline() String return the current command-line
1629 getcmdpos() Number return cursor position in command-line
1630 getcmdtype() String return the current command-line type
1631 getcwd() String the current working directory
1632 getfperm( {fname}) String file permissions of file {fname}
1633 getfsize( {fname}) Number size in bytes of file {fname}
1634 getfontname( [{name}]) String name of font being used
1635 getftime( {fname}) Number last modification time of file
1636 getftype( {fname}) String description of type of file {fname}
1637 getline( {lnum}) String line {lnum} of current buffer
1638 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
1639 getloclist({nr}) List list of location list items
1640 getmatches() List list of current matches
1641 getpid() Number process ID of Vim
1642 getpos( {expr}) List position of cursor, mark, etc.
1643 getqflist() List list of quickfix items
1644 getreg( [{regname} [, 1]]) String contents of register
1645 getregtype( [{regname}]) String type of register
1646 gettabwinvar( {tabnr}, {winnr}, {name})
1647 any {name} in {winnr} in tab page {tabnr}
1648 getwinposx() Number X coord in pixels of GUI Vim window
1649 getwinposy() Number Y coord in pixels of GUI Vim window
1650 getwinvar( {nr}, {varname}) any variable {varname} in window {nr}
1651 glob( {expr}) String expand file wildcards in {expr}
1652 globpath( {path}, {expr}) String do glob({expr}) for all dirs in {path}
1653 has( {feature}) Number TRUE if feature {feature} supported
1654 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
1655 haslocaldir() Number TRUE if current window executed |:lcd|
1656 hasmapto( {what} [, {mode} [, {abbr}]])
1657 Number TRUE if mapping to {what} exists
1658 histadd( {history},{item}) String add an item to a history
1659 histdel( {history} [, {item}]) String remove an item from a history
1660 histget( {history} [, {index}]) String get the item {index} from a history
1661 histnr( {history}) Number highest index of a history
1662 hlexists( {name}) Number TRUE if highlight group {name} exists
1663 hlID( {name}) Number syntax ID of highlight group {name}
1664 hostname() String name of the machine Vim is running on
1665 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
1666 indent( {lnum}) Number indent of line {lnum}
1667 index( {list}, {expr} [, {start} [, {ic}]])
1668 Number index in {list} where {expr} appears
1669 input( {prompt} [, {text} [, {completion}]])
1670 String get input from the user
1671 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
1672 inputlist( {textlist}) Number let the user pick from a choice list
1673 inputrestore() Number restore typeahead
1674 inputsave() Number save and clear typeahead
1675 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
1676 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
1677 isdirectory( {directory}) Number TRUE if {directory} is a directory
1678 islocked( {expr}) Number TRUE if {expr} is locked
1679 items( {dict}) List key-value pairs in {dict}
1680 join( {list} [, {sep}]) String join {list} items into one String
1681 keys( {dict}) List keys in {dict}
1682 len( {expr}) Number the length of {expr}
1683 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
1684 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
1685 line( {expr}) Number line nr of cursor, last line or mark
1686 line2byte( {lnum}) Number byte count of line {lnum}
1687 lispindent( {lnum}) Number Lisp indent for line {lnum}
1688 localtime() Number current time
1689 map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
1690 maparg( {name}[, {mode} [, {abbr}]])
1691 String rhs of mapping {name} in mode {mode}
1692 mapcheck( {name}[, {mode} [, {abbr}]])
1693 String check for mappings matching {name}
1694 match( {expr}, {pat}[, {start}[, {count}]])
1695 Number position where {pat} matches in {expr}
1696 matchadd( {group}, {pattern}[, {priority}[, {id}]])
1697 Number highlight {pattern} with {group}
1698 matcharg( {nr}) List arguments of |:match|
1699 matchdelete( {id}) Number delete match identified by {id}
1700 matchend( {expr}, {pat}[, {start}[, {count}]])
1701 Number position where {pat} ends in {expr}
1702 matchlist( {expr}, {pat}[, {start}[, {count}]])
1703 List match and submatches of {pat} in {expr}
1704 matchstr( {expr}, {pat}[, {start}[, {count}]])
1705 String {count}'th match of {pat} in {expr}
1706 max({list}) Number maximum value of items in {list}
1707 min({list}) Number minimum value of items in {list}
1708 mkdir({name} [, {path} [, {prot}]])
1709 Number create directory {name}
1710 mode() String current editing mode
1711 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
1712 nr2char( {expr}) String single char with ASCII value {expr}
1713 pathshorten( {expr}) String shorten directory names in a path
1714 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
1715 printf( {fmt}, {expr1}...) String format text
1716 pumvisible() Number whether popup menu is visible
1717 range( {expr} [, {max} [, {stride}]])
1718 List items from {expr} to {max}
1719 readfile({fname} [, {binary} [, {max}]])
1720 List get list of lines from file {fname}
1721 reltime( [{start} [, {end}]]) List get time value
1722 reltimestr( {time}) String turn time value into a String
1723 remote_expr( {server}, {string} [, {idvar}])
1724 String send expression
1725 remote_foreground( {server}) Number bring Vim server to the foreground
1726 remote_peek( {serverid} [, {retvar}])
1727 Number check for reply string
1728 remote_read( {serverid}) String read reply string
1729 remote_send( {server}, {string} [, {idvar}])
1730 String send key sequence
1731 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
1732 remove( {dict}, {key}) any remove entry {key} from {dict}
1733 rename( {from}, {to}) Number rename (move) file from {from} to {to}
1734 repeat( {expr}, {count}) String repeat {expr} {count} times
1735 resolve( {filename}) String get filename a shortcut points to
1736 reverse( {list}) List reverse {list} in-place
1737 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
1738 Number search for {pattern}
1739 searchdecl({name} [, {global} [, {thisblock}]])
1740 Number search for variable declaration
1741 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
1742 Number search for other end of start/end pair
1743 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
1744 List search for other end of start/end pair
1745 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
1746 List search for {pattern}
1747 server2client( {clientid}, {string})
1748 Number send reply string
1749 serverlist() String get a list of available servers
1750 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
1751 setcmdpos( {pos}) Number set cursor position in command-line
1752 setline( {lnum}, {line}) Number set line {lnum} to {line}
1753 setloclist( {nr}, {list}[, {action}])
1754 Number modify location list using {list}
1755 setmatches( {list}) Number restore a list of matches
1756 setpos( {expr}, {list}) none set the {expr} position to {list}
1757 setqflist( {list}[, {action}]) Number modify quickfix list using {list}
1758 setreg( {n}, {v}[, {opt}]) Number set register to value and type
1759 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
1760 {winnr} in tab page {tabnr} to {val}
1761 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
1762 shellescape( {string}) String escape {string} for use as shell
1763 command argument
1764 simplify( {filename}) String simplify filename as much as possible
1765 sort( {list} [, {func}]) List sort {list}, using {func} to compare
1766 soundfold( {word}) String sound-fold {word}
1767 spellbadword() String badly spelled word at cursor
1768 spellsuggest( {word} [, {max} [, {capital}]])
1769 List spelling suggestions
1770 split( {expr} [, {pat} [, {keepempty}]])
1771 List make |List| from {pat} separated {expr}
1772 str2nr( {expr} [, {base}]) Number convert string to number
1773 strftime( {format}[, {time}]) String time in specified format
1774 stridx( {haystack}, {needle}[, {start}])
1775 Number index of {needle} in {haystack}
1776 string( {expr}) String String representation of {expr} value
1777 strlen( {expr}) Number length of the String {expr}
1778 strpart( {src}, {start}[, {len}])
1779 String {len} characters of {src} at {start}
1780 strridx( {haystack}, {needle} [, {start}])
1781 Number last index of {needle} in {haystack}
1782 strtrans( {expr}) String translate string to make it printable
1783 submatch( {nr}) String specific match in ":substitute"
1784 substitute( {expr}, {pat}, {sub}, {flags})
1785 String all {pat} in {expr} replaced with {sub}
1786 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
1787 synIDattr( {synID}, {what} [, {mode}])
1788 String attribute {what} of syntax ID {synID}
1789 synIDtrans( {synID}) Number translated syntax ID of {synID}
1790 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
1791 system( {expr} [, {input}]) String output of shell command/filter {expr}
1792 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
1793 tabpagenr( [{arg}]) Number number of current or last tab page
1794 tabpagewinnr( {tabarg}[, {arg}])
1795 Number number of current window in tab page
1796 taglist( {expr}) List list of tags matching {expr}
1797 tagfiles() List tags files used
1798 tempname() String name for a temporary file
1799 tolower( {expr}) String the String {expr} switched to lowercase
1800 toupper( {expr}) String the String {expr} switched to uppercase
1801 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
1802 to chars in {tostr}
1803 type( {name}) Number type of variable {name}
1804 values( {dict}) List values in {dict}
1805 virtcol( {expr}) Number screen column of cursor or mark
1806 visualmode( [expr]) String last visual mode used
1807 winbufnr( {nr}) Number buffer number of window {nr}
1808 wincol() Number window column of the cursor
1809 winheight( {nr}) Number height of window {nr}
1810 winline() Number window line of the cursor
1811 winnr( [{expr}]) Number number of current window
1812 winrestcmd() String returns command to restore window sizes
1813 winrestview({dict}) None restore view of current window
1814 winsaveview() Dict save view of current window
1815 winwidth( {nr}) Number width of window {nr}
1816 writefile({list}, {fname} [, {binary}])
1817 Number write list of lines to file {fname}
1819 add({list}, {expr}) *add()*
1820 Append the item {expr} to |List| {list}. Returns the
1821 resulting |List|. Examples: >
1822 :let alist = add([1, 2, 3], item)
1823 :call add(mylist, "woodstock")
1824 < Note that when {expr} is a |List| it is appended as a single
1825 item. Use |extend()| to concatenate |Lists|.
1826 Use |insert()| to add an item at another position.
1829 append({lnum}, {expr}) *append()*
1830 When {expr} is a |List|: Append each item of the |List| as a
1831 text line below line {lnum} in the current buffer.
1832 Otherwise append {expr} as one text line below line {lnum} in
1833 the current buffer.
1834 {lnum} can be zero to insert a line before the first one.
1835 Returns 1 for failure ({lnum} out of range or out of memory),
1836 0 for success. Example: >
1837 :let failed = append(line('$'), "# THE END")
1838 :let failed = append(0, ["Chapter 1", "the beginning"])
1839 <
1840 *argc()*
1841 argc() The result is the number of files in the argument list of the
1842 current window. See |arglist|.
1844 *argidx()*
1845 argidx() The result is the current index in the argument list. 0 is
1846 the first file. argc() - 1 is the last one. See |arglist|.
1848 *argv()*
1849 argv([{nr}]) The result is the {nr}th file in the argument list of the
1850 current window. See |arglist|. "argv(0)" is the first one.
1851 Example: >
1852 :let i = 0
1853 :while i < argc()
1854 : let f = escape(argv(i), '. ')
1855 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
1856 : let i = i + 1
1857 :endwhile
1858 < Without the {nr} argument a |List| with the whole |arglist| is
1859 returned.
1861 *browse()*
1862 browse({save}, {title}, {initdir}, {default})
1863 Put up a file requester. This only works when "has("browse")"
1864 returns non-zero (only in some GUI versions).
1865 The input fields are:
1866 {save} when non-zero, select file to write
1867 {title} title for the requester
1868 {initdir} directory to start browsing in
1869 {default} default file name
1870 When the "Cancel" button is hit, something went wrong, or
1871 browsing is not possible, an empty string is returned.
1873 *browsedir()*
1874 browsedir({title}, {initdir})
1875 Put up a directory requester. This only works when
1876 "has("browse")" returns non-zero (only in some GUI versions).
1877 On systems where a directory browser is not supported a file
1878 browser is used. In that case: select a file in the directory
1879 to be used.
1880 The input fields are:
1881 {title} title for the requester
1882 {initdir} directory to start browsing in
1883 When the "Cancel" button is hit, something went wrong, or
1884 browsing is not possible, an empty string is returned.
1886 bufexists({expr}) *bufexists()*
1887 The result is a Number, which is non-zero if a buffer called
1888 {expr} exists.
1889 If the {expr} argument is a number, buffer numbers are used.
1890 If the {expr} argument is a string it must match a buffer name
1891 exactly. The name can be:
1892 - Relative to the current directory.
1893 - A full path.
1894 - The name of a buffer with 'filetype' set to "nofile".
1895 - A URL name.
1896 Unlisted buffers will be found.
1897 Note that help files are listed by their short name in the
1898 output of |:buffers|, but bufexists() requires using their
1899 long name to be able to find them.
1900 Use "bufexists(0)" to test for the existence of an alternate
1901 file name.
1902 *buffer_exists()*
1903 Obsolete name: buffer_exists().
1905 buflisted({expr}) *buflisted()*
1906 The result is a Number, which is non-zero if a buffer called
1907 {expr} exists and is listed (has the 'buflisted' option set).
1908 The {expr} argument is used like with |bufexists()|.
1910 bufloaded({expr}) *bufloaded()*
1911 The result is a Number, which is non-zero if a buffer called
1912 {expr} exists and is loaded (shown in a window or hidden).
1913 The {expr} argument is used like with |bufexists()|.
1915 bufname({expr}) *bufname()*
1916 The result is the name of a buffer, as it is displayed by the
1917 ":ls" command.
1918 If {expr} is a Number, that buffer number's name is given.
1919 Number zero is the alternate buffer for the current window.
1920 If {expr} is a String, it is used as a |file-pattern| to match
1921 with the buffer names. This is always done like 'magic' is
1922 set and 'cpoptions' is empty. When there is more than one
1923 match an empty string is returned.
1924 "" or "%" can be used for the current buffer, "#" for the
1925 alternate buffer.
1926 A full match is preferred, otherwise a match at the start, end
1927 or middle of the buffer name is accepted. If you only want a
1928 full match then put "^" at the start and "$" at the end of the
1929 pattern.
1930 Listed buffers are found first. If there is a single match
1931 with a listed buffer, that one is returned. Next unlisted
1932 buffers are searched for.
1933 If the {expr} is a String, but you want to use it as a buffer
1934 number, force it to be a Number by adding zero to it: >
1935 :echo bufname("3" + 0)
1936 < If the buffer doesn't exist, or doesn't have a name, an empty
1937 string is returned. >
1938 bufname("#") alternate buffer name
1939 bufname(3) name of buffer 3
1940 bufname("%") name of current buffer
1941 bufname("file2") name of buffer where "file2" matches.
1942 < *buffer_name()*
1943 Obsolete name: buffer_name().
1945 *bufnr()*
1946 bufnr({expr} [, {create}])
1947 The result is the number of a buffer, as it is displayed by
1948 the ":ls" command. For the use of {expr}, see |bufname()|
1949 above.
1950 If the buffer doesn't exist, -1 is returned. Or, if the
1951 {create} argument is present and not zero, a new, unlisted,
1952 buffer is created and its number is returned.
1953 bufnr("$") is the last buffer: >
1954 :let last_buffer = bufnr("$")
1955 < The result is a Number, which is the highest buffer number
1956 of existing buffers. Note that not all buffers with a smaller
1957 number necessarily exist, because ":bwipeout" may have removed
1958 them. Use bufexists() to test for the existence of a buffer.
1959 *buffer_number()*
1960 Obsolete name: buffer_number().
1961 *last_buffer_nr()*
1962 Obsolete name for bufnr("$"): last_buffer_nr().
1964 bufwinnr({expr}) *bufwinnr()*
1965 The result is a Number, which is the number of the first
1966 window associated with buffer {expr}. For the use of {expr},
1967 see |bufname()| above. If buffer {expr} doesn't exist or
1968 there is no such window, -1 is returned. Example: >
1970 echo "A window containing buffer 1 is " . (bufwinnr(1))
1972 < The number can be used with |CTRL-W_w| and ":wincmd w"
1973 |:wincmd|.
1974 Only deals with the current tab page.
1977 byte2line({byte}) *byte2line()*
1978 Return the line number that contains the character at byte
1979 count {byte} in the current buffer. This includes the
1980 end-of-line character, depending on the 'fileformat' option
1981 for the current buffer. The first character has byte count
1982 one.
1983 Also see |line2byte()|, |go| and |:goto|.
1984 {not available when compiled without the |+byte_offset|
1985 feature}
1987 byteidx({expr}, {nr}) *byteidx()*
1988 Return byte index of the {nr}'th character in the string
1989 {expr}. Use zero for the first character, it returns zero.
1990 This function is only useful when there are multibyte
1991 characters, otherwise the returned value is equal to {nr}.
1992 Composing characters are counted as a separate character.
1993 Example : >
1994 echo matchstr(str, ".", byteidx(str, 3))
1995 < will display the fourth character. Another way to do the
1996 same: >
1997 let s = strpart(str, byteidx(str, 3))
1998 echo strpart(s, 0, byteidx(s, 1))
1999 < If there are less than {nr} characters -1 is returned.
2000 If there are exactly {nr} characters the length of the string
2001 is returned.
2003 call({func}, {arglist} [, {dict}]) *call()* *E699*
2004 Call function {func} with the items in |List| {arglist} as
2005 arguments.
2006 {func} can either be a |Funcref| or the name of a function.
2007 a:firstline and a:lastline are set to the cursor line.
2008 Returns the return value of the called function.
2009 {dict} is for functions with the "dict" attribute. It will be
2010 used to set the local variable "self". |Dictionary-function|
2012 changenr() *changenr()*
2013 Return the number of the most recent change. This is the same
2014 number as what is displayed with |:undolist| and can be used
2015 with the |:undo| command.
2016 When a change was made it is the number of that change. After
2017 redo it is the number of the redone change. After undo it is
2018 one less than the number of the undone change.
2020 char2nr({expr}) *char2nr()*
2021 Return number value of the first char in {expr}. Examples: >
2022 char2nr(" ") returns 32
2023 char2nr("ABC") returns 65
2024 < The current 'encoding' is used. Example for "utf-8": >
2025 char2nr("á") returns 225
2026 char2nr("á"[0]) returns 195
2027 < nr2char() does the opposite.
2029 cindent({lnum}) *cindent()*
2030 Get the amount of indent for line {lnum} according the C
2031 indenting rules, as with 'cindent'.
2032 The indent is counted in spaces, the value of 'tabstop' is
2033 relevant. {lnum} is used just like in |getline()|.
2034 When {lnum} is invalid or Vim was not compiled the |+cindent|
2035 feature, -1 is returned.
2036 See |C-indenting|.
2038 clearmatches() *clearmatches()*
2039 Clears all matches previously defined by |matchadd()| and the
2040 |:match| commands.
2042 *col()*
2043 col({expr}) The result is a Number, which is the byte index of the column
2044 position given with {expr}. The accepted positions are:
2045 . the cursor position
2046 $ the end of the cursor line (the result is the
2047 number of characters in the cursor line plus one)
2048 'x position of mark x (if the mark is not set, 0 is
2049 returned)
2050 Additionally {expr} can be [lnum, col]: a |List| with the line
2051 and column number. Most useful when the column is "$", to get
2052 the las column of a specific line. When "lnum" or "col" is
2053 out of range then col() returns zero.
2054 To get the line number use |line()|. To get both use
2055 |getpos()|.
2056 For the screen column position use |virtcol()|.
2057 Note that only marks in the current file can be used.
2058 Examples: >
2059 col(".") column of cursor
2060 col("$") length of cursor line plus one
2061 col("'t") column of mark t
2062 col("'" . markname) column of mark markname
2063 < The first column is 1. 0 is returned for an error.
2064 For an uppercase mark the column may actually be in another
2065 buffer.
2066 For the cursor position, when 'virtualedit' is active, the
2067 column is one higher if the cursor is after the end of the
2068 line. This can be used to obtain the column in Insert mode: >
2069 :imap <F2> <C-O>:let save_ve = &ve<CR>
2070 \<C-O>:set ve=all<CR>
2071 \<C-O>:echo col(".") . "\n" <Bar>
2072 \let &ve = save_ve<CR>
2073 <
2075 complete({startcol}, {matches}) *complete()* *E785*
2076 Set the matches for Insert mode completion.
2077 Can only be used in Insert mode. You need to use a mapping
2078 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or
2079 with an expression mapping.
2080 {startcol} is the byte offset in the line where the completed
2081 text start. The text up to the cursor is the original text
2082 that will be replaced by the matches. Use col('.') for an
2083 empty string. "col('.') - 1" will replace one character by a
2084 match.
2085 {matches} must be a |List|. Each |List| item is one match.
2086 See |complete-items| for the kind of items that are possible.
2087 Note that the after calling this function you need to avoid
2088 inserting anything that would completion to stop.
2089 The match can be selected with CTRL-N and CTRL-P as usual with
2090 Insert mode completion. The popup menu will appear if
2091 specified, see |ins-completion-menu|.
2092 Example: >
2093 inoremap <F5> <C-R>=ListMonths()<CR>
2095 func! ListMonths()
2096 call complete(col('.'), ['January', 'February', 'March',
2097 \ 'April', 'May', 'June', 'July', 'August', 'September',
2098 \ 'October', 'November', 'December'])
2099 return ''
2100 endfunc
2101 < This isn't very useful, but it shows how it works. Note that
2102 an empty string is returned to avoid a zero being inserted.
2104 complete_add({expr}) *complete_add()*
2105 Add {expr} to the list of matches. Only to be used by the
2106 function specified with the 'completefunc' option.
2107 Returns 0 for failure (empty string or out of memory),
2108 1 when the match was added, 2 when the match was already in
2109 the list.
2110 See |complete-functions| for an explanation of {expr}. It is
2111 the same as one item in the list that 'omnifunc' would return.
2113 complete_check() *complete_check()*
2114 Check for a key typed while looking for completion matches.
2115 This is to be used when looking for matches takes some time.
2116 Returns non-zero when searching for matches is to be aborted,
2117 zero otherwise.
2118 Only to be used by the function specified with the
2119 'completefunc' option.
2121 *confirm()*
2122 confirm({msg} [, {choices} [, {default} [, {type}]]])
2123 Confirm() offers the user a dialog, from which a choice can be
2124 made. It returns the number of the choice. For the first
2125 choice this is 1.
2126 Note: confirm() is only supported when compiled with dialog
2127 support, see |+dialog_con| and |+dialog_gui|.
2128 {msg} is displayed in a |dialog| with {choices} as the
2129 alternatives. When {choices} is missing or empty, "&OK" is
2130 used (and translated).
2131 {msg} is a String, use '\n' to include a newline. Only on
2132 some systems the string is wrapped when it doesn't fit.
2133 {choices} is a String, with the individual choices separated
2134 by '\n', e.g. >
2135 confirm("Save changes?", "&Yes\n&No\n&Cancel")
2136 < The letter after the '&' is the shortcut key for that choice.
2137 Thus you can type 'c' to select "Cancel". The shortcut does
2138 not need to be the first letter: >
2139 confirm("file has been modified", "&Save\nSave &All")
2140 < For the console, the first letter of each choice is used as
2141 the default shortcut key.
2142 The optional {default} argument is the number of the choice
2143 that is made if the user hits <CR>. Use 1 to make the first
2144 choice the default one. Use 0 to not set a default. If
2145 {default} is omitted, 1 is used.
2146 The optional {type} argument gives the type of dialog. This
2147 is only used for the icon of the Win32 GUI. It can be one of
2148 these values: "Error", "Question", "Info", "Warning" or
2149 "Generic". Only the first character is relevant. When {type}
2150 is omitted, "Generic" is used.
2151 If the user aborts the dialog by pressing <Esc>, CTRL-C,
2152 or another valid interrupt key, confirm() returns 0.
2154 An example: >
2155 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
2156 :if choice == 0
2157 : echo "make up your mind!"
2158 :elseif choice == 3
2159 : echo "tasteful"
2160 :else
2161 : echo "I prefer bananas myself."
2162 :endif
2163 < In a GUI dialog, buttons are used. The layout of the buttons
2164 depends on the 'v' flag in 'guioptions'. If it is included,
2165 the buttons are always put vertically. Otherwise, confirm()
2166 tries to put the buttons in one horizontal line. If they
2167 don't fit, a vertical layout is used anyway. For some systems
2168 the horizontal layout is always used.
2170 *copy()*
2171 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
2172 different from using {expr} directly.
2173 When {expr} is a |List| a shallow copy is created. This means
2174 that the original |List| can be changed without changing the
2175 copy, and vise versa. But the items are identical, thus
2176 changing an item changes the contents of both |Lists|. Also
2177 see |deepcopy()|.
2179 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
2180 Return the number of times an item with value {expr} appears
2181 in |List| or |Dictionary| {comp}.
2182 If {start} is given then start with the item with this index.
2183 {start} can only be used with a |List|.
2184 When {ic} is given and it's non-zero then case is ignored.
2187 *cscope_connection()*
2188 cscope_connection([{num} , {dbpath} [, {prepend}]])
2189 Checks for the existence of a |cscope| connection. If no
2190 parameters are specified, then the function returns:
2191 0, if cscope was not available (not compiled in), or
2192 if there are no cscope connections;
2193 1, if there is at least one cscope connection.
2195 If parameters are specified, then the value of {num}
2196 determines how existence of a cscope connection is checked:
2198 {num} Description of existence check
2199 ----- ------------------------------
2200 0 Same as no parameters (e.g., "cscope_connection()").
2201 1 Ignore {prepend}, and use partial string matches for
2202 {dbpath}.
2203 2 Ignore {prepend}, and use exact string matches for
2204 {dbpath}.
2205 3 Use {prepend}, use partial string matches for both
2206 {dbpath} and {prepend}.
2207 4 Use {prepend}, use exact string matches for both
2208 {dbpath} and {prepend}.
2210 Note: All string comparisons are case sensitive!
2212 Examples. Suppose we had the following (from ":cs show"): >
2214 # pid database name prepend path
2215 0 27664 cscope.out /usr/local
2216 <
2217 Invocation Return Val ~
2218 ---------- ---------- >
2219 cscope_connection() 1
2220 cscope_connection(1, "out") 1
2221 cscope_connection(2, "out") 0
2222 cscope_connection(3, "out") 0
2223 cscope_connection(3, "out", "local") 1
2224 cscope_connection(4, "out") 0
2225 cscope_connection(4, "out", "local") 0
2226 cscope_connection(4, "cscope.out", "/usr/local") 1
2227 <
2228 cursor({lnum}, {col} [, {off}]) *cursor()*
2229 cursor({list})
2230 Positions the cursor at the column (byte count) {col} in the
2231 line {lnum}. The first column is one.
2232 When there is one argument {list} this is used as a |List|
2233 with two or three items {lnum}, {col} and {off}. This is like
2234 the return value of |getpos()|, but without the first item.
2235 Does not change the jumplist.
2236 If {lnum} is greater than the number of lines in the buffer,
2237 the cursor will be positioned at the last line in the buffer.
2238 If {lnum} is zero, the cursor will stay in the current line.
2239 If {col} is greater than the number of bytes in the line,
2240 the cursor will be positioned at the last character in the
2241 line.
2242 If {col} is zero, the cursor will stay in the current column.
2243 When 'virtualedit' is used {off} specifies the offset in
2244 screen columns from the start of the character. E.g., a
2245 position within a <Tab> or after the last character.
2248 deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
2249 Make a copy of {expr}. For Numbers and Strings this isn't
2250 different from using {expr} directly.
2251 When {expr} is a |List| a full copy is created. This means
2252 that the original |List| can be changed without changing the
2253 copy, and vise versa. When an item is a |List|, a copy for it
2254 is made, recursively. Thus changing an item in the copy does
2255 not change the contents of the original |List|.
2256 When {noref} is omitted or zero a contained |List| or
2257 |Dictionary| is only copied once. All references point to
2258 this single copy. With {noref} set to 1 every occurrence of a
2259 |List| or |Dictionary| results in a new copy. This also means
2260 that a cyclic reference causes deepcopy() to fail.
2261 *E724*
2262 Nesting is possible up to 100 levels. When there is an item
2263 that refers back to a higher level making a deep copy with
2264 {noref} set to 1 will fail.
2265 Also see |copy()|.
2267 delete({fname}) *delete()*
2268 Deletes the file by the name {fname}. The result is a Number,
2269 which is 0 if the file was deleted successfully, and non-zero
2270 when the deletion failed.
2271 Use |remove()| to delete an item from a |List|.
2273 *did_filetype()*
2274 did_filetype() Returns non-zero when autocommands are being executed and the
2275 FileType event has been triggered at least once. Can be used
2276 to avoid triggering the FileType event again in the scripts
2277 that detect the file type. |FileType|
2278 When editing another file, the counter is reset, thus this
2279 really checks if the FileType event has been triggered for the
2280 current buffer. This allows an autocommand that starts
2281 editing another buffer to set 'filetype' and load a syntax
2282 file.
2284 diff_filler({lnum}) *diff_filler()*
2285 Returns the number of filler lines above line {lnum}.
2286 These are the lines that were inserted at this point in
2287 another diff'ed window. These filler lines are shown in the
2288 display but don't exist in the buffer.
2289 {lnum} is used like with |getline()|. Thus "." is the current
2290 line, "'m" mark m, etc.
2291 Returns 0 if the current window is not in diff mode.
2293 diff_hlID({lnum}, {col}) *diff_hlID()*
2294 Returns the highlight ID for diff mode at line {lnum} column
2295 {col} (byte index). When the current line does not have a
2296 diff change zero is returned.
2297 {lnum} is used like with |getline()|. Thus "." is the current
2298 line, "'m" mark m, etc.
2299 {col} is 1 for the leftmost column, {lnum} is 1 for the first
2300 line.
2301 The highlight ID can be used with |synIDattr()| to obtain
2302 syntax information about the highlighting.
2304 empty({expr}) *empty()*
2305 Return the Number 1 if {expr} is empty, zero otherwise.
2306 A |List| or |Dictionary| is empty when it does not have any
2307 items. A Number is empty when its value is zero.
2308 For a long |List| this is much faster then comparing the
2309 length with zero.
2311 escape({string}, {chars}) *escape()*
2312 Escape the characters in {chars} that occur in {string} with a
2313 backslash. Example: >
2314 :echo escape('c:\program files\vim', ' \')
2315 < results in: >
2316 c:\\program\ files\\vim
2318 < *eval()*
2319 eval({string}) Evaluate {string} and return the result. Especially useful to
2320 turn the result of |string()| back into the original value.
2321 This works for Numbers, Strings and composites of them.
2322 Also works for |Funcref|s that refer to existing functions.
2324 eventhandler() *eventhandler()*
2325 Returns 1 when inside an event handler. That is that Vim got
2326 interrupted while waiting for the user to type a character,
2327 e.g., when dropping a file on Vim. This means interactive
2328 commands cannot be used. Otherwise zero is returned.
2330 executable({expr}) *executable()*
2331 This function checks if an executable with the name {expr}
2332 exists. {expr} must be the name of the program without any
2333 arguments.
2334 executable() uses the value of $PATH and/or the normal
2335 searchpath for programs. *PATHEXT*
2336 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
2337 optionally be included. Then the extensions in $PATHEXT are
2338 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
2339 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
2340 used. A dot by itself can be used in $PATHEXT to try using
2341 the name without an extension. When 'shell' looks like a
2342 Unix shell, then the name is also tried without adding an
2343 extension.
2344 On MS-DOS and MS-Windows it only checks if the file exists and
2345 is not a directory, not if it's really executable.
2346 On MS-Windows an executable in the same directory as Vim is
2347 always found. Since this directory is added to $PATH it
2348 should also work to execute it |win32-PATH|.
2349 The result is a Number:
2350 1 exists
2351 0 does not exist
2352 -1 not implemented on this system
2354 *exists()*
2355 exists({expr}) The result is a Number, which is non-zero if {expr} is
2356 defined, zero otherwise. The {expr} argument is a string,
2357 which contains one of these:
2358 &option-name Vim option (only checks if it exists,
2359 not if it really works)
2360 +option-name Vim option that works.
2361 $ENVNAME environment variable (could also be
2362 done by comparing with an empty
2363 string)
2364 *funcname built-in function (see |functions|)
2365 or user defined function (see
2366 |user-functions|).
2367 varname internal variable (see
2368 |internal-variables|). Also works
2369 for |curly-braces-names|, |Dictionary|
2370 entries, |List| items, etc. Beware
2371 that this may cause functions to be
2372 invoked cause an error message for an
2373 invalid expression.
2374 :cmdname Ex command: built-in command, user
2375 command or command modifier |:command|.
2376 Returns:
2377 1 for match with start of a command
2378 2 full match with a command
2379 3 matches several user commands
2380 To check for a supported command
2381 always check the return value to be 2.
2382 :2match The |:2match| command.
2383 :3match The |:3match| command.
2384 #event autocommand defined for this event
2385 #event#pattern autocommand defined for this event and
2386 pattern (the pattern is taken
2387 literally and compared to the
2388 autocommand patterns character by
2389 character)
2390 #group autocommand group exists
2391 #group#event autocommand defined for this group and
2392 event.
2393 #group#event#pattern
2394 autocommand defined for this group,
2395 event and pattern.
2396 ##event autocommand for this event is
2397 supported.
2398 For checking for a supported feature use |has()|.
2400 Examples: >
2401 exists("&shortname")
2402 exists("$HOSTNAME")
2403 exists("*strftime")
2404 exists("*s:MyFunc")
2405 exists("bufcount")
2406 exists(":Make")
2407 exists("#CursorHold")
2408 exists("#BufReadPre#*.gz")
2409 exists("#filetypeindent")
2410 exists("#filetypeindent#FileType")
2411 exists("#filetypeindent#FileType#*")
2412 exists("##ColorScheme")
2413 < There must be no space between the symbol (&/$/*/#) and the
2414 name.
2415 There must be no extra characters after the name, although in
2416 a few cases this is ignored. That may become more strict in
2417 the future, thus don't count on it!
2418 Working example: >
2419 exists(":make")
2420 < NOT working example: >
2421 exists(":make install")
2423 < Note that the argument must be a string, not the name of the
2424 variable itself. For example: >
2425 exists(bufcount)
2426 < This doesn't check for existence of the "bufcount" variable,
2427 but gets the value of "bufcount", and checks if that exists.
2429 expand({expr} [, {flag}]) *expand()*
2430 Expand wildcards and the following special keywords in {expr}.
2431 The result is a String.
2433 When there are several matches, they are separated by <NL>
2434 characters. [Note: in version 5.0 a space was used, which
2435 caused problems when a file name contains a space]
2437 If the expansion fails, the result is an empty string. A name
2438 for a non-existing file is not included.
2440 When {expr} starts with '%', '#' or '<', the expansion is done
2441 like for the |cmdline-special| variables with their associated
2442 modifiers. Here is a short overview:
2444 % current file name
2445 # alternate file name
2446 #n alternate file name n
2447 <cfile> file name under the cursor
2448 <afile> autocmd file name
2449 <abuf> autocmd buffer number (as a String!)
2450 <amatch> autocmd matched name
2451 <sfile> sourced script file name
2452 <cword> word under the cursor
2453 <cWORD> WORD under the cursor
2454 <client> the {clientid} of the last received
2455 message |server2client()|
2456 Modifiers:
2457 :p expand to full path
2458 :h head (last path component removed)
2459 :t tail (last path component only)
2460 :r root (one extension removed)
2461 :e extension only
2463 Example: >
2464 :let &tags = expand("%:p:h") . "/tags"
2465 < Note that when expanding a string that starts with '%', '#' or
2466 '<', any following text is ignored. This does NOT work: >
2467 :let doesntwork = expand("%:h.bak")
2468 < Use this: >
2469 :let doeswork = expand("%:h") . ".bak"
2470 < Also note that expanding "<cfile>" and others only returns the
2471 referenced file name without further expansion. If "<cfile>"
2472 is "~/.cshrc", you need to do another expand() to have the
2473 "~/" expanded into the path of the home directory: >
2474 :echo expand(expand("<cfile>"))
2475 <
2476 There cannot be white space between the variables and the
2477 following modifier. The |fnamemodify()| function can be used
2478 to modify normal file names.
2480 When using '%' or '#', and the current or alternate file name
2481 is not defined, an empty string is used. Using "%:p" in a
2482 buffer with no name, results in the current directory, with a
2483 '/' added.
2485 When {expr} does not start with '%', '#' or '<', it is
2486 expanded like a file name is expanded on the command line.
2487 'suffixes' and 'wildignore' are used, unless the optional
2488 {flag} argument is given and it is non-zero. Names for
2489 non-existing files are included. The "**" item can be used to
2490 search in a directory tree. For example, to find all "README"
2491 files in the current directory and below: >
2492 :echo expand("**/README")
2493 <
2494 Expand() can also be used to expand variables and environment
2495 variables that are only known in a shell. But this can be
2496 slow, because a shell must be started. See |expr-env-expand|.
2497 The expanded variable is still handled like a list of file
2498 names. When an environment variable cannot be expanded, it is
2499 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2500 "$FOOBAR".
2502 See |glob()| for finding existing files. See |system()| for
2503 getting the raw output of an external command.
2505 extend({expr1}, {expr2} [, {expr3}]) *extend()*
2506 {expr1} and {expr2} must be both |Lists| or both
2507 |Dictionaries|.
2509 If they are |Lists|: Append {expr2} to {expr1}.
2510 If {expr3} is given insert the items of {expr2} before item
2511 {expr3} in {expr1}. When {expr3} is zero insert before the
2512 first item. When {expr3} is equal to len({expr1}) then
2513 {expr2} is appended.
2514 Examples: >
2515 :echo sort(extend(mylist, [7, 5]))
2516 :call extend(mylist, [2, 3], 1)
2517 < Use |add()| to concatenate one item to a list. To concatenate
2518 two lists into a new list use the + operator: >
2519 :let newlist = [1, 2, 3] + [4, 5]
2520 <
2521 If they are |Dictionaries|:
2522 Add all entries from {expr2} to {expr1}.
2523 If a key exists in both {expr1} and {expr2} then {expr3} is
2524 used to decide what to do:
2525 {expr3} = "keep": keep the value of {expr1}
2526 {expr3} = "force": use the value of {expr2}
2527 {expr3} = "error": give an error message *E737*
2528 When {expr3} is omitted then "force" is assumed.
2530 {expr1} is changed when {expr2} is not empty. If necessary
2531 make a copy of {expr1} first.
2532 {expr2} remains unchanged.
2533 Returns {expr1}.
2536 feedkeys({string} [, {mode}]) *feedkeys()*
2537 Characters in {string} are queued for processing as if they
2538 come from a mapping or were typed by the user. They are added
2539 to the end of the typeahead buffer, thus if a mapping is still
2540 being executed these characters come after them.
2541 The function does not wait for processing of keys contained in
2542 {string}.
2543 To include special keys into {string}, use double-quotes
2544 and "\..." notation |expr-quote|. For example,
2545 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2546 feedkeys('\<CR>') pushes 5 characters.
2547 If {mode} is absent, keys are remapped.
2548 {mode} is a String, which can contain these character flags:
2549 'm' Remap keys. This is default.
2550 'n' Do not remap keys.
2551 't' Handle keys as if typed; otherwise they are handled as
2552 if coming from a mapping. This matters for undo,
2553 opening folds, etc.
2554 Return value is always 0.
2556 filereadable({file}) *filereadable()*
2557 The result is a Number, which is TRUE when a file with the
2558 name {file} exists, and can be read. If {file} doesn't exist,
2559 or is a directory, the result is FALSE. {file} is any
2560 expression, which is used as a String.
2561 If you don't care about the file being readable you can use
2562 |glob()|.
2563 *file_readable()*
2564 Obsolete name: file_readable().
2567 filewritable({file}) *filewritable()*
2568 The result is a Number, which is 1 when a file with the
2569 name {file} exists, and can be written. If {file} doesn't
2570 exist, or is not writable, the result is 0. If (file) is a
2571 directory, and we can write to it, the result is 2.
2574 filter({expr}, {string}) *filter()*
2575 {expr} must be a |List| or a |Dictionary|.
2576 For each item in {expr} evaluate {string} and when the result
2577 is zero remove the item from the |List| or |Dictionary|.
2578 Inside {string} |v:val| has the value of the current item.
2579 For a |Dictionary| |v:key| has the key of the current item.
2580 Examples: >
2581 :call filter(mylist, 'v:val !~ "OLD"')
2582 < Removes the items where "OLD" appears. >
2583 :call filter(mydict, 'v:key >= 8')
2584 < Removes the items with a key below 8. >
2585 :call filter(var, 0)
2586 < Removes all the items, thus clears the |List| or |Dictionary|.
2588 Note that {string} is the result of expression and is then
2589 used as an expression again. Often it is good to use a
2590 |literal-string| to avoid having to double backslashes.
2592 The operation is done in-place. If you want a |List| or
2593 |Dictionary| to remain unmodified make a copy first: >
2594 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2596 < Returns {expr}, the |List| or |Dictionary| that was filtered.
2597 When an error is encountered while evaluating {string} no
2598 further items in {expr} are processed.
2601 finddir({name}[, {path}[, {count}]]) *finddir()*
2602 Find directory {name} in {path}. Supports both downwards and
2603 upwards recursive directory searches. See |file-searching|
2604 for the syntax of {path}.
2605 Returns the path of the first found match. When the found
2606 directory is below the current directory a relative path is
2607 returned. Otherwise a full path is returned.
2608 If {path} is omitted or empty then 'path' is used.
2609 If the optional {count} is given, find {count}'s occurrence of
2610 {name} in {path} instead of the first one.
2611 When {count} is negative return all the matches in a |List|.
2612 This is quite similar to the ex-command |:find|.
2613 {only available when compiled with the +file_in_path feature}
2615 findfile({name}[, {path}[, {count}]]) *findfile()*
2616 Just like |finddir()|, but find a file instead of a directory.
2617 Uses 'suffixesadd'.
2618 Example: >
2619 :echo findfile("tags.vim", ".;")
2620 < Searches from the directory of the current file upwards until
2621 it finds the file "tags.vim".
2623 fnamemodify({fname}, {mods}) *fnamemodify()*
2624 Modify file name {fname} according to {mods}. {mods} is a
2625 string of characters like it is used for file names on the
2626 command line. See |filename-modifiers|.
2627 Example: >
2628 :echo fnamemodify("main.c", ":p:h")
2629 < results in: >
2630 /home/mool/vim/vim/src
2631 < Note: Environment variables and "~" don't work in {fname}, use
2632 |expand()| first then.
2634 foldclosed({lnum}) *foldclosed()*
2635 The result is a Number. If the line {lnum} is in a closed
2636 fold, the result is the number of the first line in that fold.
2637 If the line {lnum} is not in a closed fold, -1 is returned.
2639 foldclosedend({lnum}) *foldclosedend()*
2640 The result is a Number. If the line {lnum} is in a closed
2641 fold, the result is the number of the last line in that fold.
2642 If the line {lnum} is not in a closed fold, -1 is returned.
2644 foldlevel({lnum}) *foldlevel()*
2645 The result is a Number, which is the foldlevel of line {lnum}
2646 in the current buffer. For nested folds the deepest level is
2647 returned. If there is no fold at line {lnum}, zero is
2648 returned. It doesn't matter if the folds are open or closed.
2649 When used while updating folds (from 'foldexpr') -1 is
2650 returned for lines where folds are still to be updated and the
2651 foldlevel is unknown. As a special case the level of the
2652 previous line is usually available.
2654 *foldtext()*
2655 foldtext() Returns a String, to be displayed for a closed fold. This is
2656 the default function used for the 'foldtext' option and should
2657 only be called from evaluating 'foldtext'. It uses the
2658 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2659 The returned string looks like this: >
2660 +-- 45 lines: abcdef
2661 < The number of dashes depends on the foldlevel. The "45" is
2662 the number of lines in the fold. "abcdef" is the text in the
2663 first non-blank line of the fold. Leading white space, "//"
2664 or "/*" and the text from the 'foldmarker' and 'commentstring'
2665 options is removed.
2666 {not available when compiled without the |+folding| feature}
2668 foldtextresult({lnum}) *foldtextresult()*
2669 Returns the text that is displayed for the closed fold at line
2670 {lnum}. Evaluates 'foldtext' in the appropriate context.
2671 When there is no closed fold at {lnum} an empty string is
2672 returned.
2673 {lnum} is used like with |getline()|. Thus "." is the current
2674 line, "'m" mark m, etc.
2675 Useful when exporting folded text, e.g., to HTML.
2676 {not available when compiled without the |+folding| feature}
2678 *foreground()*
2679 foreground() Move the Vim window to the foreground. Useful when sent from
2680 a client to a Vim server. |remote_send()|
2681 On Win32 systems this might not work, the OS does not always
2682 allow a window to bring itself to the foreground. Use
2683 |remote_foreground()| instead.
2684 {only in the Win32, Athena, Motif and GTK GUI versions and the
2685 Win32 console version}
2688 function({name}) *function()* *E700*
2689 Return a |Funcref| variable that refers to function {name}.
2690 {name} can be a user defined function or an internal function.
2693 garbagecollect([at_exit]) *garbagecollect()*
2694 Cleanup unused |Lists| and |Dictionaries| that have circular
2695 references. There is hardly ever a need to invoke this
2696 function, as it is automatically done when Vim runs out of
2697 memory or is waiting for the user to press a key after
2698 'updatetime'. Items without circular references are always
2699 freed when they become unused.
2700 This is useful if you have deleted a very big |List| and/or
2701 |Dictionary| with circular references in a script that runs
2702 for a long time.
2703 When the optional "at_exit" argument is one, garbage
2704 collection will also be done when exiting Vim, if it wasn't
2705 done before. This is useful when checking for memory leaks.
2707 get({list}, {idx} [, {default}]) *get()*
2708 Get item {idx} from |List| {list}. When this item is not
2709 available return {default}. Return zero when {default} is
2710 omitted.
2711 get({dict}, {key} [, {default}])
2712 Get item with key {key} from |Dictionary| {dict}. When this
2713 item is not available return {default}. Return zero when
2714 {default} is omitted.
2716 *getbufline()*
2717 getbufline({expr}, {lnum} [, {end}])
2718 Return a |List| with the lines starting from {lnum} to {end}
2719 (inclusive) in the buffer {expr}. If {end} is omitted, a
2720 |List| with only the line {lnum} is returned.
2722 For the use of {expr}, see |bufname()| above.
2724 For {lnum} and {end} "$" can be used for the last line of the
2725 buffer. Otherwise a number must be used.
2727 When {lnum} is smaller than 1 or bigger than the number of
2728 lines in the buffer, an empty |List| is returned.
2730 When {end} is greater than the number of lines in the buffer,
2731 it is treated as {end} is set to the number of lines in the
2732 buffer. When {end} is before {lnum} an empty |List| is
2733 returned.
2735 This function works only for loaded buffers. For unloaded and
2736 non-existing buffers, an empty |List| is returned.
2738 Example: >
2739 :let lines = getbufline(bufnr("myfile"), 1, "$")
2741 getbufvar({expr}, {varname}) *getbufvar()*
2742 The result is the value of option or local buffer variable
2743 {varname} in buffer {expr}. Note that the name without "b:"
2744 must be used.
2745 This also works for a global or buffer-local option, but it
2746 doesn't work for a global variable, window-local variable or
2747 window-local option.
2748 For the use of {expr}, see |bufname()| above.
2749 When the buffer or variable doesn't exist an empty string is
2750 returned, there is no error message.
2751 Examples: >
2752 :let bufmodified = getbufvar(1, "&mod")
2753 :echo "todo myvar = " . getbufvar("todo", "myvar")
2754 <
2755 getchar([expr]) *getchar()*
2756 Get a single character from the user or input stream.
2757 If [expr] is omitted, wait until a character is available.
2758 If [expr] is 0, only get a character when one is available.
2759 Return zero otherwise.
2760 If [expr] is 1, only check if a character is available, it is
2761 not consumed. Return zero if no character available.
2763 Without {expr} and when {expr} is 0 a whole character or
2764 special key is returned. If it is an 8-bit character, the
2765 result is a number. Use nr2char() to convert it to a String.
2766 Otherwise a String is returned with the encoded character.
2767 For a special key it's a sequence of bytes starting with 0x80
2768 (decimal: 128). This is the same value as the string
2769 "\<Key>", e.g., "\<Left>". The returned value is also a
2770 String when a modifier (shift, control, alt) was used that is
2771 not included in the character.
2773 When {expr} is 1 only the first byte is returned. For a
2774 one-byte character it is the character itself as a number.
2775 Use nr2char() to convert it to a String.
2777 When the user clicks a mouse button, the mouse event will be
2778 returned. The position can then be found in |v:mouse_col|,
2779 |v:mouse_lnum| and |v:mouse_win|. This example positions the
2780 mouse as it would normally happen: >
2781 let c = getchar()
2782 if c == "\<LeftMouse>" && v:mouse_win > 0
2783 exe v:mouse_win . "wincmd w"
2784 exe v:mouse_lnum
2785 exe "normal " . v:mouse_col . "|"
2786 endif
2787 <
2788 There is no prompt, you will somehow have to make clear to the
2789 user that a character has to be typed.
2790 There is no mapping for the character.
2791 Key codes are replaced, thus when the user presses the <Del>
2792 key you get the code for the <Del> key, not the raw character
2793 sequence. Examples: >
2794 getchar() == "\<Del>"
2795 getchar() == "\<S-Left>"
2796 < This example redefines "f" to ignore case: >
2797 :nmap f :call FindChar()<CR>
2798 :function FindChar()
2799 : let c = nr2char(getchar())
2800 : while col('.') < col('$') - 1
2801 : normal l
2802 : if getline('.')[col('.') - 1] ==? c
2803 : break
2804 : endif
2805 : endwhile
2806 :endfunction
2808 getcharmod() *getcharmod()*
2809 The result is a Number which is the state of the modifiers for
2810 the last obtained character with getchar() or in another way.
2811 These values are added together:
2812 2 shift
2813 4 control
2814 8 alt (meta)
2815 16 mouse double click
2816 32 mouse triple click
2817 64 mouse quadruple click
2818 128 Macintosh only: command
2819 Only the modifiers that have not been included in the
2820 character itself are obtained. Thus Shift-a results in "A"
2821 with no modifier.
2823 getcmdline() *getcmdline()*
2824 Return the current command-line. Only works when the command
2825 line is being edited, thus requires use of |c_CTRL-\_e| or
2826 |c_CTRL-R_=|.
2827 Example: >
2828 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
2829 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
2831 getcmdpos() *getcmdpos()*
2832 Return the position of the cursor in the command line as a
2833 byte count. The first column is 1.
2834 Only works when editing the command line, thus requires use of
2835 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
2836 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
2838 getcmdtype() *getcmdtype()*
2839 Return the current command-line type. Possible return values
2840 are:
2841 : normal Ex command
2842 > debug mode command |debug-mode|
2843 / forward search command
2844 ? backward search command
2845 @ |input()| command
2846 - |:insert| or |:append| command
2847 Only works when editing the command line, thus requires use of
2848 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string
2849 otherwise.
2850 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
2852 *getcwd()*
2853 getcwd() The result is a String, which is the name of the current
2854 working directory.
2856 getfsize({fname}) *getfsize()*
2857 The result is a Number, which is the size in bytes of the
2858 given file {fname}.
2859 If {fname} is a directory, 0 is returned.
2860 If the file {fname} can't be found, -1 is returned.
2861 If the size of {fname} is too big to fit in a Number then -2
2862 is returned.
2864 getfontname([{name}]) *getfontname()*
2865 Without an argument returns the name of the normal font being
2866 used. Like what is used for the Normal highlight group
2867 |hl-Normal|.
2868 With an argument a check is done whether {name} is a valid
2869 font name. If not then an empty string is returned.
2870 Otherwise the actual font name is returned, or {name} if the
2871 GUI does not support obtaining the real name.
2872 Only works when the GUI is running, thus not in your vimrc or
2873 gvimrc file. Use the |GUIEnter| autocommand to use this
2874 function just after the GUI has started.
2875 Note that the GTK 2 GUI accepts any font name, thus checking
2876 for a valid name does not work.
2878 getfperm({fname}) *getfperm()*
2879 The result is a String, which is the read, write, and execute
2880 permissions of the given file {fname}.
2881 If {fname} does not exist or its directory cannot be read, an
2882 empty string is returned.
2883 The result is of the form "rwxrwxrwx", where each group of
2884 "rwx" flags represent, in turn, the permissions of the owner
2885 of the file, the group the file belongs to, and other users.
2886 If a user does not have a given permission the flag for this
2887 is replaced with the string "-". Example: >
2888 :echo getfperm("/etc/passwd")
2889 < This will hopefully (from a security point of view) display
2890 the string "rw-r--r--" or even "rw-------".
2892 getftime({fname}) *getftime()*
2893 The result is a Number, which is the last modification time of
2894 the given file {fname}. The value is measured as seconds
2895 since 1st Jan 1970, and may be passed to strftime(). See also
2896 |localtime()| and |strftime()|.
2897 If the file {fname} can't be found -1 is returned.
2899 getftype({fname}) *getftype()*
2900 The result is a String, which is a description of the kind of
2901 file of the given file {fname}.
2902 If {fname} does not exist an empty string is returned.
2903 Here is a table over different kinds of files and their
2904 results:
2905 Normal file "file"
2906 Directory "dir"
2907 Symbolic link "link"
2908 Block device "bdev"
2909 Character device "cdev"
2910 Socket "socket"
2911 FIFO "fifo"
2912 All other "other"
2913 Example: >
2914 getftype("/home")
2915 < Note that a type such as "link" will only be returned on
2916 systems that support it. On some systems only "dir" and
2917 "file" are returned.
2919 *getline()*
2920 getline({lnum} [, {end}])
2921 Without {end} the result is a String, which is line {lnum}
2922 from the current buffer. Example: >
2923 getline(1)
2924 < When {lnum} is a String that doesn't start with a
2925 digit, line() is called to translate the String into a Number.
2926 To get the line under the cursor: >
2927 getline(".")
2928 < When {lnum} is smaller than 1 or bigger than the number of
2929 lines in the buffer, an empty string is returned.
2931 When {end} is given the result is a |List| where each item is
2932 a line from the current buffer in the range {lnum} to {end},
2933 including line {end}.
2934 {end} is used in the same way as {lnum}.
2935 Non-existing lines are silently omitted.
2936 When {end} is before {lnum} an empty |List| is returned.
2937 Example: >
2938 :let start = line('.')
2939 :let end = search("^$") - 1
2940 :let lines = getline(start, end)
2942 < To get lines from another buffer see |getbufline()|
2944 getloclist({nr}) *getloclist()*
2945 Returns a list with all the entries in the location list for
2946 window {nr}. When {nr} is zero the current window is used.
2947 For a location list window, the displayed location list is
2948 returned. For an invalid window number {nr}, an empty list is
2949 returned. Otherwise, same as getqflist().
2951 getmatches() *getmatches()*
2952 Returns a |List| with all matches previously defined by
2953 |matchadd()| and the |:match| commands. |getmatches()| is
2954 useful in combination with |setmatches()|, as |setmatches()|
2955 can restore a list of matches saved by |getmatches()|.
2956 Example: >
2957 :echo getmatches()
2958 < [{'group': 'MyGroup1', 'pattern': 'TODO',
2959 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
2960 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
2961 :let m = getmatches()
2962 :call clearmatches()
2963 :echo getmatches()
2964 < [] >
2965 :call setmatches(m)
2966 :echo getmatches()
2967 < [{'group': 'MyGroup1', 'pattern': 'TODO',
2968 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
2969 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
2970 :unlet m
2971 <
2973 getqflist() *getqflist()*
2974 Returns a list with all the current quickfix errors. Each
2975 list item is a dictionary with these entries:
2976 bufnr number of buffer that has the file name, use
2977 bufname() to get the name
2978 lnum line number in the buffer (first line is 1)
2979 col column number (first column is 1)
2980 vcol non-zero: "col" is visual column
2981 zero: "col" is byte index
2982 nr error number
2983 pattern search pattern used to locate the error
2984 text description of the error
2985 type type of the error, 'E', '1', etc.
2986 valid non-zero: recognized error message
2988 When there is no error list or it's empty an empty list is
2989 returned. Quickfix list entries with non-existing buffer
2990 number are returned with "bufnr" set to zero.
2992 Useful application: Find pattern matches in multiple files and
2993 do something with them: >
2994 :vimgrep /theword/jg *.c
2995 :for d in getqflist()
2996 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
2997 :endfor
3000 getreg([{regname} [, 1]]) *getreg()*
3001 The result is a String, which is the contents of register
3002 {regname}. Example: >
3003 :let cliptext = getreg('*')
3004 < getreg('=') returns the last evaluated value of the expression
3005 register. (For use in maps.)
3006 getreg('=', 1) returns the expression itself, so that it can
3007 be restored with |setreg()|. For other registers the extra
3008 argument is ignored, thus you can always give it.
3009 If {regname} is not specified, |v:register| is used.
3012 getregtype([{regname}]) *getregtype()*
3013 The result is a String, which is type of register {regname}.
3014 The value will be one of:
3015 "v" for |characterwise| text
3016 "V" for |linewise| text
3017 "<CTRL-V>{width}" for |blockwise-visual| text
3018 0 for an empty or unknown register
3019 <CTRL-V> is one character with value 0x16.
3020 If {regname} is not specified, |v:register| is used.
3022 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()*
3023 Get the value of window-local variable {varname} in window
3024 {winnr} in tab page {tabnr}.
3025 When {varname} starts with "&" get the value of a window-local
3026 option.
3027 Tabs are numbered starting with one. For the current tabpage
3028 use |getwinvar()|.
3029 When {winnr} is zero the current window is used.
3030 This also works for a global option, buffer-local option and
3031 window-local option, but it doesn't work for a global variable
3032 or buffer-local variable.
3033 When {varname} is empty a dictionary with all window-local
3034 variables is returned.
3035 Note that {varname} must be the name without "w:".
3036 Examples: >
3037 :let list_is_on = gettabwinvar(1, 2, '&list')
3038 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
3039 <
3040 *getwinposx()*
3041 getwinposx() The result is a Number, which is the X coordinate in pixels of
3042 the left hand side of the GUI Vim window. The result will be
3043 -1 if the information is not available.
3045 *getwinposy()*
3046 getwinposy() The result is a Number, which is the Y coordinate in pixels of
3047 the top of the GUI Vim window. The result will be -1 if the
3048 information is not available.
3050 getwinvar({winnr}, {varname}) *getwinvar()*
3051 Like |gettabwinvar()| for the current tabpage.
3052 Examples: >
3053 :let list_is_on = getwinvar(2, '&list')
3054 :echo "myvar = " . getwinvar(1, 'myvar')
3055 <
3056 *glob()*
3057 glob({expr}) Expand the file wildcards in {expr}. See |wildcards| for the
3058 use of special characters.
3059 The result is a String.
3060 When there are several matches, they are separated by <NL>
3061 characters.
3062 If the expansion fails, the result is an empty string.
3063 A name for a non-existing file is not included.
3065 For most systems backticks can be used to get files names from
3066 any external command. Example: >
3067 :let tagfiles = glob("`find . -name tags -print`")
3068 :let &tags = substitute(tagfiles, "\n", ",", "g")
3069 < The result of the program inside the backticks should be one
3070 item per line. Spaces inside an item are allowed.
3072 See |expand()| for expanding special Vim variables. See
3073 |system()| for getting the raw output of an external command.
3075 globpath({path}, {expr}) *globpath()*
3076 Perform glob() on all directories in {path} and concatenate
3077 the results. Example: >
3078 :echo globpath(&rtp, "syntax/c.vim")
3079 < {path} is a comma-separated list of directory names. Each
3080 directory name is prepended to {expr} and expanded like with
3081 glob(). A path separator is inserted when needed.
3082 To add a comma inside a directory name escape it with a
3083 backslash. Note that on MS-Windows a directory may have a
3084 trailing backslash, remove it if you put a comma after it.
3085 If the expansion fails for one of the directories, there is no
3086 error message.
3087 The 'wildignore' option applies: Names matching one of the
3088 patterns in 'wildignore' will be skipped.
3090 The "**" item can be used to search in a directory tree.
3091 For example, to find all "README.txt" files in the directories
3092 in 'runtimepath' and below: >
3093 :echo globpath(&rtp, "**/README.txt")
3094 <
3095 *has()*
3096 has({feature}) The result is a Number, which is 1 if the feature {feature} is
3097 supported, zero otherwise. The {feature} argument is a
3098 string. See |feature-list| below.
3099 Also see |exists()|.
3102 has_key({dict}, {key}) *has_key()*
3103 The result is a Number, which is 1 if |Dictionary| {dict} has
3104 an entry with key {key}. Zero otherwise.
3106 haslocaldir() *haslocaldir()*
3107 The result is a Number, which is 1 when the current
3108 window has set a local path via |:lcd|, and 0 otherwise.
3110 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
3111 The result is a Number, which is 1 if there is a mapping that
3112 contains {what} in somewhere in the rhs (what it is mapped to)
3113 and this mapping exists in one of the modes indicated by
3114 {mode}.
3115 When {abbr} is there and it is non-zero use abbreviations
3116 instead of mappings. Don't forget to specify Insert and/or
3117 Command-line mode.
3118 Both the global mappings and the mappings local to the current
3119 buffer are checked for a match.
3120 If no matching mapping is found 0 is returned.
3121 The following characters are recognized in {mode}:
3122 n Normal mode
3123 v Visual mode
3124 o Operator-pending mode
3125 i Insert mode
3126 l Language-Argument ("r", "f", "t", etc.)
3127 c Command-line mode
3128 When {mode} is omitted, "nvo" is used.
3130 This function is useful to check if a mapping already exists
3131 to a function in a Vim script. Example: >
3132 :if !hasmapto('\ABCdoit')
3133 : map <Leader>d \ABCdoit
3134 :endif
3135 < This installs the mapping to "\ABCdoit" only if there isn't
3136 already a mapping to "\ABCdoit".
3138 histadd({history}, {item}) *histadd()*
3139 Add the String {item} to the history {history} which can be
3140 one of: *hist-names*
3141 "cmd" or ":" command line history
3142 "search" or "/" search pattern history
3143 "expr" or "=" typed expression history
3144 "input" or "@" input line history
3145 If {item} does already exist in the history, it will be
3146 shifted to become the newest entry.
3147 The result is a Number: 1 if the operation was successful,
3148 otherwise 0 is returned.
3150 Example: >
3151 :call histadd("input", strftime("%Y %b %d"))
3152 :let date=input("Enter date: ")
3153 < This function is not available in the |sandbox|.
3155 histdel({history} [, {item}]) *histdel()*
3156 Clear {history}, i.e. delete all its entries. See |hist-names|
3157 for the possible values of {history}.
3159 If the parameter {item} is given as String, this is seen
3160 as regular expression. All entries matching that expression
3161 will be removed from the history (if there are any).
3162 Upper/lowercase must match, unless "\c" is used |/\c|.
3163 If {item} is a Number, it will be interpreted as index, see
3164 |:history-indexing|. The respective entry will be removed
3165 if it exists.
3167 The result is a Number: 1 for a successful operation,
3168 otherwise 0 is returned.
3170 Examples:
3171 Clear expression register history: >
3172 :call histdel("expr")
3173 <
3174 Remove all entries starting with "*" from the search history: >
3175 :call histdel("/", '^\*')
3176 <
3177 The following three are equivalent: >
3178 :call histdel("search", histnr("search"))
3179 :call histdel("search", -1)
3180 :call histdel("search", '^'.histget("search", -1).'$')
3181 <
3182 To delete the last search pattern and use the last-but-one for
3183 the "n" command and 'hlsearch': >
3184 :call histdel("search", -1)
3185 :let @/ = histget("search", -1)
3187 histget({history} [, {index}]) *histget()*
3188 The result is a String, the entry with Number {index} from
3189 {history}. See |hist-names| for the possible values of
3190 {history}, and |:history-indexing| for {index}. If there is
3191 no such entry, an empty String is returned. When {index} is
3192 omitted, the most recent item from the history is used.
3194 Examples:
3195 Redo the second last search from history. >
3196 :execute '/' . histget("search", -2)
3198 < Define an Ex command ":H {num}" that supports re-execution of
3199 the {num}th entry from the output of |:history|. >
3200 :command -nargs=1 H execute histget("cmd", 0+<args>)
3201 <
3202 histnr({history}) *histnr()*
3203 The result is the Number of the current entry in {history}.
3204 See |hist-names| for the possible values of {history}.
3205 If an error occurred, -1 is returned.
3207 Example: >
3208 :let inp_index = histnr("expr")
3209 <
3210 hlexists({name}) *hlexists()*
3211 The result is a Number, which is non-zero if a highlight group
3212 called {name} exists. This is when the group has been
3213 defined in some way. Not necessarily when highlighting has
3214 been defined for it, it may also have been used for a syntax
3215 item.
3216 *highlight_exists()*
3217 Obsolete name: highlight_exists().
3219 *hlID()*
3220 hlID({name}) The result is a Number, which is the ID of the highlight group
3221 with name {name}. When the highlight group doesn't exist,
3222 zero is returned.
3223 This can be used to retrieve information about the highlight
3224 group. For example, to get the background color of the
3225 "Comment" group: >
3226 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3227 < *highlightID()*
3228 Obsolete name: highlightID().
3230 hostname() *hostname()*
3231 The result is a String, which is the name of the machine on
3232 which Vim is currently running. Machine names greater than
3233 256 characters long are truncated.
3235 iconv({expr}, {from}, {to}) *iconv()*
3236 The result is a String, which is the text {expr} converted
3237 from encoding {from} to encoding {to}.
3238 When the conversion fails an empty string is returned.
3239 The encoding names are whatever the iconv() library function
3240 can accept, see ":!man 3 iconv".
3241 Most conversions require Vim to be compiled with the |+iconv|
3242 feature. Otherwise only UTF-8 to latin1 conversion and back
3243 can be done.
3244 This can be used to display messages with special characters,
3245 no matter what 'encoding' is set to. Write the message in
3246 UTF-8 and use: >
3247 echo iconv(utf8_str, "utf-8", &enc)
3248 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
3249 from/to UCS-2 is automatically changed to use UTF-8. You
3250 cannot use UCS-2 in a string anyway, because of the NUL bytes.
3251 {only available when compiled with the +multi_byte feature}
3253 *indent()*
3254 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3255 current buffer. The indent is counted in spaces, the value
3256 of 'tabstop' is relevant. {lnum} is used just like in
3257 |getline()|.
3258 When {lnum} is invalid -1 is returned.
3261 index({list}, {expr} [, {start} [, {ic}]]) *index()*
3262 Return the lowest index in |List| {list} where the item has a
3263 value equal to {expr}.
3264 If {start} is given then start looking at the item with index
3265 {start} (may be negative for an item relative to the end).
3266 When {ic} is given and it is non-zero, ignore case. Otherwise
3267 case must match.
3268 -1 is returned when {expr} is not found in {list}.
3269 Example: >
3270 :let idx = index(words, "the")
3271 :if index(numbers, 123) >= 0
3274 input({prompt} [, {text} [, {completion}]]) *input()*
3275 The result is a String, which is whatever the user typed on
3276 the command-line. The parameter is either a prompt string, or
3277 a blank string (for no prompt). A '\n' can be used in the
3278 prompt to start a new line.
3279 The highlighting set with |:echohl| is used for the prompt.
3280 The input is entered just like a command-line, with the same
3281 editing commands and mappings. There is a separate history
3282 for lines typed for input().
3283 Example: >
3284 :if input("Coffee or beer? ") == "beer"
3285 : echo "Cheers!"
3286 :endif
3287 <
3288 If the optional {text} is present and not empty, this is used
3289 for the default reply, as if the user typed this. Example: >
3290 :let color = input("Color? ", "white")
3292 < The optional {completion} argument specifies the type of
3293 completion supported for the input. Without it completion is
3294 not performed. The supported completion types are the same as
3295 that can be supplied to a user-defined command using the
3296 "-complete=" argument. Refer to |:command-completion| for
3297 more information. Example: >
3298 let fname = input("File: ", "", "file")
3299 <
3300 NOTE: This function must not be used in a startup file, for
3301 the versions that only run in GUI mode (e.g., the Win32 GUI).
3302 Note: When input() is called from within a mapping it will
3303 consume remaining characters from that mapping, because a
3304 mapping is handled like the characters were typed.
3305 Use |inputsave()| before input() and |inputrestore()|
3306 after input() to avoid that. Another solution is to avoid
3307 that further characters follow in the mapping, e.g., by using
3308 |:execute| or |:normal|.
3310 Example with a mapping: >
3311 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3312 :function GetFoo()
3313 : call inputsave()
3314 : let g:Foo = input("enter search pattern: ")
3315 : call inputrestore()
3316 :endfunction
3318 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
3319 Like input(), but when the GUI is running and text dialogs are
3320 supported, a dialog window pops up to input the text.
3321 Example: >
3322 :let n = inputdialog("value for shiftwidth", &sw)
3323 :if n != ""
3324 : let &sw = n
3325 :endif
3326 < When the dialog is cancelled {cancelreturn} is returned. When
3327 omitted an empty string is returned.
3328 Hitting <Enter> works like pressing the OK button. Hitting
3329 <Esc> works like pressing the Cancel button.
3330 NOTE: Command-line completion is not supported.
3332 inputlist({textlist}) *inputlist()*
3333 {textlist} must be a |List| of strings. This |List| is
3334 displayed, one string per line. The user will be prompted to
3335 enter a number, which is returned.
3336 The user can also select an item by clicking on it with the
3337 mouse. For the first string 0 is returned. When clicking
3338 above the first item a negative number is returned. When
3339 clicking on the prompt one more than the length of {textlist}
3340 is returned.
3341 Make sure {textlist} has less then 'lines' entries, otherwise
3342 it won't work. It's a good idea to put the entry number at
3343 the start of the string. And put a prompt in the first item.
3344 Example: >
3345 let color = inputlist(['Select color:', '1. red',
3346 \ '2. green', '3. blue'])
3348 inputrestore() *inputrestore()*
3349 Restore typeahead that was saved with a previous inputsave().
3350 Should be called the same number of times inputsave() is
3351 called. Calling it more often is harmless though.
3352 Returns 1 when there is nothing to restore, 0 otherwise.
3354 inputsave() *inputsave()*
3355 Preserve typeahead (also from mappings) and clear it, so that
3356 a following prompt gets input from the user. Should be
3357 followed by a matching inputrestore() after the prompt. Can
3358 be used several times, in which case there must be just as
3359 many inputrestore() calls.
3360 Returns 1 when out of memory, 0 otherwise.
3362 inputsecret({prompt} [, {text}]) *inputsecret()*
3363 This function acts much like the |input()| function with but
3364 two exceptions:
3365 a) the user's response will be displayed as a sequence of
3366 asterisks ("*") thereby keeping the entry secret, and
3367 b) the user's response will not be recorded on the input
3368 |history| stack.
3369 The result is a String, which is whatever the user actually
3370 typed on the command-line in response to the issued prompt.
3371 NOTE: Command-line completion is not supported.
3373 insert({list}, {item} [, {idx}]) *insert()*
3374 Insert {item} at the start of |List| {list}.
3375 If {idx} is specified insert {item} before the item with index
3376 {idx}. If {idx} is zero it goes before the first item, just
3377 like omitting {idx}. A negative {idx} is also possible, see
3378 |list-index|. -1 inserts just before the last item.
3379 Returns the resulting |List|. Examples: >
3380 :let mylist = insert([2, 3, 5], 1)
3381 :call insert(mylist, 4, -1)
3382 :call insert(mylist, 6, len(mylist))
3383 < The last example can be done simpler with |add()|.
3384 Note that when {item} is a |List| it is inserted as a single
3385 item. Use |extend()| to concatenate |Lists|.
3387 isdirectory({directory}) *isdirectory()*
3388 The result is a Number, which is non-zero when a directory
3389 with the name {directory} exists. If {directory} doesn't
3390 exist, or isn't a directory, the result is FALSE. {directory}
3391 is any expression, which is used as a String.
3393 islocked({expr}) *islocked()* *E786*
3394 The result is a Number, which is non-zero when {expr} is the
3395 name of a locked variable.
3396 {expr} must be the name of a variable, |List| item or
3397 |Dictionary| entry, not the variable itself! Example: >
3398 :let alist = [0, ['a', 'b'], 2, 3]
3399 :lockvar 1 alist
3400 :echo islocked('alist') " 1
3401 :echo islocked('alist[1]') " 0
3403 < When {expr} is a variable that does not exist you get an error
3404 message. Use |exists()| to check for existence.
3406 items({dict}) *items()*
3407 Return a |List| with all the key-value pairs of {dict}. Each
3408 |List| item is a list with two items: the key of a {dict}
3409 entry and the value of this entry. The |List| is in arbitrary
3410 order.
3413 join({list} [, {sep}]) *join()*
3414 Join the items in {list} together into one String.
3415 When {sep} is specified it is put in between the items. If
3416 {sep} is omitted a single space is used.
3417 Note that {sep} is not added at the end. You might want to
3418 add it there too: >
3419 let lines = join(mylist, "\n") . "\n"
3420 < String items are used as-is. |Lists| and |Dictionaries| are
3421 converted into a string like with |string()|.
3422 The opposite function is |split()|.
3424 keys({dict}) *keys()*
3425 Return a |List| with all the keys of {dict}. The |List| is in
3426 arbitrary order.
3428 *len()* *E701*
3429 len({expr}) The result is a Number, which is the length of the argument.
3430 When {expr} is a String or a Number the length in bytes is
3431 used, as with |strlen()|.
3432 When {expr} is a |List| the number of items in the |List| is
3433 returned.
3434 When {expr} is a |Dictionary| the number of entries in the
3435 |Dictionary| is returned.
3436 Otherwise an error is given.
3438 *libcall()* *E364* *E368*
3439 libcall({libname}, {funcname}, {argument})
3440 Call function {funcname} in the run-time library {libname}
3441 with single argument {argument}.
3442 This is useful to call functions in a library that you
3443 especially made to be used with Vim. Since only one argument
3444 is possible, calling standard library functions is rather
3445 limited.
3446 The result is the String returned by the function. If the
3447 function returns NULL, this will appear as an empty string ""
3448 to Vim.
3449 If the function returns a number, use libcallnr()!
3450 If {argument} is a number, it is passed to the function as an
3451 int; if {argument} is a string, it is passed as a
3452 null-terminated string.
3453 This function will fail in |restricted-mode|.
3455 libcall() allows you to write your own 'plug-in' extensions to
3456 Vim without having to recompile the program. It is NOT a
3457 means to call system functions! If you try to do so Vim will
3458 very probably crash.
3460 For Win32, the functions you write must be placed in a DLL
3461 and use the normal C calling convention (NOT Pascal which is
3462 used in Windows System DLLs). The function must take exactly
3463 one parameter, either a character pointer or a long integer,
3464 and must return a character pointer or NULL. The character
3465 pointer returned must point to memory that will remain valid
3466 after the function has returned (e.g. in static data in the
3467 DLL). If it points to allocated memory, that memory will
3468 leak away. Using a static buffer in the function should work,
3469 it's then freed when the DLL is unloaded.
3471 WARNING: If the function returns a non-valid pointer, Vim may
3472 crash! This also happens if the function returns a number,
3473 because Vim thinks it's a pointer.
3474 For Win32 systems, {libname} should be the filename of the DLL
3475 without the ".DLL" suffix. A full path is only required if
3476 the DLL is not in the usual places.
3477 For Unix: When compiling your own plugins, remember that the
3478 object code must be compiled as position-independent ('PIC').
3479 {only in Win32 on some Unix versions, when the |+libcall|
3480 feature is present}
3481 Examples: >
3482 :echo libcall("libc.so", "getenv", "HOME")
3483 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
3484 <
3485 *libcallnr()*
3486 libcallnr({libname}, {funcname}, {argument})
3487 Just like libcall(), but used for a function that returns an
3488 int instead of a string.
3489 {only in Win32 on some Unix versions, when the |+libcall|
3490 feature is present}
3491 Example (not very useful...): >
3492 :call libcallnr("libc.so", "printf", "Hello World!\n")
3493 :call libcallnr("libc.so", "sleep", 10)
3494 <
3495 *line()*
3496 line({expr}) The result is a Number, which is the line number of the file
3497 position given with {expr}. The accepted positions are:
3498 . the cursor position
3499 $ the last line in the current buffer
3500 'x position of mark x (if the mark is not set, 0 is
3501 returned)
3502 w0 first line visible in current window
3503 w$ last line visible in current window
3504 Note that a mark in another file can be used. The line number
3505 then applies to another buffer.
3506 To get the column number use |col()|. To get both use
3507 |getpos()|.
3508 Examples: >
3509 line(".") line number of the cursor
3510 line("'t") line number of mark t
3511 line("'" . marker) line number of mark marker
3512 < *last-position-jump*
3513 This autocommand jumps to the last known position in a file
3514 just after opening it, if the '" mark is set: >
3515 :au BufReadPost * if line("'\"") > 0 && line("'\"") <= line("$") | exe "normal g'\"" | endif
3517 line2byte({lnum}) *line2byte()*
3518 Return the byte count from the start of the buffer for line
3519 {lnum}. This includes the end-of-line character, depending on
3520 the 'fileformat' option for the current buffer. The first
3521 line returns 1.
3522 This can also be used to get the byte count for the line just
3523 below the last line: >
3524 line2byte(line("$") + 1)
3525 < This is the file size plus one.
3526 When {lnum} is invalid, or the |+byte_offset| feature has been
3527 disabled at compile time, -1 is returned.
3528 Also see |byte2line()|, |go| and |:goto|.
3530 lispindent({lnum}) *lispindent()*
3531 Get the amount of indent for line {lnum} according the lisp
3532 indenting rules, as with 'lisp'.
3533 The indent is counted in spaces, the value of 'tabstop' is
3534 relevant. {lnum} is used just like in |getline()|.
3535 When {lnum} is invalid or Vim was not compiled the
3536 |+lispindent| feature, -1 is returned.
3538 localtime() *localtime()*
3539 Return the current time, measured as seconds since 1st Jan
3540 1970. See also |strftime()| and |getftime()|.
3543 map({expr}, {string}) *map()*
3544 {expr} must be a |List| or a |Dictionary|.
3545 Replace each item in {expr} with the result of evaluating
3546 {string}.
3547 Inside {string} |v:val| has the value of the current item.
3548 For a |Dictionary| |v:key| has the key of the current item.
3549 Example: >
3550 :call map(mylist, '"> " . v:val . " <"')
3551 < This puts "> " before and " <" after each item in "mylist".
3553 Note that {string} is the result of an expression and is then
3554 used as an expression again. Often it is good to use a
3555 |literal-string| to avoid having to double backslashes. You
3556 still have to double ' quotes
3558 The operation is done in-place. If you want a |List| or
3559 |Dictionary| to remain unmodified make a copy first: >
3560 :let tlist = map(copy(mylist), ' & . "\t"')
3562 < Returns {expr}, the |List| or |Dictionary| that was filtered.
3563 When an error is encountered while evaluating {string} no
3564 further items in {expr} are processed.
3567 maparg({name}[, {mode} [, {abbr}]]) *maparg()*
3568 Return the rhs of mapping {name} in mode {mode}. When there
3569 is no mapping for {name}, an empty String is returned.
3570 {mode} can be one of these strings:
3571 "n" Normal
3572 "v" Visual
3573 "o" Operator-pending
3574 "i" Insert
3575 "c" Cmd-line
3576 "l" langmap |language-mapping|
3577 "" Normal, Visual and Operator-pending
3578 When {mode} is omitted, the modes for "" are used.
3579 When {abbr} is there and it is non-zero use abbreviations
3580 instead of mappings.
3581 The {name} can have special key names, like in the ":map"
3582 command. The returned String has special characters
3583 translated like in the output of the ":map" command listing.
3584 The mappings local to the current buffer are checked first,
3585 then the global mappings.
3586 This function can be used to map a key even when it's already
3587 mapped, and have it do the original mapping too. Sketch: >
3588 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
3591 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
3592 Check if there is a mapping that matches with {name} in mode
3593 {mode}. See |maparg()| for {mode} and special names in
3594 {name}.
3595 When {abbr} is there and it is non-zero use abbreviations
3596 instead of mappings.
3597 A match happens with a mapping that starts with {name} and
3598 with a mapping which is equal to the start of {name}.
3600 matches mapping "a" "ab" "abc" ~
3601 mapcheck("a") yes yes yes
3602 mapcheck("abc") yes yes yes
3603 mapcheck("ax") yes no no
3604 mapcheck("b") no no no
3606 The difference with maparg() is that mapcheck() finds a
3607 mapping that matches with {name}, while maparg() only finds a
3608 mapping for {name} exactly.
3609 When there is no mapping that starts with {name}, an empty
3610 String is returned. If there is one, the rhs of that mapping
3611 is returned. If there are several mappings that start with
3612 {name}, the rhs of one of them is returned.
3613 The mappings local to the current buffer are checked first,
3614 then the global mappings.
3615 This function can be used to check if a mapping can be added
3616 without being ambiguous. Example: >
3617 :if mapcheck("_vv") == ""
3618 : map _vv :set guifont=7x13<CR>
3619 :endif
3620 < This avoids adding the "_vv" mapping when there already is a
3621 mapping for "_v" or for "_vvv".
3623 match({expr}, {pat}[, {start}[, {count}]]) *match()*
3624 When {expr} is a |List| then this returns the index of the
3625 first item where {pat} matches. Each item is used as a
3626 String, |Lists| and |Dictionaries| are used as echoed.
3627 Otherwise, {expr} is used as a String. The result is a
3628 Number, which gives the index (byte offset) in {expr} where
3629 {pat} matches.
3630 A match at the first character or |List| item returns zero.
3631 If there is no match -1 is returned.
3632 Example: >
3633 :echo match("testing", "ing") " results in 4
3634 :echo match([1, 'x'], '\a') " results in 1
3635 < See |string-match| for how {pat} is used.
3636 *strpbrk()*
3637 Vim doesn't have a strpbrk() function. But you can do: >
3638 :let sepidx = match(line, '[.,;: \t]')
3639 < *strcasestr()*
3640 Vim doesn't have a strcasestr() function. But you can add
3641 "\c" to the pattern to ignore case: >
3642 :let idx = match(haystack, '\cneedle')
3643 <
3644 If {start} is given, the search starts from byte index
3645 {start} in a String or item {start} in a |List|.
3646 The result, however, is still the index counted from the
3647 first character/item. Example: >
3648 :echo match("testing", "ing", 2)
3649 < result is again "4". >
3650 :echo match("testing", "ing", 4)
3651 < result is again "4". >
3652 :echo match("testing", "t", 2)
3653 < result is "3".
3654 For a String, if {start} > 0 then it is like the string starts
3655 {start} bytes later, thus "^" will match at {start}. Except
3656 when {count} is given, then it's like matches before the
3657 {start} byte are ignored (this is a bit complicated to keep it
3658 backwards compatible).
3659 For a String, if {start} < 0, it will be set to 0. For a list
3660 the index is counted from the end.
3661 If {start} is out of range ({start} > strlen({expr}) for a
3662 String or {start} > len({expr}) for a |List|) -1 is returned.
3664 When {count} is given use the {count}'th match. When a match
3665 is found in a String the search for the next one starts one
3666 character further. Thus this example results in 1: >
3667 echo match("testing", "..", 0, 2)
3668 < In a |List| the search continues in the next item.
3669 Note that when {count} is added the way {start} works changes,
3670 see above.
3672 See |pattern| for the patterns that are accepted.
3673 The 'ignorecase' option is used to set the ignore-caseness of
3674 the pattern. 'smartcase' is NOT used. The matching is always
3675 done like 'magic' is set and 'cpoptions' is empty.
3677 *matchadd()* *E798* *E799* *E801*
3678 matchadd({group}, {pattern}[, {priority}[, {id}]])
3679 Defines a pattern to be highlighted in the current window (a
3680 "match"). It will be highlighted with {group}. Returns an
3681 identification number (ID), which can be used to delete the
3682 match using |matchdelete()|.
3684 The optional {priority} argument assigns a priority to the
3685 match. A match with a high priority will have its
3686 highlighting overrule that of a match with a lower priority.
3687 A priority is specified as an integer (negative numbers are no
3688 exception). If the {priority} argument is not specified, the
3689 default priority is 10. The priority of 'hlsearch' is zero,
3690 hence all matches with a priority greater than zero will
3691 overrule it. Syntax highlighting (see 'syntax') is a separate
3692 mechanism, and regardless of the chosen priority a match will
3693 always overrule syntax highlighting.
3695 The optional {id} argument allows the request for a specific
3696 match ID. If a specified ID is already taken, an error
3697 message will appear and the match will not be added. An ID
3698 is specified as a positive integer (zero excluded). IDs 1, 2
3699 and 3 are reserved for |:match|, |:2match| and |:3match|,
3700 respectively. If the {id} argument is not specified,
3701 |matchadd()| automatically chooses a free ID.
3703 The number of matches is not limited, as it is the case with
3704 the |:match| commands.
3706 Example: >
3707 :highlight MyGroup ctermbg=green guibg=green
3708 :let m = matchadd("MyGroup", "TODO")
3709 < Deletion of the pattern: >
3710 :call matchdelete(m)
3712 < A list of matches defined by |matchadd()| and |:match| are
3713 available from |getmatches()|. All matches can be deleted in
3714 one operation by |clearmatches()|.
3716 matcharg({nr}) *matcharg()*
3717 Selects the {nr} match item, as set with a |:match|,
3718 |:2match| or |:3match| command.
3719 Return a |List| with two elements:
3720 The name of the highlight group used
3721 The pattern used.
3722 When {nr} is not 1, 2 or 3 returns an empty |List|.
3723 When there is no match item set returns ['', ''].
3724 This is useful to save and restore a |:match|.
3725 Highlighting matches using the |:match| commands are limited
3726 to three matches. |matchadd()| does not have this limitation.
3728 matchdelete({id}) *matchdelete()* *E802* *E803*
3729 Deletes a match with ID {id} previously defined by |matchadd()|
3730 or one of the |:match| commands. Returns 0 if succesfull,
3731 otherwise -1. See example for |matchadd()|. All matches can
3732 be deleted in one operation by |clearmatches()|.
3734 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
3735 Same as match(), but return the index of first character after
3736 the match. Example: >
3737 :echo matchend("testing", "ing")
3738 < results in "7".
3739 *strspn()* *strcspn()*
3740 Vim doesn't have a strspn() or strcspn() function, but you can
3741 do it with matchend(): >
3742 :let span = matchend(line, '[a-zA-Z]')
3743 :let span = matchend(line, '[^a-zA-Z]')
3744 < Except that -1 is returned when there are no matches.
3746 The {start}, if given, has the same meaning as for match(). >
3747 :echo matchend("testing", "ing", 2)
3748 < results in "7". >
3749 :echo matchend("testing", "ing", 5)
3750 < result is "-1".
3751 When {expr} is a |List| the result is equal to match().
3753 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
3754 Same as match(), but return a |List|. The first item in the
3755 list is the matched string, same as what matchstr() would
3756 return. Following items are submatches, like "\1", "\2", etc.
3757 in |:substitute|. When an optional submatch didn't match an
3758 empty string is used. Example: >
3759 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
3760 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
3761 When there is no match an empty list is returned.
3763 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
3764 Same as match(), but return the matched string. Example: >
3765 :echo matchstr("testing", "ing")
3766 < results in "ing".
3767 When there is no match "" is returned.
3768 The {start}, if given, has the same meaning as for match(). >
3769 :echo matchstr("testing", "ing", 2)
3770 < results in "ing". >
3771 :echo matchstr("testing", "ing", 5)
3772 < result is "".
3773 When {expr} is a |List| then the matching item is returned.
3774 The type isn't changed, it's not necessarily a String.
3776 *max()*
3777 max({list}) Return the maximum value of all items in {list}.
3778 If {list} is not a list or one of the items in {list} cannot
3779 be used as a Number this results in an error.
3780 An empty |List| results in zero.
3782 *min()*
3783 min({list}) Return the minimum value of all items in {list}.
3784 If {list} is not a list or one of the items in {list} cannot
3785 be used as a Number this results in an error.
3786 An empty |List| results in zero.
3788 *mkdir()* *E739*
3789 mkdir({name} [, {path} [, {prot}]])
3790 Create directory {name}.
3791 If {path} is "p" then intermediate directories are created as
3792 necessary. Otherwise it must be "".
3793 If {prot} is given it is used to set the protection bits of
3794 the new directory. The default is 0755 (rwxr-xr-x: r/w for
3795 the user readable for others). Use 0700 to make it unreadable
3796 for others.
3797 This function is not available in the |sandbox|.
3798 Not available on all systems. To check use: >
3799 :if exists("*mkdir")
3800 <
3801 *mode()*
3802 mode() Return a string that indicates the current mode:
3803 n Normal
3804 v Visual by character
3805 V Visual by line
3806 CTRL-V Visual blockwise
3807 s Select by character
3808 S Select by line
3809 CTRL-S Select blockwise
3810 i Insert
3811 R Replace
3812 c Command-line
3813 r Hit-enter prompt
3814 This is useful in the 'statusline' option. In most other
3815 places it always returns "c" or "n".
3817 nextnonblank({lnum}) *nextnonblank()*
3818 Return the line number of the first line at or below {lnum}
3819 that is not blank. Example: >
3820 if getline(nextnonblank(1)) =~ "Java"
3821 < When {lnum} is invalid or there is no non-blank line at or
3822 below it, zero is returned.
3823 See also |prevnonblank()|.
3825 nr2char({expr}) *nr2char()*
3826 Return a string with a single character, which has the number
3827 value {expr}. Examples: >
3828 nr2char(64) returns "@"
3829 nr2char(32) returns " "
3830 < The current 'encoding' is used. Example for "utf-8": >
3831 nr2char(300) returns I with bow character
3832 < Note that a NUL character in the file is specified with
3833 nr2char(10), because NULs are represented with newline
3834 characters. nr2char(0) is a real NUL and terminates the
3835 string, thus results in an empty string.
3837 *getpid()*
3838 getpid() Return a Number which is the process ID of the Vim process.
3839 On Unix this is a unique number. On MS-DOS it's always zero.
3841 *getpos()*
3842 getpos({expr}) Get the position for {expr}. For possible values of {expr}
3843 see |line()|.
3844 The result is a |List| with four numbers:
3845 [bufnum, lnum, col, off]
3846 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3847 is the buffer number of the mark.
3848 "lnum" and "col" are the position in the buffer. The first
3849 column is 1.
3850 The "off" number is zero, unless 'virtualedit' is used. Then
3851 it is the offset in screen columns from the start of the
3852 character. E.g., a position within a <Tab> or after the last
3853 character.
3854 This can be used to save and restore the cursor position: >
3855 let save_cursor = getpos(".")
3856 MoveTheCursorAround
3857 call setpos('.', save_cursor)
3858 < Also see |setpos()|.
3860 pathshorten({expr}) *pathshorten()*
3861 Shorten directory names in the path {expr} and return the
3862 result. The tail, the file name, is kept as-is. The other
3863 components in the path are reduced to single letters. Leading
3864 '~' and '.' characters are kept. Example: >
3865 :echo pathshorten('~/.vim/autoload/myfile.vim')
3866 < ~/.v/a/myfile.vim ~
3867 It doesn't matter if the path exists or not.
3869 prevnonblank({lnum}) *prevnonblank()*
3870 Return the line number of the first line at or above {lnum}
3871 that is not blank. Example: >
3872 let ind = indent(prevnonblank(v:lnum - 1))
3873 < When {lnum} is invalid or there is no non-blank line at or
3874 above it, zero is returned.
3875 Also see |nextnonblank()|.
3878 printf({fmt}, {expr1} ...) *printf()*
3879 Return a String with {fmt}, where "%" items are replaced by
3880 the formatted form of their respective arguments. Example: >
3881 printf("%4d: E%d %.30s", lnum, errno, msg)
3882 < May result in:
3883 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
3885 Often used items are:
3886 %s string
3887 %6s string right-aligned in 6 bytes
3888 %.9s string truncated to 9 bytes
3889 %c single byte
3890 %d decimal number
3891 %5d decimal number padded with spaces to 5 characters
3892 %x hex number
3893 %04x hex number padded with zeros to at least 4 characters
3894 %X hex number using upper case letters
3895 %o octal number
3896 %% the % character itself
3898 Conversion specifications start with '%' and end with the
3899 conversion type. All other characters are copied unchanged to
3900 the result.
3902 The "%" starts a conversion specification. The following
3903 arguments appear in sequence:
3905 % [flags] [field-width] [.precision] type
3907 flags
3908 Zero or more of the following flags:
3910 # The value should be converted to an "alternate
3911 form". For c, d, and s conversions, this option
3912 has no effect. For o conversions, the precision
3913 of the number is increased to force the first
3914 character of the output string to a zero (except
3915 if a zero value is printed with an explicit
3916 precision of zero).
3917 For x and X conversions, a non-zero result has
3918 the string "0x" (or "0X" for X conversions)
3919 prepended to it.
3921 0 (zero) Zero padding. For all conversions the converted
3922 value is padded on the left with zeros rather
3923 than blanks. If a precision is given with a
3924 numeric conversion (d, o, x, and X), the 0 flag
3925 is ignored.
3927 - A negative field width flag; the converted value
3928 is to be left adjusted on the field boundary.
3929 The converted value is padded on the right with
3930 blanks, rather than on the left with blanks or
3931 zeros. A - overrides a 0 if both are given.
3933 ' ' (space) A blank should be left before a positive
3934 number produced by a signed conversion (d).
3936 + A sign must always be placed before a number
3937 produced by a signed conversion. A + overrides
3938 a space if both are used.
3940 field-width
3941 An optional decimal digit string specifying a minimum
3942 field width. If the converted value has fewer bytes
3943 than the field width, it will be padded with spaces on
3944 the left (or right, if the left-adjustment flag has
3945 been given) to fill out the field width.
3947 .precision
3948 An optional precision, in the form of a period '.'
3949 followed by an optional digit string. If the digit
3950 string is omitted, the precision is taken as zero.
3951 This gives the minimum number of digits to appear for
3952 d, o, x, and X conversions, or the maximum number of
3953 bytes to be printed from a string for s conversions.
3955 type
3956 A character that specifies the type of conversion to
3957 be applied, see below.
3959 A field width or precision, or both, may be indicated by an
3960 asterisk '*' instead of a digit string. In this case, a
3961 Number argument supplies the field width or precision. A
3962 negative field width is treated as a left adjustment flag
3963 followed by a positive field width; a negative precision is
3964 treated as though it were missing. Example: >
3965 :echo printf("%d: %.*s", nr, width, line)
3966 < This limits the length of the text used from "line" to
3967 "width" bytes.
3969 The conversion specifiers and their meanings are:
3971 doxX The Number argument is converted to signed decimal
3972 (d), unsigned octal (o), or unsigned hexadecimal (x
3973 and X) notation. The letters "abcdef" are used for
3974 x conversions; the letters "ABCDEF" are used for X
3975 conversions.
3976 The precision, if any, gives the minimum number of
3977 digits that must appear; if the converted value
3978 requires fewer digits, it is padded on the left with
3979 zeros.
3980 In no case does a non-existent or small field width
3981 cause truncation of a numeric field; if the result of
3982 a conversion is wider than the field width, the field
3983 is expanded to contain the conversion result.
3985 c The Number argument is converted to a byte, and the
3986 resulting character is written.
3988 s The text of the String argument is used. If a
3989 precision is specified, no more bytes than the number
3990 specified are used.
3992 % A '%' is written. No argument is converted. The
3993 complete conversion specification is "%%".
3995 Each argument can be Number or String and is converted
3996 automatically to fit the conversion specifier. Any other
3997 argument type results in an error message.
3999 *E766* *E767*
4000 The number of {exprN} arguments must exactly match the number
4001 of "%" items. If there are not sufficient or too many
4002 arguments an error is given. Up to 18 arguments can be used.
4005 pumvisible() *pumvisible()*
4006 Returns non-zero when the popup menu is visible, zero
4007 otherwise. See |ins-completion-menu|.
4008 This can be used to avoid some things that would remove the
4009 popup menu.
4011 *E726* *E727*
4012 range({expr} [, {max} [, {stride}]]) *range()*
4013 Returns a |List| with Numbers:
4014 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
4015 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
4016 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
4017 {max}] (increasing {expr} with {stride} each time, not
4018 producing a value past {max}).
4019 When the maximum is one before the start the result is an
4020 empty list. When the maximum is more than one before the
4021 start this is an error.
4022 Examples: >
4023 range(4) " [0, 1, 2, 3]
4024 range(2, 4) " [2, 3, 4]
4025 range(2, 9, 3) " [2, 5, 8]
4026 range(2, -2, -1) " [2, 1, 0, -1, -2]
4027 range(0) " []
4028 range(2, 0) " error!
4029 <
4030 *readfile()*
4031 readfile({fname} [, {binary} [, {max}]])
4032 Read file {fname} and return a |List|, each line of the file
4033 as an item. Lines broken at NL characters. Macintosh files
4034 separated with CR will result in a single long line (unless a
4035 NL appears somewhere).
4036 When {binary} is equal to "b" binary mode is used:
4037 - When the last line ends in a NL an extra empty list item is
4038 added.
4039 - No CR characters are removed.
4040 Otherwise:
4041 - CR characters that appear before a NL are removed.
4042 - Whether the last line ends in a NL or not does not matter.
4043 All NUL characters are replaced with a NL character.
4044 When {max} is given this specifies the maximum number of lines
4045 to be read. Useful if you only want to check the first ten
4046 lines of a file: >
4047 :for line in readfile(fname, '', 10)
4048 : if line =~ 'Date' | echo line | endif
4049 :endfor
4050 < When {max} is negative -{max} lines from the end of the file
4051 are returned, or as many as there are.
4052 When {max} is zero the result is an empty list.
4053 Note that without {max} the whole file is read into memory.
4054 Also note that there is no recognition of encoding. Read a
4055 file into a buffer if you need to.
4056 When the file can't be opened an error message is given and
4057 the result is an empty list.
4058 Also see |writefile()|.
4060 reltime([{start} [, {end}]]) *reltime()*
4061 Return an item that represents a time value. The format of
4062 the item depends on the system. It can be passed to
4063 |reltimestr()| to convert it to a string.
4064 Without an argument it returns the current time.
4065 With one argument is returns the time passed since the time
4066 specified in the argument.
4067 With two arguments it returns the time passed between {start}
4068 and {end}.
4069 The {start} and {end} arguments must be values returned by
4070 reltime().
4071 {only available when compiled with the +reltime feature}
4073 reltimestr({time}) *reltimestr()*
4074 Return a String that represents the time value of {time}.
4075 This is the number of seconds, a dot and the number of
4076 microseconds. Example: >
4077 let start = reltime()
4078 call MyFunction()
4079 echo reltimestr(reltime(start))
4080 < Note that overhead for the commands will be added to the time.
4081 The accuracy depends on the system.
4082 Leading spaces are used to make the string align nicely. You
4083 can use split() to remove it. >
4084 echo split(reltimestr(reltime(start)))[0]
4085 < Also see |profiling|.
4086 {only available when compiled with the +reltime feature}
4088 *remote_expr()* *E449*
4089 remote_expr({server}, {string} [, {idvar}])
4090 Send the {string} to {server}. The string is sent as an
4091 expression and the result is returned after evaluation.
4092 The result must be a String or a |List|. A |List| is turned
4093 into a String by joining the items with a line break in
4094 between (not at the end), like with join(expr, "\n").
4095 If {idvar} is present, it is taken as the name of a
4096 variable and a {serverid} for later use with
4097 remote_read() is stored there.
4098 See also |clientserver| |RemoteReply|.
4099 This function is not available in the |sandbox|.
4100 {only available when compiled with the |+clientserver| feature}
4101 Note: Any errors will cause a local error message to be issued
4102 and the result will be the empty string.
4103 Examples: >
4104 :echo remote_expr("gvim", "2+2")
4105 :echo remote_expr("gvim1", "b:current_syntax")
4106 <
4108 remote_foreground({server}) *remote_foreground()*
4109 Move the Vim server with the name {server} to the foreground.
4110 This works like: >
4111 remote_expr({server}, "foreground()")
4112 < Except that on Win32 systems the client does the work, to work
4113 around the problem that the OS doesn't always allow the server
4114 to bring itself to the foreground.
4115 Note: This does not restore the window if it was minimized,
4116 like foreground() does.
4117 This function is not available in the |sandbox|.
4118 {only in the Win32, Athena, Motif and GTK GUI versions and the
4119 Win32 console version}
4122 remote_peek({serverid} [, {retvar}]) *remote_peek()*
4123 Returns a positive number if there are available strings
4124 from {serverid}. Copies any reply string into the variable
4125 {retvar} if specified. {retvar} must be a string with the
4126 name of a variable.
4127 Returns zero if none are available.
4128 Returns -1 if something is wrong.
4129 See also |clientserver|.
4130 This function is not available in the |sandbox|.
4131 {only available when compiled with the |+clientserver| feature}
4132 Examples: >
4133 :let repl = ""
4134 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
4136 remote_read({serverid}) *remote_read()*
4137 Return the oldest available reply from {serverid} and consume
4138 it. It blocks until a reply is available.
4139 See also |clientserver|.
4140 This function is not available in the |sandbox|.
4141 {only available when compiled with the |+clientserver| feature}
4142 Example: >
4143 :echo remote_read(id)
4144 <
4145 *remote_send()* *E241*
4146 remote_send({server}, {string} [, {idvar}])
4147 Send the {string} to {server}. The string is sent as input
4148 keys and the function returns immediately. At the Vim server
4149 the keys are not mapped |:map|.
4150 If {idvar} is present, it is taken as the name of a variable
4151 and a {serverid} for later use with remote_read() is stored
4152 there.
4153 See also |clientserver| |RemoteReply|.
4154 This function is not available in the |sandbox|.
4155 {only available when compiled with the |+clientserver| feature}
4156 Note: Any errors will be reported in the server and may mess
4157 up the display.
4158 Examples: >
4159 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
4160 \ remote_read(serverid)
4162 :autocmd NONE RemoteReply *
4163 \ echo remote_read(expand("<amatch>"))
4164 :echo remote_send("gvim", ":sleep 10 | echo ".
4165 \ 'server2client(expand("<client>"), "HELLO")<CR>')
4166 <
4167 remove({list}, {idx} [, {end}]) *remove()*
4168 Without {end}: Remove the item at {idx} from |List| {list} and
4169 return it.
4170 With {end}: Remove items from {idx} to {end} (inclusive) and
4171 return a list with these items. When {idx} points to the same
4172 item as {end} a list with one item is returned. When {end}
4173 points to an item before {idx} this is an error.
4174 See |list-index| for possible values of {idx} and {end}.
4175 Example: >
4176 :echo "last item: " . remove(mylist, -1)
4177 :call remove(mylist, 0, 9)
4178 remove({dict}, {key})
4179 Remove the entry from {dict} with key {key}. Example: >
4180 :echo "removed " . remove(dict, "one")
4181 < If there is no {key} in {dict} this is an error.
4183 Use |delete()| to remove a file.
4185 rename({from}, {to}) *rename()*
4186 Rename the file by the name {from} to the name {to}. This
4187 should also work to move files across file systems. The
4188 result is a Number, which is 0 if the file was renamed
4189 successfully, and non-zero when the renaming failed.
4190 This function is not available in the |sandbox|.
4192 repeat({expr}, {count}) *repeat()*
4193 Repeat {expr} {count} times and return the concatenated
4194 result. Example: >
4195 :let separator = repeat('-', 80)
4196 < When {count} is zero or negative the result is empty.
4197 When {expr} is a |List| the result is {expr} concatenated
4198 {count} times. Example: >
4199 :let longlist = repeat(['a', 'b'], 3)
4200 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
4203 resolve({filename}) *resolve()* *E655*
4204 On MS-Windows, when {filename} is a shortcut (a .lnk file),
4205 returns the path the shortcut points to in a simplified form.
4206 On Unix, repeat resolving symbolic links in all path
4207 components of {filename} and return the simplified result.
4208 To cope with link cycles, resolving of symbolic links is
4209 stopped after 100 iterations.
4210 On other systems, return the simplified {filename}.
4211 The simplification step is done as by |simplify()|.
4212 resolve() keeps a leading path component specifying the
4213 current directory (provided the result is still a relative
4214 path name) and also keeps a trailing path separator.
4216 *reverse()*
4217 reverse({list}) Reverse the order of items in {list} in-place. Returns
4218 {list}.
4219 If you want a list to remain unmodified make a copy first: >
4220 :let revlist = reverse(copy(mylist))
4222 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
4223 Search for regexp pattern {pattern}. The search starts at the
4224 cursor position (you can use |cursor()| to set it).
4226 {flags} is a String, which can contain these character flags:
4227 'b' search backward instead of forward
4228 'c' accept a match at the cursor position
4229 'e' move to the End of the match
4230 'n' do Not move the cursor
4231 'p' return number of matching sub-pattern (see below)
4232 's' set the ' mark at the previous location of the cursor
4233 'w' wrap around the end of the file
4234 'W' don't wrap around the end of the file
4235 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
4237 If the 's' flag is supplied, the ' mark is set, only if the
4238 cursor is moved. The 's' flag cannot be combined with the 'n'
4239 flag.
4241 'ignorecase', 'smartcase' and 'magic' are used.
4243 When the {stopline} argument is given then the search stops
4244 after searching this line. This is useful to restrict the
4245 search to a range of lines. Examples: >
4246 let match = search('(', 'b', line("w0"))
4247 let end = search('END', '', line("w$"))
4248 < When {stopline} is used and it is not zero this also implies
4249 that the search does not wrap around the end of the file.
4250 A zero value is equal to not giving the argument.
4252 When the {timeout} argument is given the search stops when
4253 more than this many milli seconds have passed. Thus when
4254 {timeout} is 500 the search stops after half a second.
4255 The value must not be negative. A zero value is like not
4256 giving the argument.
4257 {only available when compiled with the +reltime feature}
4259 If there is no match a 0 is returned and the cursor doesn't
4260 move. No error message is given.
4261 When a match has been found its line number is returned.
4262 *search()-sub-match*
4263 With the 'p' flag the returned value is one more than the
4264 first sub-match in \(\). One if none of them matched but the
4265 whole pattern did match.
4266 To get the column number too use |searchpos()|.
4268 The cursor will be positioned at the match, unless the 'n'
4269 flag is used.
4271 Example (goes over all files in the argument list): >
4272 :let n = 1
4273 :while n <= argc() " loop over all files in arglist
4274 : exe "argument " . n
4275 : " start at the last char in the file and wrap for the
4276 : " first search to find match at start of file
4277 : normal G$
4278 : let flags = "w"
4279 : while search("foo", flags) > 0
4280 : s/foo/bar/g
4281 : let flags = "W"
4282 : endwhile
4283 : update " write the file if modified
4284 : let n = n + 1
4285 :endwhile
4286 <
4287 Example for using some flags: >
4288 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
4289 < This will search for the keywords "if", "else", and "endif"
4290 under or after the cursor. Because of the 'p' flag, it
4291 returns 1, 2, or 3 depending on which keyword is found, or 0
4292 if the search fails. With the cursor on the first word of the
4293 line:
4294 if (foo == 0) | let foo = foo + 1 | endif ~
4295 the function returns 1. Without the 'c' flag, the function
4296 finds the "endif" and returns 3. The same thing happens
4297 without the 'e' flag if the cursor is on the "f" of "if".
4298 The 'n' flag tells the function not to move the cursor.
4301 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
4302 Search for the declaration of {name}.
4304 With a non-zero {global} argument it works like |gD|, find
4305 first match in the file. Otherwise it works like |gd|, find
4306 first match in the function.
4308 With a non-zero {thisblock} argument matches in a {} block
4309 that ends before the cursor position are ignored. Avoids
4310 finding variable declarations only valid in another scope.
4312 Moves the cursor to the found match.
4313 Returns zero for success, non-zero for failure.
4314 Example: >
4315 if searchdecl('myvar') == 0
4316 echo getline('.')
4317 endif
4318 <
4319 *searchpair()*
4320 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
4321 [, {stopline} [, {timeout}]]]])
4322 Search for the match of a nested start-end pair. This can be
4323 used to find the "endif" that matches an "if", while other
4324 if/endif pairs in between are ignored.
4325 The search starts at the cursor. The default is to search
4326 forward, include 'b' in {flags} to search backward.
4327 If a match is found, the cursor is positioned at it and the
4328 line number is returned. If no match is found 0 or -1 is
4329 returned and the cursor doesn't move. No error message is
4330 given.
4332 {start}, {middle} and {end} are patterns, see |pattern|. They
4333 must not contain \( \) pairs. Use of \%( \) is allowed. When
4334 {middle} is not empty, it is found when searching from either
4335 direction, but only when not in a nested start-end pair. A
4336 typical use is: >
4337 searchpair('\<if\>', '\<else\>', '\<endif\>')
4338 < By leaving {middle} empty the "else" is skipped.
4340 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
4341 |search()|. Additionally:
4342 'r' Repeat until no more matches found; will find the
4343 outer pair
4344 'm' return number of Matches instead of line number with
4345 the match; will be > 1 when 'r' is used.
4347 When a match for {start}, {middle} or {end} is found, the
4348 {skip} expression is evaluated with the cursor positioned on
4349 the start of the match. It should return non-zero if this
4350 match is to be skipped. E.g., because it is inside a comment
4351 or a string.
4352 When {skip} is omitted or empty, every match is accepted.
4353 When evaluating {skip} causes an error the search is aborted
4354 and -1 returned.
4356 For {stopline} and {timeout} see |search()|.
4358 The value of 'ignorecase' is used. 'magic' is ignored, the
4359 patterns are used like it's on.
4361 The search starts exactly at the cursor. A match with
4362 {start}, {middle} or {end} at the next character, in the
4363 direction of searching, is the first one found. Example: >
4364 if 1
4365 if 2
4366 endif 2
4367 endif 1
4368 < When starting at the "if 2", with the cursor on the "i", and
4369 searching forwards, the "endif 2" is found. When starting on
4370 the character just before the "if 2", the "endif 1" will be
4371 found. That's because the "if 2" will be found first, and
4372 then this is considered to be a nested if/endif from "if 2" to
4373 "endif 2".
4374 When searching backwards and {end} is more than one character,
4375 it may be useful to put "\zs" at the end of the pattern, so
4376 that when the cursor is inside a match with the end it finds
4377 the matching start.
4379 Example, to find the "endif" command in a Vim script: >
4381 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
4382 \ 'getline(".") =~ "^\\s*\""')
4384 < The cursor must be at or after the "if" for which a match is
4385 to be found. Note that single-quote strings are used to avoid
4386 having to double the backslashes. The skip expression only
4387 catches comments at the start of a line, not after a command.
4388 Also, a word "en" or "if" halfway a line is considered a
4389 match.
4390 Another example, to search for the matching "{" of a "}": >
4392 :echo searchpair('{', '', '}', 'bW')
4394 < This works when the cursor is at or before the "}" for which a
4395 match is to be found. To reject matches that syntax
4396 highlighting recognized as strings: >
4398 :echo searchpair('{', '', '}', 'bW',
4399 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
4400 <
4401 *searchpairpos()*
4402 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
4403 [, {stopline} [, {timeout}]]]])
4404 Same as searchpair(), but returns a |List| with the line and
4405 column position of the match. The first element of the |List|
4406 is the line number and the second element is the byte index of
4407 the column position of the match. If no match is found,
4408 returns [0, 0].
4409 >
4410 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
4411 <
4412 See |match-parens| for a bigger and more useful example.
4414 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
4415 Same as |search()|, but returns a |List| with the line and
4416 column position of the match. The first element of the |List|
4417 is the line number and the second element is the byte index of
4418 the column position of the match. If no match is found,
4419 returns [0, 0].
4420 Example: >
4421 :let [lnum, col] = searchpos('mypattern', 'n')
4423 < When the 'p' flag is given then there is an extra item with
4424 the sub-pattern match number |search()-sub-match|. Example: >
4425 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
4426 < In this example "submatch" is 2 when a lowercase letter is
4427 found |/\l|, 3 when an uppercase letter is found |/\u|.
4429 server2client( {clientid}, {string}) *server2client()*
4430 Send a reply string to {clientid}. The most recent {clientid}
4431 that sent a string can be retrieved with expand("<client>").
4432 {only available when compiled with the |+clientserver| feature}
4433 Note:
4434 This id has to be stored before the next command can be
4435 received. I.e. before returning from the received command and
4436 before calling any commands that waits for input.
4437 See also |clientserver|.
4438 Example: >
4439 :echo server2client(expand("<client>"), "HELLO")
4440 <
4441 serverlist() *serverlist()*
4442 Return a list of available server names, one per line.
4443 When there are no servers or the information is not available
4444 an empty string is returned. See also |clientserver|.
4445 {only available when compiled with the |+clientserver| feature}
4446 Example: >
4447 :echo serverlist()
4448 <
4449 setbufvar({expr}, {varname}, {val}) *setbufvar()*
4450 Set option or local variable {varname} in buffer {expr} to
4451 {val}.
4452 This also works for a global or local window option, but it
4453 doesn't work for a global or local window variable.
4454 For a local window option the global value is unchanged.
4455 For the use of {expr}, see |bufname()| above.
4456 Note that the variable name without "b:" must be used.
4457 Examples: >
4458 :call setbufvar(1, "&mod", 1)
4459 :call setbufvar("todo", "myvar", "foobar")
4460 < This function is not available in the |sandbox|.
4462 setcmdpos({pos}) *setcmdpos()*
4463 Set the cursor position in the command line to byte position
4464 {pos}. The first position is 1.
4465 Use |getcmdpos()| to obtain the current position.
4466 Only works while editing the command line, thus you must use
4467 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
4468 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
4469 set after the command line is set to the expression. For
4470 |c_CTRL-R_=| it is set after evaluating the expression but
4471 before inserting the resulting text.
4472 When the number is too big the cursor is put at the end of the
4473 line. A number smaller than one has undefined results.
4474 Returns 0 when successful, 1 when not editing the command
4475 line.
4477 setline({lnum}, {line}) *setline()*
4478 Set line {lnum} of the current buffer to {line}.
4479 {lnum} is used like with |getline()|.
4480 When {lnum} is just below the last line the {line} will be
4481 added as a new line.
4482 If this succeeds, 0 is returned. If this fails (most likely
4483 because {lnum} is invalid) 1 is returned. Example: >
4484 :call setline(5, strftime("%c"))
4485 < When {line} is a |List| then line {lnum} and following lines
4486 will be set to the items in the list. Example: >
4487 :call setline(5, ['aaa', 'bbb', 'ccc'])
4488 < This is equivalent to: >
4489 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']]
4490 : call setline(n, l)
4491 :endfor
4492 < Note: The '[ and '] marks are not set.
4494 setloclist({nr}, {list} [, {action}]) *setloclist()*
4495 Create or replace or add to the location list for window {nr}.
4496 When {nr} is zero the current window is used. For a location
4497 list window, the displayed location list is modified. For an
4498 invalid window number {nr}, -1 is returned.
4499 Otherwise, same as |setqflist()|.
4500 Also see |location-list|.
4502 setmatches({list}) *setmatches()*
4503 Restores a list of matches saved by |getmatches()|. Returns 0
4504 if succesfull, otherwise -1. All current matches are cleared
4505 before the list is restored. See example for |getmatches()|.
4507 *setpos()*
4508 setpos({expr}, {list})
4509 Set the position for {expr}. Possible values:
4510 . the cursor
4511 'x mark x
4513 {list} must be a |List| with four numbers:
4514 [bufnum, lnum, col, off]
4516 "bufnum" is the buffer number. Zero can be used for the
4517 current buffer. Setting the cursor is only possible for
4518 the current buffer. To set a mark in another buffer you can
4519 use the |bufnr()| function to turn a file name into a buffer
4520 number.
4521 Does not change the jumplist.
4523 "lnum" and "col" are the position in the buffer. The first
4524 column is 1. Use a zero "lnum" to delete a mark.
4526 The "off" number is only used when 'virtualedit' is set. Then
4527 it is the offset in screen columns from the start of the
4528 character. E.g., a position within a <Tab> or after the last
4529 character.
4531 Returns 0 when the position could be set, -1 otherwise.
4532 An error message is given if {expr} is invalid.
4534 Also see |getpos()|
4536 This does not restore the preferred column for moving
4537 vertically. See |winrestview()| for that.
4540 setqflist({list} [, {action}]) *setqflist()*
4541 Create or replace or add to the quickfix list using the items
4542 in {list}. Each item in {list} is a dictionary.
4543 Non-dictionary items in {list} are ignored. Each dictionary
4544 item can contain the following entries:
4546 bufnr buffer number; must be the number of a valid
4547 buffer
4548 filename name of a file; only used when "bufnr" is not
4549 present or it is invalid.
4550 lnum line number in the file
4551 pattern search pattern used to locate the error
4552 col column number
4553 vcol when non-zero: "col" is visual column
4554 when zero: "col" is byte index
4555 nr error number
4556 text description of the error
4557 type single-character error type, 'E', 'W', etc.
4559 The "col", "vcol", "nr", "type" and "text" entries are
4560 optional. Either "lnum" or "pattern" entry can be used to
4561 locate a matching error line.
4562 If the "filename" and "bufnr" entries are not present or
4563 neither the "lnum" or "pattern" entries are present, then the
4564 item will not be handled as an error line.
4565 If both "pattern" and "lnum" are present then "pattern" will
4566 be used.
4567 Note that the list is not exactly the same as what
4568 |getqflist()| returns.
4570 If {action} is set to 'a', then the items from {list} are
4571 added to the existing quickfix list. If there is no existing
4572 list, then a new list is created. If {action} is set to 'r',
4573 then the items from the current quickfix list are replaced
4574 with the items from {list}. If {action} is not present or is
4575 set to ' ', then a new list is created.
4577 Returns zero for success, -1 for failure.
4579 This function can be used to create a quickfix list
4580 independent of the 'errorformat' setting. Use a command like
4581 ":cc 1" to jump to the first position.
4584 *setreg()*
4585 setreg({regname}, {value} [,{options}])
4586 Set the register {regname} to {value}.
4587 If {options} contains "a" or {regname} is upper case,
4588 then the value is appended.
4589 {options} can also contains a register type specification:
4590 "c" or "v" |characterwise| mode
4591 "l" or "V" |linewise| mode
4592 "b" or "<CTRL-V>" |blockwise-visual| mode
4593 If a number immediately follows "b" or "<CTRL-V>" then this is
4594 used as the width of the selection - if it is not specified
4595 then the width of the block is set to the number of characters
4596 in the longest line (counting a <Tab> as 1 character).
4598 If {options} contains no register settings, then the default
4599 is to use character mode unless {value} ends in a <NL>.
4600 Setting the '=' register is not possible.
4601 Returns zero for success, non-zero for failure.
4603 Examples: >
4604 :call setreg(v:register, @*)
4605 :call setreg('*', @%, 'ac')
4606 :call setreg('a', "1\n2\n3", 'b5')
4608 < This example shows using the functions to save and restore a
4609 register. >
4610 :let var_a = getreg('a', 1)
4611 :let var_amode = getregtype('a')
4612 ....
4613 :call setreg('a', var_a, var_amode)
4615 < You can also change the type of a register by appending
4616 nothing: >
4617 :call setreg('a', '', 'al')
4619 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
4620 Set option or local variable {varname} in window {winnr} to
4621 {val}.
4622 Tabs are numbered starting with one. For the current tabpage
4623 use |setwinvar()|.
4624 When {winnr} is zero the current window is used.
4625 This also works for a global or local buffer option, but it
4626 doesn't work for a global or local buffer variable.
4627 For a local buffer option the global value is unchanged.
4628 Note that the variable name without "w:" must be used.
4629 Vim briefly goes to the tab page {tabnr}, this may trigger
4630 TabLeave and TabEnter autocommands.
4631 Examples: >
4632 :call settabwinvar(1, 1, "&list", 0)
4633 :call settabwinvar(3, 2, "myvar", "foobar")
4634 < This function is not available in the |sandbox|.
4636 setwinvar({nr}, {varname}, {val}) *setwinvar()*
4637 Like |settabwinvar()| for the current tab page.
4638 Examples: >
4639 :call setwinvar(1, "&list", 0)
4640 :call setwinvar(2, "myvar", "foobar")
4642 shellescape({string}) *shellescape()*
4643 Escape {string} for use as shell command argument.
4644 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
4645 will enclose {string} double quotes and double all double
4646 quotes within {string}.
4647 For other systems, it will enclose {string} in single quotes
4648 and replace all "'" with "'\''".
4649 Example: >
4650 :echo shellescape('c:\program files\vim')
4651 < results in:
4652 "c:\program files\vim" ~
4653 Example usage: >
4654 :call system("chmod +x -- " . shellescape(expand("%")))
4657 simplify({filename}) *simplify()*
4658 Simplify the file name as much as possible without changing
4659 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
4660 Unix) are not resolved. If the first path component in
4661 {filename} designates the current directory, this will be
4662 valid for the result as well. A trailing path separator is
4663 not removed either.
4664 Example: >
4665 simplify("./dir/.././/file/") == "./file/"
4666 < Note: The combination "dir/.." is only removed if "dir" is
4667 a searchable directory or does not exist. On Unix, it is also
4668 removed when "dir" is a symbolic link within the same
4669 directory. In order to resolve all the involved symbolic
4670 links before simplifying the path name, use |resolve()|.
4673 sort({list} [, {func}]) *sort()* *E702*
4674 Sort the items in {list} in-place. Returns {list}. If you
4675 want a list to remain unmodified make a copy first: >
4676 :let sortedlist = sort(copy(mylist))
4677 < Uses the string representation of each item to sort on.
4678 Numbers sort after Strings, |Lists| after Numbers.
4679 For sorting text in the current buffer use |:sort|.
4680 When {func} is given and it is one then case is ignored.
4681 When {func} is a |Funcref| or a function name, this function
4682 is called to compare items. The function is invoked with two
4683 items as argument and must return zero if they are equal, 1 if
4684 the first one sorts after the second one, -1 if the first one
4685 sorts before the second one. Example: >
4686 func MyCompare(i1, i2)
4687 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
4688 endfunc
4689 let sortedlist = sort(mylist, "MyCompare")
4690 <
4692 *soundfold()*
4693 soundfold({word})
4694 Return the sound-folded equivalent of {word}. Uses the first
4695 language in 'spellang' for the current window that supports
4696 soundfolding. 'spell' must be set. When no sound folding is
4697 possible the {word} is returned unmodified.
4698 This can be used for making spelling suggestions. Note that
4699 the method can be quite slow.
4701 *spellbadword()*
4702 spellbadword([{sentence}])
4703 Without argument: The result is the badly spelled word under
4704 or after the cursor. The cursor is moved to the start of the
4705 bad word. When no bad word is found in the cursor line the
4706 result is an empty string and the cursor doesn't move.
4708 With argument: The result is the first word in {sentence} that
4709 is badly spelled. If there are no spelling mistakes the
4710 result is an empty string.
4712 The return value is a list with two items:
4713 - The badly spelled word or an empty string.
4714 - The type of the spelling error:
4715 "bad" spelling mistake
4716 "rare" rare word
4717 "local" word only valid in another region
4718 "caps" word should start with Capital
4719 Example: >
4720 echo spellbadword("the quik brown fox")
4721 < ['quik', 'bad'] ~
4723 The spelling information for the current window is used. The
4724 'spell' option must be set and the value of 'spelllang' is
4725 used.
4727 *spellsuggest()*
4728 spellsuggest({word} [, {max} [, {capital}]])
4729 Return a |List| with spelling suggestions to replace {word}.
4730 When {max} is given up to this number of suggestions are
4731 returned. Otherwise up to 25 suggestions are returned.
4733 When the {capital} argument is given and it's non-zero only
4734 suggestions with a leading capital will be given. Use this
4735 after a match with 'spellcapcheck'.
4737 {word} can be a badly spelled word followed by other text.
4738 This allows for joining two words that were split. The
4739 suggestions also include the following text, thus you can
4740 replace a line.
4742 {word} may also be a good word. Similar words will then be
4743 returned. {word} itself is not included in the suggestions,
4744 although it may appear capitalized.
4746 The spelling information for the current window is used. The
4747 'spell' option must be set and the values of 'spelllang' and
4748 'spellsuggest' are used.
4751 split({expr} [, {pattern} [, {keepempty}]]) *split()*
4752 Make a |List| out of {expr}. When {pattern} is omitted or
4753 empty each white-separated sequence of characters becomes an
4754 item.
4755 Otherwise the string is split where {pattern} matches,
4756 removing the matched characters.
4757 When the first or last item is empty it is omitted, unless the
4758 {keepempty} argument is given and it's non-zero.
4759 Other empty items are kept when {pattern} matches at least one
4760 character or when {keepempty} is non-zero.
4761 Example: >
4762 :let words = split(getline('.'), '\W\+')
4763 < To split a string in individual characters: >
4764 :for c in split(mystring, '\zs')
4765 < If you want to keep the separator you can also use '\zs': >
4766 :echo split('abc:def:ghi', ':\zs')
4767 < ['abc:', 'def:', 'ghi'] ~
4768 Splitting a table where the first element can be empty: >
4769 :let items = split(line, ':', 1)
4770 < The opposite function is |join()|.
4773 str2nr( {expr} [, {base}]) *str2nr()*
4774 Convert string {expr} to a number.
4775 {base} is the conversion base, it can be 8, 10 or 16.
4776 When {base} is omitted base 10 is used. This also means that
4777 a leading zero doesn't cause octal conversion to be used, as
4778 with the default String to Number conversion.
4779 When {base} is 16 a leading "0x" or "0X" is ignored. With a
4780 different base the result will be zero.
4781 Text after the number is silently ignored.
4784 strftime({format} [, {time}]) *strftime()*
4785 The result is a String, which is a formatted date and time, as
4786 specified by the {format} string. The given {time} is used,
4787 or the current time if no time is given. The accepted
4788 {format} depends on your system, thus this is not portable!
4789 See the manual page of the C function strftime() for the
4790 format. The maximum length of the result is 80 characters.
4791 See also |localtime()| and |getftime()|.
4792 The language can be changed with the |:language| command.
4793 Examples: >
4794 :echo strftime("%c") Sun Apr 27 11:49:23 1997
4795 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
4796 :echo strftime("%y%m%d %T") 970427 11:53:55
4797 :echo strftime("%H:%M") 11:55
4798 :echo strftime("%c", getftime("file.c"))
4799 Show mod time of file.c.
4800 < Not available on all systems. To check use: >
4801 :if exists("*strftime")
4803 stridx({haystack}, {needle} [, {start}]) *stridx()*
4804 The result is a Number, which gives the byte index in
4805 {haystack} of the first occurrence of the String {needle}.
4806 If {start} is specified, the search starts at index {start}.
4807 This can be used to find a second match: >
4808 :let comma1 = stridx(line, ",")
4809 :let comma2 = stridx(line, ",", comma1 + 1)
4810 < The search is done case-sensitive.
4811 For pattern searches use |match()|.
4812 -1 is returned if the {needle} does not occur in {haystack}.
4813 See also |strridx()|.
4814 Examples: >
4815 :echo stridx("An Example", "Example") 3
4816 :echo stridx("Starting point", "Start") 0
4817 :echo stridx("Starting point", "start") -1
4818 < *strstr()* *strchr()*
4819 stridx() works similar to the C function strstr(). When used
4820 with a single character it works similar to strchr().
4822 *string()*
4823 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
4824 String or a composition of them, then the result can be parsed
4825 back with |eval()|.
4826 {expr} type result ~
4827 String 'string'
4828 Number 123
4829 Funcref function('name')
4830 List [item, item]
4831 Dictionary {key: value, key: value}
4832 Note that in String values the ' character is doubled.
4833 Also see |strtrans()|.
4835 *strlen()*
4836 strlen({expr}) The result is a Number, which is the length of the String
4837 {expr} in bytes.
4838 If you want to count the number of multi-byte characters (not
4839 counting composing characters) use something like this: >
4841 :let len = strlen(substitute(str, ".", "x", "g"))
4842 <
4843 If the argument is a Number it is first converted to a String.
4844 For other types an error is given.
4845 Also see |len()|.
4847 strpart({src}, {start}[, {len}]) *strpart()*
4848 The result is a String, which is part of {src}, starting from
4849 byte {start}, with the byte length {len}.
4850 When non-existing bytes are included, this doesn't result in
4851 an error, the bytes are simply omitted.
4852 If {len} is missing, the copy continues from {start} till the
4853 end of the {src}. >
4854 strpart("abcdefg", 3, 2) == "de"
4855 strpart("abcdefg", -2, 4) == "ab"
4856 strpart("abcdefg", 5, 4) == "fg"
4857 strpart("abcdefg", 3) == "defg"
4858 < Note: To get the first character, {start} must be 0. For
4859 example, to get three bytes under and after the cursor: >
4860 strpart(getline("."), col(".") - 1, 3)
4861 <
4862 strridx({haystack}, {needle} [, {start}]) *strridx()*
4863 The result is a Number, which gives the byte index in
4864 {haystack} of the last occurrence of the String {needle}.
4865 When {start} is specified, matches beyond this index are
4866 ignored. This can be used to find a match before a previous
4867 match: >
4868 :let lastcomma = strridx(line, ",")
4869 :let comma2 = strridx(line, ",", lastcomma - 1)
4870 < The search is done case-sensitive.
4871 For pattern searches use |match()|.
4872 -1 is returned if the {needle} does not occur in {haystack}.
4873 If the {needle} is empty the length of {haystack} is returned.
4874 See also |stridx()|. Examples: >
4875 :echo strridx("an angry armadillo", "an") 3
4876 < *strrchr()*
4877 When used with a single character it works similar to the C
4878 function strrchr().
4880 strtrans({expr}) *strtrans()*
4881 The result is a String, which is {expr} with all unprintable
4882 characters translated into printable characters |'isprint'|.
4883 Like they are shown in a window. Example: >
4884 echo strtrans(@a)
4885 < This displays a newline in register a as "^@" instead of
4886 starting a new line.
4888 submatch({nr}) *submatch()*
4889 Only for an expression in a |:substitute| command. Returns
4890 the {nr}'th submatch of the matched text. When {nr} is 0
4891 the whole matched text is returned.
4892 Example: >
4893 :s/\d\+/\=submatch(0) + 1/
4894 < This finds the first number in the line and adds one to it.
4895 A line break is included as a newline character.
4897 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
4898 The result is a String, which is a copy of {expr}, in which
4899 the first match of {pat} is replaced with {sub}. This works
4900 like the ":substitute" command (without any flags). But the
4901 matching with {pat} is always done like the 'magic' option is
4902 set and 'cpoptions' is empty (to make scripts portable).
4903 'ignorecase' is still relevant. 'smartcase' is not used.
4904 See |string-match| for how {pat} is used.
4905 And a "~" in {sub} is not replaced with the previous {sub}.
4906 Note that some codes in {sub} have a special meaning
4907 |sub-replace-special|. For example, to replace something with
4908 "\n" (two characters), use "\\\\n" or '\\n'.
4909 When {pat} does not match in {expr}, {expr} is returned
4910 unmodified.
4911 When {flags} is "g", all matches of {pat} in {expr} are
4912 replaced. Otherwise {flags} should be "".
4913 Example: >
4914 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
4915 < This removes the last component of the 'path' option. >
4916 :echo substitute("testing", ".*", "\\U\\0", "")
4917 < results in "TESTING".
4919 synID({lnum}, {col}, {trans}) *synID()*
4920 The result is a Number, which is the syntax ID at the position
4921 {lnum} and {col} in the current window.
4922 The syntax ID can be used with |synIDattr()| and
4923 |synIDtrans()| to obtain syntax information about text.
4925 {col} is 1 for the leftmost column, {lnum} is 1 for the first
4926 line. 'synmaxcol' applies, in a longer line zero is returned.
4928 When {trans} is non-zero, transparent items are reduced to the
4929 item that they reveal. This is useful when wanting to know
4930 the effective color. When {trans} is zero, the transparent
4931 item is returned. This is useful when wanting to know which
4932 syntax item is effective (e.g. inside parens).
4933 Warning: This function can be very slow. Best speed is
4934 obtained by going through the file in forward direction.
4936 Example (echoes the name of the syntax item under the cursor): >
4937 :echo synIDattr(synID(line("."), col("."), 1), "name")
4938 <
4939 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
4940 The result is a String, which is the {what} attribute of
4941 syntax ID {synID}. This can be used to obtain information
4942 about a syntax item.
4943 {mode} can be "gui", "cterm" or "term", to get the attributes
4944 for that mode. When {mode} is omitted, or an invalid value is
4945 used, the attributes for the currently active highlighting are
4946 used (GUI, cterm or term).
4947 Use synIDtrans() to follow linked highlight groups.
4948 {what} result
4949 "name" the name of the syntax item
4950 "fg" foreground color (GUI: color name used to set
4951 the color, cterm: color number as a string,
4952 term: empty string)
4953 "bg" background color (like "fg")
4954 "fg#" like "fg", but for the GUI and the GUI is
4955 running the name in "#RRGGBB" form
4956 "bg#" like "fg#" for "bg"
4957 "bold" "1" if bold
4958 "italic" "1" if italic
4959 "reverse" "1" if reverse
4960 "inverse" "1" if inverse (= reverse)
4961 "underline" "1" if underlined
4962 "undercurl" "1" if undercurled
4964 Example (echoes the color of the syntax item under the
4965 cursor): >
4966 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
4967 <
4968 synIDtrans({synID}) *synIDtrans()*
4969 The result is a Number, which is the translated syntax ID of
4970 {synID}. This is the syntax group ID of what is being used to
4971 highlight the character. Highlight links given with
4972 ":highlight link" are followed.
4974 synstack({lnum}, {col}) *synstack()*
4975 Return a |List|, which is the stack of syntax items at the
4976 position {lnum} and {col} in the current window. Each item in
4977 the List is an ID like what |synID()| returns.
4978 The first item in the List is the outer region, following are
4979 items contained in that one. The last one is what |synID()|
4980 returns, unless not the whole item is highlighted or it is a
4981 transparent item.
4982 This function is useful for debugging a syntax file.
4983 Example that shows the syntax stack under the cursor: >
4984 for id in synstack(line("."), col("."))
4985 echo synIDattr(id, "name")
4986 endfor
4988 system({expr} [, {input}]) *system()* *E677*
4989 Get the output of the shell command {expr}.
4990 When {input} is given, this string is written to a file and
4991 passed as stdin to the command. The string is written as-is,
4992 you need to take care of using the correct line separators
4993 yourself. Pipes are not used.
4994 Note: newlines in {expr} may cause the command to fail. The
4995 characters in 'shellquote' and 'shellxquote' may also cause
4996 trouble.
4997 This is not to be used for interactive commands.
4998 The result is a String. Example: >
5000 :let files = system("ls")
5002 < To make the result more system-independent, the shell output
5003 is filtered to replace <CR> with <NL> for Macintosh, and
5004 <CR><NL> with <NL> for DOS-like systems.
5005 The command executed is constructed using several options:
5006 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
5007 ({tmp} is an automatically generated file name).
5008 For Unix and OS/2 braces are put around {expr} to allow for
5009 concatenated commands.
5011 The command will be executed in "cooked" mode, so that a
5012 CTRL-C will interrupt the command (on Unix at least).
5014 The resulting error code can be found in |v:shell_error|.
5015 This function will fail in |restricted-mode|.
5017 Note that any wrong value in the options mentioned above may
5018 make the function fail. It has also been reported to fail
5019 when using a security agent application.
5020 Unlike ":!cmd" there is no automatic check for changed files.
5021 Use |:checktime| to force a check.
5024 tabpagebuflist([{arg}]) *tabpagebuflist()*
5025 The result is a |List|, where each item is the number of the
5026 buffer associated with each window in the current tab page.
5027 {arg} specifies the number of tab page to be used. When
5028 omitted the current tab page is used.
5029 When {arg} is invalid the number zero is returned.
5030 To get a list of all buffers in all tabs use this: >
5031 tablist = []
5032 for i in range(tabpagenr('$'))
5033 call extend(tablist, tabpagebuflist(i + 1))
5034 endfor
5035 < Note that a buffer may appear in more than one window.
5038 tabpagenr([{arg}]) *tabpagenr()*
5039 The result is a Number, which is the number of the current
5040 tab page. The first tab page has number 1.
5041 When the optional argument is "$", the number of the last tab
5042 page is returned (the tab page count).
5043 The number can be used with the |:tab| command.
5046 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()*
5047 Like |winnr()| but for tab page {arg}.
5048 {tabarg} specifies the number of tab page to be used.
5049 {arg} is used like with |winnr()|:
5050 - When omitted the current window number is returned. This is
5051 the window which will be used when going to this tab page.
5052 - When "$" the number of windows is returned.
5053 - When "#" the previous window nr is returned.
5054 Useful examples: >
5055 tabpagewinnr(1) " current window of tab page 1
5056 tabpagewinnr(4, '$') " number of windows in tab page 4
5057 < When {tabarg} is invalid zero is returned.
5059 *tagfiles()*
5060 tagfiles() Returns a |List| with the file names used to search for tags
5061 for the current buffer. This is the 'tags' option expanded.
5064 taglist({expr}) *taglist()*
5065 Returns a list of tags matching the regular expression {expr}.
5066 Each list item is a dictionary with at least the following
5067 entries:
5068 name Name of the tag.
5069 filename Name of the file where the tag is
5070 defined. It is either relative to the
5071 current directory or a full path.
5072 cmd Ex command used to locate the tag in
5073 the file.
5074 kind Type of the tag. The value for this
5075 entry depends on the language specific
5076 kind values. Only available when
5077 using a tags file generated by
5078 Exuberant ctags or hdrtag.
5079 static A file specific tag. Refer to
5080 |static-tag| for more information.
5081 More entries may be present, depending on the content of the
5082 tags file: access, implementation, inherits and signature.
5083 Refer to the ctags documentation for information about these
5084 fields. For C code the fields "struct", "class" and "enum"
5085 may appear, they give the name of the entity the tag is
5086 contained in.
5088 The ex-command 'cmd' can be either an ex search pattern, a
5089 line number or a line number followed by a byte number.
5091 If there are no matching tags, then an empty list is returned.
5093 To get an exact tag match, the anchors '^' and '$' should be
5094 used in {expr}. Refer to |tag-regexp| for more information
5095 about the tag search regular expression pattern.
5097 Refer to |'tags'| for information about how the tags file is
5098 located by Vim. Refer to |tags-file-format| for the format of
5099 the tags file generated by the different ctags tools.
5101 tempname() *tempname()* *temp-file-name*
5102 The result is a String, which is the name of a file that
5103 doesn't exist. It can be used for a temporary file. The name
5104 is different for at least 26 consecutive calls. Example: >
5105 :let tmpfile = tempname()
5106 :exe "redir > " . tmpfile
5107 < For Unix, the file will be in a private directory (only
5108 accessible by the current user) to avoid security problems
5109 (e.g., a symlink attack or other people reading your file).
5110 When Vim exits the directory and all files in it are deleted.
5111 For MS-Windows forward slashes are used when the 'shellslash'
5112 option is set or when 'shellcmdflag' starts with '-'.
5114 tolower({expr}) *tolower()*
5115 The result is a copy of the String given, with all uppercase
5116 characters turned into lowercase (just like applying |gu| to
5117 the string).
5119 toupper({expr}) *toupper()*
5120 The result is a copy of the String given, with all lowercase
5121 characters turned into uppercase (just like applying |gU| to
5122 the string).
5124 tr({src}, {fromstr}, {tostr}) *tr()*
5125 The result is a copy of the {src} string with all characters
5126 which appear in {fromstr} replaced by the character in that
5127 position in the {tostr} string. Thus the first character in
5128 {fromstr} is translated into the first character in {tostr}
5129 and so on. Exactly like the unix "tr" command.
5130 This code also deals with multibyte characters properly.
5132 Examples: >
5133 echo tr("hello there", "ht", "HT")
5134 < returns "Hello THere" >
5135 echo tr("<blob>", "<>", "{}")
5136 < returns "{blob}"
5138 *type()*
5139 type({expr}) The result is a Number, depending on the type of {expr}:
5140 Number: 0
5141 String: 1
5142 Funcref: 2
5143 List: 3
5144 Dictionary: 4
5145 To avoid the magic numbers it should be used this way: >
5146 :if type(myvar) == type(0)
5147 :if type(myvar) == type("")
5148 :if type(myvar) == type(function("tr"))
5149 :if type(myvar) == type([])
5150 :if type(myvar) == type({})
5152 values({dict}) *values()*
5153 Return a |List| with all the values of {dict}. The |List| is
5154 in arbitrary order.
5157 virtcol({expr}) *virtcol()*
5158 The result is a Number, which is the screen column of the file
5159 position given with {expr}. That is, the last screen position
5160 occupied by the character at that position, when the screen
5161 would be of unlimited width. When there is a <Tab> at the
5162 position, the returned Number will be the column at the end of
5163 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
5164 set to 8, it returns 8.
5165 For the byte position use |col()|.
5166 For the use of {expr} see |col()|.
5167 When 'virtualedit' is used {expr} can be [lnum, col, off], where
5168 "off" is the offset in screen columns from the start of the
5169 character. E.g., a position within a <Tab> or after the last
5170 character.
5171 When Virtual editing is active in the current mode, a position
5172 beyond the end of the line can be returned. |'virtualedit'|
5173 The accepted positions are:
5174 . the cursor position
5175 $ the end of the cursor line (the result is the
5176 number of displayed characters in the cursor line
5177 plus one)
5178 'x position of mark x (if the mark is not set, 0 is
5179 returned)
5180 Note that only marks in the current file can be used.
5181 Examples: >
5182 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
5183 virtcol("$") with text "foo^Lbar", returns 9
5184 virtcol("'t") with text " there", with 't at 'h', returns 6
5185 < The first column is 1. 0 is returned for an error.
5186 A more advanced example that echoes the maximum length of
5187 all lines: >
5188 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
5191 visualmode([expr]) *visualmode()*
5192 The result is a String, which describes the last Visual mode
5193 used in the current buffer. Initially it returns an empty
5194 string, but once Visual mode has been used, it returns "v",
5195 "V", or "<CTRL-V>" (a single CTRL-V character) for
5196 character-wise, line-wise, or block-wise Visual mode
5197 respectively.
5198 Example: >
5199 :exe "normal " . visualmode()
5200 < This enters the same Visual mode as before. It is also useful
5201 in scripts if you wish to act differently depending on the
5202 Visual mode that was used.
5204 If an expression is supplied that results in a non-zero number
5205 or a non-empty string, then the Visual mode will be cleared
5206 and the old value is returned. Note that " " and "0" are also
5207 non-empty strings, thus cause the mode to be cleared.
5209 *winbufnr()*
5210 winbufnr({nr}) The result is a Number, which is the number of the buffer
5211 associated with window {nr}. When {nr} is zero, the number of
5212 the buffer in the current window is returned. When window
5213 {nr} doesn't exist, -1 is returned.
5214 Example: >
5215 :echo "The file in the current window is " . bufname(winbufnr(0))
5216 <
5217 *wincol()*
5218 wincol() The result is a Number, which is the virtual column of the
5219 cursor in the window. This is counting screen cells from the
5220 left side of the window. The leftmost column is one.
5222 winheight({nr}) *winheight()*
5223 The result is a Number, which is the height of window {nr}.
5224 When {nr} is zero, the height of the current window is
5225 returned. When window {nr} doesn't exist, -1 is returned.
5226 An existing window always has a height of zero or more.
5227 Examples: >
5228 :echo "The current window has " . winheight(0) . " lines."
5229 <
5230 *winline()*
5231 winline() The result is a Number, which is the screen line of the cursor
5232 in the window. This is counting screen lines from the top of
5233 the window. The first line is one.
5234 If the cursor was moved the view on the file will be updated
5235 first, this may cause a scroll.
5237 *winnr()*
5238 winnr([{arg}]) The result is a Number, which is the number of the current
5239 window. The top window has number 1.
5240 When the optional argument is "$", the number of the
5241 last window is returned (the window count).
5242 When the optional argument is "#", the number of the last
5243 accessed window is returned (where |CTRL-W_p| goes to).
5244 If there is no previous window or it is in another tab page 0
5245 is returned.
5246 The number can be used with |CTRL-W_w| and ":wincmd w"
5247 |:wincmd|.
5248 Also see |tabpagewinnr()|.
5250 *winrestcmd()*
5251 winrestcmd() Returns a sequence of |:resize| commands that should restore
5252 the current window sizes. Only works properly when no windows
5253 are opened or closed and the current window and tab page is
5254 unchanged.
5255 Example: >
5256 :let cmd = winrestcmd()
5257 :call MessWithWindowSizes()
5258 :exe cmd
5259 <
5260 *winrestview()*
5261 winrestview({dict})
5262 Uses the |Dictionary| returned by |winsaveview()| to restore
5263 the view of the current window.
5264 If you have changed the values the result is unpredictable.
5265 If the window size changed the result won't be the same.
5267 *winsaveview()*
5268 winsaveview() Returns a |Dictionary| that contains information to restore
5269 the view of the current window. Use |winrestview()| to
5270 restore the view.
5271 This is useful if you have a mapping that jumps around in the
5272 buffer and you want to go back to the original view.
5273 This does not save fold information. Use the 'foldenable'
5274 option to temporarily switch off folding, so that folds are
5275 not opened when moving around.
5276 The return value includes:
5277 lnum cursor line number
5278 col cursor column
5279 coladd cursor column offset for 'virtualedit'
5280 curswant column for vertical movement
5281 topline first line in the window
5282 topfill filler lines, only in diff mode
5283 leftcol first column displayed
5284 skipcol columns skipped
5285 Note that no option values are saved.
5288 winwidth({nr}) *winwidth()*
5289 The result is a Number, which is the width of window {nr}.
5290 When {nr} is zero, the width of the current window is
5291 returned. When window {nr} doesn't exist, -1 is returned.
5292 An existing window always has a width of zero or more.
5293 Examples: >
5294 :echo "The current window has " . winwidth(0) . " columns."
5295 :if winwidth(0) <= 50
5296 : exe "normal 50\<C-W>|"
5297 :endif
5298 <
5299 *writefile()*
5300 writefile({list}, {fname} [, {binary}])
5301 Write |List| {list} to file {fname}. Each list item is
5302 separated with a NL. Each list item must be a String or
5303 Number.
5304 When {binary} is equal to "b" binary mode is used: There will
5305 not be a NL after the last list item. An empty item at the
5306 end does cause the last line in the file to end in a NL.
5307 All NL characters are replaced with a NUL character.
5308 Inserting CR characters needs to be done before passing {list}
5309 to writefile().
5310 An existing file is overwritten, if possible.
5311 When the write fails -1 is returned, otherwise 0. There is an
5312 error message if the file can't be created or when writing
5313 fails.
5314 Also see |readfile()|.
5315 To copy a file byte for byte: >
5316 :let fl = readfile("foo", "b")
5317 :call writefile(fl, "foocopy", "b")
5318 <
5320 *feature-list*
5321 There are three types of features:
5322 1. Features that are only supported when they have been enabled when Vim
5323 was compiled |+feature-list|. Example: >
5324 :if has("cindent")
5325 2. Features that are only supported when certain conditions have been met.
5326 Example: >
5327 :if has("gui_running")
5328 < *has-patch*
5329 3. Included patches. First check |v:version| for the version of Vim.
5330 Then the "patch123" feature means that patch 123 has been included for
5331 this version. Example (checking version 6.2.148 or later): >
5332 :if v:version > 602 || v:version == 602 && has("patch148")
5333 < Note that it's possible for patch 147 to be omitted even though 148 is
5334 included.
5336 all_builtin_terms Compiled with all builtin terminals enabled.
5337 amiga Amiga version of Vim.
5338 arabic Compiled with Arabic support |Arabic|.
5339 arp Compiled with ARP support (Amiga).
5340 autocmd Compiled with autocommand support. |autocommand|
5341 balloon_eval Compiled with |balloon-eval| support.
5342 balloon_multiline GUI supports multiline balloons.
5343 beos BeOS version of Vim.
5344 browse Compiled with |:browse| support, and browse() will
5345 work.
5346 builtin_terms Compiled with some builtin terminals.
5347 byte_offset Compiled with support for 'o' in 'statusline'
5348 cindent Compiled with 'cindent' support.
5349 clientserver Compiled with remote invocation support |clientserver|.
5350 clipboard Compiled with 'clipboard' support.
5351 cmdline_compl Compiled with |cmdline-completion| support.
5352 cmdline_hist Compiled with |cmdline-history| support.
5353 cmdline_info Compiled with 'showcmd' and 'ruler' support.
5354 comments Compiled with |'comments'| support.
5355 cryptv Compiled with encryption support |encryption|.
5356 cscope Compiled with |cscope| support.
5357 compatible Compiled to be very Vi compatible.
5358 debug Compiled with "DEBUG" defined.
5359 dialog_con Compiled with console dialog support.
5360 dialog_gui Compiled with GUI dialog support.
5361 diff Compiled with |vimdiff| and 'diff' support.
5362 digraphs Compiled with support for digraphs.
5363 dnd Compiled with support for the "~ register |quote_~|.
5364 dos32 32 bits DOS (DJGPP) version of Vim.
5365 dos16 16 bits DOS version of Vim.
5366 ebcdic Compiled on a machine with ebcdic character set.
5367 emacs_tags Compiled with support for Emacs tags.
5368 eval Compiled with expression evaluation support. Always
5369 true, of course!
5370 ex_extra Compiled with extra Ex commands |+ex_extra|.
5371 extra_search Compiled with support for |'incsearch'| and
5372 |'hlsearch'|
5373 farsi Compiled with Farsi support |farsi|.
5374 file_in_path Compiled with support for |gf| and |<cfile>|
5375 filterpipe When 'shelltemp' is off pipes are used for shell
5376 read/write/filter commands
5377 find_in_path Compiled with support for include file searches
5378 |+find_in_path|.
5379 fname_case Case in file names matters (for Amiga, MS-DOS, and
5380 Windows this is not present).
5381 folding Compiled with |folding| support.
5382 footer Compiled with GUI footer support. |gui-footer|
5383 fork Compiled to use fork()/exec() instead of system().
5384 gettext Compiled with message translation |multi-lang|
5385 gui Compiled with GUI enabled.
5386 gui_athena Compiled with Athena GUI.
5387 gui_gtk Compiled with GTK+ GUI (any version).
5388 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
5389 gui_mac Compiled with Macintosh GUI.
5390 gui_motif Compiled with Motif GUI.
5391 gui_photon Compiled with Photon GUI.
5392 gui_win32 Compiled with MS Windows Win32 GUI.
5393 gui_win32s idem, and Win32s system being used (Windows 3.1)
5394 gui_running Vim is running in the GUI, or it will start soon.
5395 hangul_input Compiled with Hangul input support. |hangul|
5396 iconv Can use iconv() for conversion.
5397 insert_expand Compiled with support for CTRL-X expansion commands in
5398 Insert mode.
5399 jumplist Compiled with |jumplist| support.
5400 keymap Compiled with 'keymap' support.
5401 langmap Compiled with 'langmap' support.
5402 libcall Compiled with |libcall()| support.
5403 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
5404 support.
5405 lispindent Compiled with support for lisp indenting.
5406 listcmds Compiled with commands for the buffer list |:files|
5407 and the argument list |arglist|.
5408 localmap Compiled with local mappings and abbr. |:map-local|
5409 mac Macintosh version of Vim.
5410 macunix Macintosh version of Vim, using Unix files (OS-X).
5411 menu Compiled with support for |:menu|.
5412 mksession Compiled with support for |:mksession|.
5413 modify_fname Compiled with file name modifiers. |filename-modifiers|
5414 mouse Compiled with support mouse.
5415 mouseshape Compiled with support for 'mouseshape'.
5416 mouse_dec Compiled with support for Dec terminal mouse.
5417 mouse_gpm Compiled with support for gpm (Linux console mouse)
5418 mouse_netterm Compiled with support for netterm mouse.
5419 mouse_pterm Compiled with support for qnx pterm mouse.
5420 mouse_xterm Compiled with support for xterm mouse.
5421 multi_byte Compiled with support for editing Korean et al.
5422 multi_byte_ime Compiled with support for IME input method.
5423 multi_lang Compiled with support for multiple languages.
5424 mzscheme Compiled with MzScheme interface |mzscheme|.
5425 netbeans_intg Compiled with support for |netbeans|.
5426 netbeans_enabled Compiled with support for |netbeans| and it's used.
5427 ole Compiled with OLE automation support for Win32.
5428 os2 OS/2 version of Vim.
5429 osfiletype Compiled with support for osfiletypes |+osfiletype|
5430 path_extra Compiled with up/downwards search in 'path' and 'tags'
5431 perl Compiled with Perl interface.
5432 postscript Compiled with PostScript file printing.
5433 printer Compiled with |:hardcopy| support.
5434 profile Compiled with |:profile| support.
5435 python Compiled with Python interface.
5436 qnx QNX version of Vim.
5437 quickfix Compiled with |quickfix| support.
5438 reltime Compiled with |reltime()| support.
5439 rightleft Compiled with 'rightleft' support.
5440 ruby Compiled with Ruby interface |ruby|.
5441 scrollbind Compiled with 'scrollbind' support.
5442 showcmd Compiled with 'showcmd' support.
5443 signs Compiled with |:sign| support.
5444 smartindent Compiled with 'smartindent' support.
5445 sniff Compiled with SNiFF interface support.
5446 statusline Compiled with support for 'statusline', 'rulerformat'
5447 and special formats of 'titlestring' and 'iconstring'.
5448 sun_workshop Compiled with support for Sun |workshop|.
5449 spell Compiled with spell checking support |spell|.
5450 syntax Compiled with syntax highlighting support |syntax|.
5451 syntax_items There are active syntax highlighting items for the
5452 current buffer.
5453 system Compiled to use system() instead of fork()/exec().
5454 tag_binary Compiled with binary searching in tags files
5455 |tag-binary-search|.
5456 tag_old_static Compiled with support for old static tags
5457 |tag-old-static|.
5458 tag_any_white Compiled with support for any white characters in tags
5459 files |tag-any-white|.
5460 tcl Compiled with Tcl interface.
5461 terminfo Compiled with terminfo instead of termcap.
5462 termresponse Compiled with support for |t_RV| and |v:termresponse|.
5463 textobjects Compiled with support for |text-objects|.
5464 tgetent Compiled with tgetent support, able to use a termcap
5465 or terminfo file.
5466 title Compiled with window title support |'title'|.
5467 toolbar Compiled with support for |gui-toolbar|.
5468 unix Unix version of Vim.
5469 user_commands User-defined commands.
5470 viminfo Compiled with viminfo support.
5471 vim_starting True while initial source'ing takes place.
5472 vertsplit Compiled with vertically split windows |:vsplit|.
5473 virtualedit Compiled with 'virtualedit' option.
5474 visual Compiled with Visual mode.
5475 visualextra Compiled with extra Visual mode commands.
5476 |blockwise-operators|.
5477 vms VMS version of Vim.
5478 vreplace Compiled with |gR| and |gr| commands.
5479 wildignore Compiled with 'wildignore' option.
5480 wildmenu Compiled with 'wildmenu' option.
5481 windows Compiled with support for more than one window.
5482 winaltkeys Compiled with 'winaltkeys' option.
5483 win16 Win16 version of Vim (MS-Windows 3.1).
5484 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
5485 win64 Win64 version of Vim (MS-Windows 64 bit).
5486 win32unix Win32 version of Vim, using Unix files (Cygwin)
5487 win95 Win32 version for MS-Windows 95/98/ME.
5488 writebackup Compiled with 'writebackup' default on.
5489 xfontset Compiled with X fontset support |xfontset|.
5490 xim Compiled with X input method support |xim|.
5491 xsmp Compiled with X session management support.
5492 xsmp_interact Compiled with interactive X session management support.
5493 xterm_clipboard Compiled with support for xterm clipboard.
5494 xterm_save Compiled with support for saving and restoring the
5495 xterm screen.
5496 x11 Compiled with X11 support.
5498 *string-match*
5499 Matching a pattern in a String
5501 A regexp pattern as explained at |pattern| is normally used to find a match in
5502 the buffer lines. When a pattern is used to find a match in a String, almost
5503 everything works in the same way. The difference is that a String is handled
5504 like it is one line. When it contains a "\n" character, this is not seen as a
5505 line break for the pattern. It can be matched with a "\n" in the pattern, or
5506 with ".". Example: >
5507 :let a = "aaaa\nxxxx"
5508 :echo matchstr(a, "..\n..")
5509 aa
5510 xx
5511 :echo matchstr(a, "a.x")
5512 a
5513 x
5515 Don't forget that "^" will only match at the first character of the String and
5516 "$" at the last character of the string. They don't match after or before a
5517 "\n".
5519 ==============================================================================
5520 5. Defining functions *user-functions*
5522 New functions can be defined. These can be called just like builtin
5523 functions. The function executes a sequence of Ex commands. Normal mode
5524 commands can be executed with the |:normal| command.
5526 The function name must start with an uppercase letter, to avoid confusion with
5527 builtin functions. To prevent from using the same name in different scripts
5528 avoid obvious, short names. A good habit is to start the function name with
5529 the name of the script, e.g., "HTMLcolor()".
5531 It's also possible to use curly braces, see |curly-braces-names|. And the
5532 |autoload| facility is useful to define a function only when it's called.
5534 *local-function*
5535 A function local to a script must start with "s:". A local script function
5536 can only be called from within the script and from functions, user commands
5537 and autocommands defined in the script. It is also possible to call the
5538 function from a mappings defined in the script, but then |<SID>| must be used
5539 instead of "s:" when the mapping is expanded outside of the script.
5541 *:fu* *:function* *E128* *E129* *E123*
5542 :fu[nction] List all functions and their arguments.
5544 :fu[nction] {name} List function {name}.
5545 {name} can also be a |Dictionary| entry that is a
5546 |Funcref|: >
5547 :function dict.init
5549 :fu[nction] /{pattern} List functions with a name matching {pattern}.
5550 Example that lists all functions ending with "File": >
5551 :function /File$
5552 <
5553 *:function-verbose*
5554 When 'verbose' is non-zero, listing a function will also display where it was
5555 last defined. Example: >
5557 :verbose function SetFileTypeSH
5558 function SetFileTypeSH(name)
5559 Last set from /usr/share/vim/vim-7.0/filetype.vim
5560 <
5561 See |:verbose-cmd| for more information.
5563 *E124* *E125*
5564 :fu[nction][!] {name}([arguments]) [range] [abort] [dict]
5565 Define a new function by the name {name}. The name
5566 must be made of alphanumeric characters and '_', and
5567 must start with a capital or "s:" (see above).
5569 {name} can also be a |Dictionary| entry that is a
5570 |Funcref|: >
5571 :function dict.init(arg)
5572 < "dict" must be an existing dictionary. The entry
5573 "init" is added if it didn't exist yet. Otherwise [!]
5574 is required to overwrite an existing function. The
5575 result is a |Funcref| to a numbered function. The
5576 function can only be used with a |Funcref| and will be
5577 deleted if there are no more references to it.
5578 *E127* *E122*
5579 When a function by this name already exists and [!] is
5580 not used an error message is given. When [!] is used,
5581 an existing function is silently replaced. Unless it
5582 is currently being executed, that is an error.
5584 For the {arguments} see |function-argument|.
5586 *a:firstline* *a:lastline*
5587 When the [range] argument is added, the function is
5588 expected to take care of a range itself. The range is
5589 passed as "a:firstline" and "a:lastline". If [range]
5590 is excluded, ":{range}call" will call the function for
5591 each line in the range, with the cursor on the start
5592 of each line. See |function-range-example|.
5594 When the [abort] argument is added, the function will
5595 abort as soon as an error is detected.
5597 When the [dict] argument is added, the function must
5598 be invoked through an entry in a |Dictionary|. The
5599 local variable "self" will then be set to the
5600 dictionary. See |Dictionary-function|.
5602 The last used search pattern and the redo command "."
5603 will not be changed by the function.
5605 *:endf* *:endfunction* *E126* *E193*
5606 :endf[unction] The end of a function definition. Must be on a line
5607 by its own, without other commands.
5609 *:delf* *:delfunction* *E130* *E131*
5610 :delf[unction] {name} Delete function {name}.
5611 {name} can also be a |Dictionary| entry that is a
5612 |Funcref|: >
5613 :delfunc dict.init
5614 < This will remove the "init" entry from "dict". The
5615 function is deleted if there are no more references to
5616 it.
5617 *:retu* *:return* *E133*
5618 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
5619 evaluated and returned as the result of the function.
5620 If "[expr]" is not given, the number 0 is returned.
5621 When a function ends without an explicit ":return",
5622 the number 0 is returned.
5623 Note that there is no check for unreachable lines,
5624 thus there is no warning if commands follow ":return".
5626 If the ":return" is used after a |:try| but before the
5627 matching |:finally| (if present), the commands
5628 following the ":finally" up to the matching |:endtry|
5629 are executed first. This process applies to all
5630 nested ":try"s inside the function. The function
5631 returns at the outermost ":endtry".
5633 *function-argument* *a:var*
5634 An argument can be defined by giving its name. In the function this can then
5635 be used as "a:name" ("a:" for argument).
5636 *a:0* *a:1* *a:000* *E740* *...*
5637 Up to 20 arguments can be given, separated by commas. After the named
5638 arguments an argument "..." can be specified, which means that more arguments
5639 may optionally be following. In the function the extra arguments can be used
5640 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
5641 can be 0). "a:000" is set to a |List| that contains these arguments. Note
5642 that "a:1" is the same as "a:000[0]".
5643 *E742*
5644 The a: scope and the variables in it cannot be changed, they are fixed.
5645 However, if a |List| or |Dictionary| is used, you can changes their contents.
5646 Thus you can pass a |List| to a function and have the function add an item to
5647 it. If you want to make sure the function cannot change a |List| or
5648 |Dictionary| use |:lockvar|.
5650 When not using "...", the number of arguments in a function call must be equal
5651 to the number of named arguments. When using "...", the number of arguments
5652 may be larger.
5654 It is also possible to define a function without any arguments. You must
5655 still supply the () then. The body of the function follows in the next lines,
5656 until the matching |:endfunction|. It is allowed to define another function
5657 inside a function body.
5659 *local-variables*
5660 Inside a function variables can be used. These are local variables, which
5661 will disappear when the function returns. Global variables need to be
5662 accessed with "g:".
5664 Example: >
5665 :function Table(title, ...)
5666 : echohl Title
5667 : echo a:title
5668 : echohl None
5669 : echo a:0 . " items:"
5670 : for s in a:000
5671 : echon ' ' . s
5672 : endfor
5673 :endfunction
5675 This function can then be called with: >
5676 call Table("Table", "line1", "line2")
5677 call Table("Empty Table")
5679 To return more than one value, return a |List|: >
5680 :function Compute(n1, n2)
5681 : if a:n2 == 0
5682 : return ["fail", 0]
5683 : endif
5684 : return ["ok", a:n1 / a:n2]
5685 :endfunction
5687 This function can then be called with: >
5688 :let [success, div] = Compute(102, 6)
5689 :if success == "ok"
5690 : echo div
5691 :endif
5692 <
5693 *:cal* *:call* *E107* *E117*
5694 :[range]cal[l] {name}([arguments])
5695 Call a function. The name of the function and its arguments
5696 are as specified with |:function|. Up to 20 arguments can be
5697 used. The returned value is discarded.
5698 Without a range and for functions that accept a range, the
5699 function is called once. When a range is given the cursor is
5700 positioned at the start of the first line before executing the
5701 function.
5702 When a range is given and the function doesn't handle it
5703 itself, the function is executed for each line in the range,
5704 with the cursor in the first column of that line. The cursor
5705 is left at the last line (possibly moved by the last function
5706 call). The arguments are re-evaluated for each line. Thus
5707 this works:
5708 *function-range-example* >
5709 :function Mynumber(arg)
5710 : echo line(".") . " " . a:arg
5711 :endfunction
5712 :1,5call Mynumber(getline("."))
5713 <
5714 The "a:firstline" and "a:lastline" are defined anyway, they
5715 can be used to do something different at the start or end of
5716 the range.
5718 Example of a function that handles the range itself: >
5720 :function Cont() range
5721 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
5722 :endfunction
5723 :4,8call Cont()
5724 <
5725 This function inserts the continuation character "\" in front
5726 of all the lines in the range, except the first one.
5728 When the function returns a composite value it can be further
5729 dereferenced, but the range will not be used then. Example: >
5730 :4,8call GetDict().method()
5731 < Here GetDict() gets the range but method() does not.
5733 *E132*
5734 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
5735 option.
5738 AUTOMATICALLY LOADING FUNCTIONS ~
5739 *autoload-functions*
5740 When using many or large functions, it's possible to automatically define them
5741 only when they are used. There are two methods: with an autocommand and with
5742 the "autoload" directory in 'runtimepath'.
5745 Using an autocommand ~
5747 This is introduced in the user manual, section |41.14|.
5749 The autocommand is useful if you have a plugin that is a long Vim script file.
5750 You can define the autocommand and quickly quit the script with |:finish|.
5751 That makes Vim startup faster. The autocommand should then load the same file
5752 again, setting a variable to skip the |:finish| command.
5754 Use the FuncUndefined autocommand event with a pattern that matches the
5755 function(s) to be defined. Example: >
5757 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
5759 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
5760 "BufNet". Also see |FuncUndefined|.
5763 Using an autoload script ~
5764 *autoload* *E746*
5765 This is introduced in the user manual, section |41.15|.
5767 Using a script in the "autoload" directory is simpler, but requires using
5768 exactly the right file name. A function that can be autoloaded has a name
5769 like this: >
5771 :call filename#funcname()
5773 When such a function is called, and it is not defined yet, Vim will search the
5774 "autoload" directories in 'runtimepath' for a script file called
5775 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
5776 then define the function like this: >
5778 function filename#funcname()
5779 echo "Done!"
5780 endfunction
5782 The file name and the name used before the # in the function must match
5783 exactly, and the defined function must have the name exactly as it will be
5784 called.
5786 It is possible to use subdirectories. Every # in the function name works like
5787 a path separator. Thus when calling a function: >
5789 :call foo#bar#func()
5791 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
5793 This also works when reading a variable that has not been set yet: >
5795 :let l = foo#bar#lvar
5797 However, when the autoload script was already loaded it won't be loaded again
5798 for an unknown variable.
5800 When assigning a value to such a variable nothing special happens. This can
5801 be used to pass settings to the autoload script before it's loaded: >
5803 :let foo#bar#toggle = 1
5804 :call foo#bar#func()
5806 Note that when you make a mistake and call a function that is supposed to be
5807 defined in an autoload script, but the script doesn't actually define the
5808 function, the script will be sourced every time you try to call the function.
5809 And you will get an error message every time.
5811 Also note that if you have two script files, and one calls a function in the
5812 other and vise versa, before the used function is defined, it won't work.
5813 Avoid using the autoload functionality at the toplevel.
5815 Hint: If you distribute a bunch of scripts you can pack them together with the
5816 |vimball| utility. Also read the user manual |distribute-script|.
5818 ==============================================================================
5819 6. Curly braces names *curly-braces-names*
5821 Wherever you can use a variable, you can use a "curly braces name" variable.
5822 This is a regular variable name with one or more expressions wrapped in braces
5823 {} like this: >
5824 my_{adjective}_variable
5826 When Vim encounters this, it evaluates the expression inside the braces, puts
5827 that in place of the expression, and re-interprets the whole as a variable
5828 name. So in the above example, if the variable "adjective" was set to
5829 "noisy", then the reference would be to "my_noisy_variable", whereas if
5830 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
5832 One application for this is to create a set of variables governed by an option
5833 value. For example, the statement >
5834 echo my_{&background}_message
5836 would output the contents of "my_dark_message" or "my_light_message" depending
5837 on the current value of 'background'.
5839 You can use multiple brace pairs: >
5840 echo my_{adverb}_{adjective}_message
5841 ..or even nest them: >
5842 echo my_{ad{end_of_word}}_message
5843 where "end_of_word" is either "verb" or "jective".
5845 However, the expression inside the braces must evaluate to a valid single
5846 variable name, e.g. this is invalid: >
5847 :let foo='a + b'
5848 :echo c{foo}d
5849 .. since the result of expansion is "ca + bd", which is not a variable name.
5851 *curly-braces-function-names*
5852 You can call and define functions by an evaluated name in a similar way.
5853 Example: >
5854 :let func_end='whizz'
5855 :call my_func_{func_end}(parameter)
5857 This would call the function "my_func_whizz(parameter)".
5859 ==============================================================================
5860 7. Commands *expression-commands*
5862 :let {var-name} = {expr1} *:let* *E18*
5863 Set internal variable {var-name} to the result of the
5864 expression {expr1}. The variable will get the type
5865 from the {expr}. If {var-name} didn't exist yet, it
5866 is created.
5868 :let {var-name}[{idx}] = {expr1} *E689*
5869 Set a list item to the result of the expression
5870 {expr1}. {var-name} must refer to a list and {idx}
5871 must be a valid index in that list. For nested list
5872 the index can be repeated.
5873 This cannot be used to add an item to a list.
5875 *E711* *E719*
5876 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
5877 Set a sequence of items in a |List| to the result of
5878 the expression {expr1}, which must be a list with the
5879 correct number of items.
5880 {idx1} can be omitted, zero is used instead.
5881 {idx2} can be omitted, meaning the end of the list.
5882 When the selected range of items is partly past the
5883 end of the list, items will be added.
5885 *:let+=* *:let-=* *:let.=* *E734*
5886 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
5887 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
5888 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
5889 These fail if {var} was not set yet and when the type
5890 of {var} and {expr1} don't fit the operator.
5893 :let ${env-name} = {expr1} *:let-environment* *:let-$*
5894 Set environment variable {env-name} to the result of
5895 the expression {expr1}. The type is always String.
5896 :let ${env-name} .= {expr1}
5897 Append {expr1} to the environment variable {env-name}.
5898 If the environment variable didn't exist yet this
5899 works like "=".
5901 :let @{reg-name} = {expr1} *:let-register* *:let-@*
5902 Write the result of the expression {expr1} in register
5903 {reg-name}. {reg-name} must be a single letter, and
5904 must be the name of a writable register (see
5905 |registers|). "@@" can be used for the unnamed
5906 register, "@/" for the search pattern.
5907 If the result of {expr1} ends in a <CR> or <NL>, the
5908 register will be linewise, otherwise it will be set to
5909 characterwise.
5910 This can be used to clear the last search pattern: >
5911 :let @/ = ""
5912 < This is different from searching for an empty string,
5913 that would match everywhere.
5915 :let @{reg-name} .= {expr1}
5916 Append {expr1} to register {reg-name}. If the
5917 register was empty it's like setting it to {expr1}.
5919 :let &{option-name} = {expr1} *:let-option* *:let-&*
5920 Set option {option-name} to the result of the
5921 expression {expr1}. A String or Number value is
5922 always converted to the type of the option.
5923 For an option local to a window or buffer the effect
5924 is just like using the |:set| command: both the local
5925 value and the global value are changed.
5926 Example: >
5927 :let &path = &path . ',/usr/local/include'
5929 :let &{option-name} .= {expr1}
5930 For a string option: Append {expr1} to the value.
5931 Does not insert a comma like |:set+=|.
5933 :let &{option-name} += {expr1}
5934 :let &{option-name} -= {expr1}
5935 For a number or boolean option: Add or subtract
5936 {expr1}.
5938 :let &l:{option-name} = {expr1}
5939 :let &l:{option-name} .= {expr1}
5940 :let &l:{option-name} += {expr1}
5941 :let &l:{option-name} -= {expr1}
5942 Like above, but only set the local value of an option
5943 (if there is one). Works like |:setlocal|.
5945 :let &g:{option-name} = {expr1}
5946 :let &g:{option-name} .= {expr1}
5947 :let &g:{option-name} += {expr1}
5948 :let &g:{option-name} -= {expr1}
5949 Like above, but only set the global value of an option
5950 (if there is one). Works like |:setglobal|.
5952 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
5953 {expr1} must evaluate to a |List|. The first item in
5954 the list is assigned to {name1}, the second item to
5955 {name2}, etc.
5956 The number of names must match the number of items in
5957 the |List|.
5958 Each name can be one of the items of the ":let"
5959 command as mentioned above.
5960 Example: >
5961 :let [s, item] = GetItem(s)
5962 < Detail: {expr1} is evaluated first, then the
5963 assignments are done in sequence. This matters if
5964 {name2} depends on {name1}. Example: >
5965 :let x = [0, 1]
5966 :let i = 0
5967 :let [i, x[i]] = [1, 2]
5968 :echo x
5969 < The result is [0, 2].
5971 :let [{name1}, {name2}, ...] .= {expr1}
5972 :let [{name1}, {name2}, ...] += {expr1}
5973 :let [{name1}, {name2}, ...] -= {expr1}
5974 Like above, but append/add/subtract the value for each
5975 |List| item.
5977 :let [{name}, ..., ; {lastname}] = {expr1}
5978 Like |:let-unpack| above, but the |List| may have more
5979 items than there are names. A list of the remaining
5980 items is assigned to {lastname}. If there are no
5981 remaining items {lastname} is set to an empty list.
5982 Example: >
5983 :let [a, b; rest] = ["aval", "bval", 3, 4]
5984 <
5985 :let [{name}, ..., ; {lastname}] .= {expr1}
5986 :let [{name}, ..., ; {lastname}] += {expr1}
5987 :let [{name}, ..., ; {lastname}] -= {expr1}
5988 Like above, but append/add/subtract the value for each
5989 |List| item.
5990 *E106*
5991 :let {var-name} .. List the value of variable {var-name}. Multiple
5992 variable names may be given. Special names recognized
5993 here: *E738*
5994 g: global variables
5995 b: local buffer variables
5996 w: local window variables
5997 t: local tab page variables
5998 s: script-local variables
5999 l: local function variables
6000 v: Vim variables.
6002 :let List the values of all variables. The type of the
6003 variable is indicated before the value:
6004 <nothing> String
6005 # Number
6006 * Funcref
6009 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
6010 Remove the internal variable {name}. Several variable
6011 names can be given, they are all removed. The name
6012 may also be a |List| or |Dictionary| item.
6013 With [!] no error message is given for non-existing
6014 variables.
6015 One or more items from a |List| can be removed: >
6016 :unlet list[3] " remove fourth item
6017 :unlet list[3:] " remove fourth item to last
6018 < One item from a |Dictionary| can be removed at a time: >
6019 :unlet dict['two']
6020 :unlet dict.two
6022 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
6023 Lock the internal variable {name}. Locking means that
6024 it can no longer be changed (until it is unlocked).
6025 A locked variable can be deleted: >
6026 :lockvar v
6027 :let v = 'asdf' " fails!
6028 :unlet v
6029 < *E741*
6030 If you try to change a locked variable you get an
6031 error message: "E741: Value of {name} is locked"
6033 [depth] is relevant when locking a |List| or
6034 |Dictionary|. It specifies how deep the locking goes:
6035 1 Lock the |List| or |Dictionary| itself,
6036 cannot add or remove items, but can
6037 still change their values.
6038 2 Also lock the values, cannot change
6039 the items. If an item is a |List| or
6040 |Dictionary|, cannot add or remove
6041 items, but can still change the
6042 values.
6043 3 Like 2 but for the |List| /
6044 |Dictionary| in the |List| /
6045 |Dictionary|, one level deeper.
6046 The default [depth] is 2, thus when {name} is a |List|
6047 or |Dictionary| the values cannot be changed.
6048 *E743*
6049 For unlimited depth use [!] and omit [depth].
6050 However, there is a maximum depth of 100 to catch
6051 loops.
6053 Note that when two variables refer to the same |List|
6054 and you lock one of them, the |List| will also be
6055 locked when used through the other variable.
6056 Example: >
6057 :let l = [0, 1, 2, 3]
6058 :let cl = l
6059 :lockvar l
6060 :let cl[1] = 99 " won't work!
6061 < You may want to make a copy of a list to avoid this.
6062 See |deepcopy()|.
6065 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
6066 Unlock the internal variable {name}. Does the
6067 opposite of |:lockvar|.
6070 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
6071 :en[dif] Execute the commands until the next matching ":else"
6072 or ":endif" if {expr1} evaluates to non-zero.
6074 From Vim version 4.5 until 5.0, every Ex command in
6075 between the ":if" and ":endif" is ignored. These two
6076 commands were just to allow for future expansions in a
6077 backwards compatible way. Nesting was allowed. Note
6078 that any ":else" or ":elseif" was ignored, the "else"
6079 part was not executed either.
6081 You can use this to remain compatible with older
6082 versions: >
6083 :if version >= 500
6084 : version-5-specific-commands
6085 :endif
6086 < The commands still need to be parsed to find the
6087 "endif". Sometimes an older Vim has a problem with a
6088 new command. For example, ":silent" is recognized as
6089 a ":substitute" command. In that case ":execute" can
6090 avoid problems: >
6091 :if version >= 600
6092 : execute "silent 1,$delete"
6093 :endif
6094 <
6095 NOTE: The ":append" and ":insert" commands don't work
6096 properly in between ":if" and ":endif".
6098 *:else* *:el* *E581* *E583*
6099 :el[se] Execute the commands until the next matching ":else"
6100 or ":endif" if they previously were not being
6101 executed.
6103 *:elseif* *:elsei* *E582* *E584*
6104 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
6105 is no extra ":endif".
6107 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
6108 *E170* *E585* *E588* *E733*
6109 :endw[hile] Repeat the commands between ":while" and ":endwhile",
6110 as long as {expr1} evaluates to non-zero.
6111 When an error is detected from a command inside the
6112 loop, execution continues after the "endwhile".
6113 Example: >
6114 :let lnum = 1
6115 :while lnum <= line("$")
6116 :call FixLine(lnum)
6117 :let lnum = lnum + 1
6118 :endwhile
6119 <
6120 NOTE: The ":append" and ":insert" commands don't work
6121 properly inside a ":while" and ":for" loop.
6123 :for {var} in {list} *:for* *E690* *E732*
6124 :endfo[r] *:endfo* *:endfor*
6125 Repeat the commands between ":for" and ":endfor" for
6126 each item in {list}. Variable {var} is set to the
6127 value of each item.
6128 When an error is detected for a command inside the
6129 loop, execution continues after the "endfor".
6130 Changing {list} inside the loop affects what items are
6131 used. Make a copy if this is unwanted: >
6132 :for item in copy(mylist)
6133 < When not making a copy, Vim stores a reference to the
6134 next item in the list, before executing the commands
6135 with the current item. Thus the current item can be
6136 removed without effect. Removing any later item means
6137 it will not be found. Thus the following example
6138 works (an inefficient way to make a list empty): >
6139 :for item in mylist
6140 :call remove(mylist, 0)
6141 :endfor
6142 < Note that reordering the list (e.g., with sort() or
6143 reverse()) may have unexpected effects.
6144 Note that the type of each list item should be
6145 identical to avoid errors for the type of {var}
6146 changing. Unlet the variable at the end of the loop
6147 to allow multiple item types.
6149 :for [{var1}, {var2}, ...] in {listlist}
6150 :endfo[r]
6151 Like ":for" above, but each item in {listlist} must be
6152 a list, of which each item is assigned to {var1},
6153 {var2}, etc. Example: >
6154 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
6155 :echo getline(lnum)[col]
6156 :endfor
6157 <
6158 *:continue* *:con* *E586*
6159 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
6160 to the start of the loop.
6161 If it is used after a |:try| inside the loop but
6162 before the matching |:finally| (if present), the
6163 commands following the ":finally" up to the matching
6164 |:endtry| are executed first. This process applies to
6165 all nested ":try"s inside the loop. The outermost
6166 ":endtry" then jumps back to the start of the loop.
6168 *:break* *:brea* *E587*
6169 :brea[k] When used inside a ":while" or ":for" loop, skips to
6170 the command after the matching ":endwhile" or
6171 ":endfor".
6172 If it is used after a |:try| inside the loop but
6173 before the matching |:finally| (if present), the
6174 commands following the ":finally" up to the matching
6175 |:endtry| are executed first. This process applies to
6176 all nested ":try"s inside the loop. The outermost
6177 ":endtry" then jumps to the command after the loop.
6179 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
6180 :endt[ry] Change the error handling for the commands between
6181 ":try" and ":endtry" including everything being
6182 executed across ":source" commands, function calls,
6183 or autocommand invocations.
6185 When an error or interrupt is detected and there is
6186 a |:finally| command following, execution continues
6187 after the ":finally". Otherwise, or when the
6188 ":endtry" is reached thereafter, the next
6189 (dynamically) surrounding ":try" is checked for
6190 a corresponding ":finally" etc. Then the script
6191 processing is terminated. (Whether a function
6192 definition has an "abort" argument does not matter.)
6193 Example: >
6194 :try | edit too much | finally | echo "cleanup" | endtry
6195 :echo "impossible" " not reached, script terminated above
6196 <
6197 Moreover, an error or interrupt (dynamically) inside
6198 ":try" and ":endtry" is converted to an exception. It
6199 can be caught as if it were thrown by a |:throw|
6200 command (see |:catch|). In this case, the script
6201 processing is not terminated.
6203 The value "Vim:Interrupt" is used for an interrupt
6204 exception. An error in a Vim command is converted
6205 to a value of the form "Vim({command}):{errmsg}",
6206 other errors are converted to a value of the form
6207 "Vim:{errmsg}". {command} is the full command name,
6208 and {errmsg} is the message that is displayed if the
6209 error exception is not caught, always beginning with
6210 the error number.
6211 Examples: >
6212 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
6213 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
6214 <
6215 *:cat* *:catch* *E603* *E604* *E605*
6216 :cat[ch] /{pattern}/ The following commands until the next ":catch",
6217 |:finally|, or |:endtry| that belongs to the same
6218 |:try| as the ":catch" are executed when an exception
6219 matching {pattern} is being thrown and has not yet
6220 been caught by a previous ":catch". Otherwise, these
6221 commands are skipped.
6222 When {pattern} is omitted all errors are caught.
6223 Examples: >
6224 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
6225 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
6226 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
6227 :catch /^Vim(write):/ " catch all errors in :write
6228 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
6229 :catch /my-exception/ " catch user exception
6230 :catch /.*/ " catch everything
6231 :catch " same as /.*/
6232 <
6233 Another character can be used instead of / around the
6234 {pattern}, so long as it does not have a special
6235 meaning (e.g., '|' or '"') and doesn't occur inside
6236 {pattern}.
6237 NOTE: It is not reliable to ":catch" the TEXT of
6238 an error message because it may vary in different
6239 locales.
6241 *:fina* *:finally* *E606* *E607*
6242 :fina[lly] The following commands until the matching |:endtry|
6243 are executed whenever the part between the matching
6244 |:try| and the ":finally" is left: either by falling
6245 through to the ":finally" or by a |:continue|,
6246 |:break|, |:finish|, or |:return|, or by an error or
6247 interrupt or exception (see |:throw|).
6249 *:th* *:throw* *E608*
6250 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
6251 If the ":throw" is used after a |:try| but before the
6252 first corresponding |:catch|, commands are skipped
6253 until the first ":catch" matching {expr1} is reached.
6254 If there is no such ":catch" or if the ":throw" is
6255 used after a ":catch" but before the |:finally|, the
6256 commands following the ":finally" (if present) up to
6257 the matching |:endtry| are executed. If the ":throw"
6258 is after the ":finally", commands up to the ":endtry"
6259 are skipped. At the ":endtry", this process applies
6260 again for the next dynamically surrounding ":try"
6261 (which may be found in a calling function or sourcing
6262 script), until a matching ":catch" has been found.
6263 If the exception is not caught, the command processing
6264 is terminated.
6265 Example: >
6266 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
6267 <
6269 *:ec* *:echo*
6270 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
6271 first {expr1} starts on a new line.
6272 Also see |:comment|.
6273 Use "\n" to start a new line. Use "\r" to move the
6274 cursor to the first column.
6275 Uses the highlighting set by the |:echohl| command.
6276 Cannot be followed by a comment.
6277 Example: >
6278 :echo "the value of 'shell' is" &shell
6279 < *:echo-redraw*
6280 A later redraw may make the message disappear again.
6281 And since Vim mostly postpones redrawing until it's
6282 finished with a sequence of commands this happens
6283 quite often. To avoid that a command from before the
6284 ":echo" causes a redraw afterwards (redraws are often
6285 postponed until you type something), force a redraw
6286 with the |:redraw| command. Example: >
6287 :new | redraw | echo "there is a new window"
6288 <
6289 *:echon*
6290 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
6291 |:comment|.
6292 Uses the highlighting set by the |:echohl| command.
6293 Cannot be followed by a comment.
6294 Example: >
6295 :echon "the value of 'shell' is " &shell
6296 <
6297 Note the difference between using ":echo", which is a
6298 Vim command, and ":!echo", which is an external shell
6299 command: >
6300 :!echo % --> filename
6301 < The arguments of ":!" are expanded, see |:_%|. >
6302 :!echo "%" --> filename or "filename"
6303 < Like the previous example. Whether you see the double
6304 quotes or not depends on your 'shell'. >
6305 :echo % --> nothing
6306 < The '%' is an illegal character in an expression. >
6307 :echo "%" --> %
6308 < This just echoes the '%' character. >
6309 :echo expand("%") --> filename
6310 < This calls the expand() function to expand the '%'.
6312 *:echoh* *:echohl*
6313 :echoh[l] {name} Use the highlight group {name} for the following
6314 |:echo|, |:echon| and |:echomsg| commands. Also used
6315 for the |input()| prompt. Example: >
6316 :echohl WarningMsg | echo "Don't panic!" | echohl None
6317 < Don't forget to set the group back to "None",
6318 otherwise all following echo's will be highlighted.
6320 *:echom* *:echomsg*
6321 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
6322 message in the |message-history|.
6323 Spaces are placed between the arguments as with the
6324 |:echo| command. But unprintable characters are
6325 displayed, not interpreted.
6326 The parsing works slightly different from |:echo|,
6327 more like |:execute|. All the expressions are first
6328 evaluated and concatenated before echoing anything.
6329 The expressions must evaluate to a Number or String, a
6330 Dictionary or List causes an error.
6331 Uses the highlighting set by the |:echohl| command.
6332 Example: >
6333 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
6334 < See |:echo-redraw| to avoid the message disappearing
6335 when the screen is redrawn.
6336 *:echoe* *:echoerr*
6337 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
6338 message in the |message-history|. When used in a
6339 script or function the line number will be added.
6340 Spaces are placed between the arguments as with the
6341 :echo command. When used inside a try conditional,
6342 the message is raised as an error exception instead
6343 (see |try-echoerr|).
6344 Example: >
6345 :echoerr "This script just failed!"
6346 < If you just want a highlighted message use |:echohl|.
6347 And to get a beep: >
6348 :exe "normal \<Esc>"
6349 <
6350 *:exe* *:execute*
6351 :exe[cute] {expr1} .. Executes the string that results from the evaluation
6352 of {expr1} as an Ex command. Multiple arguments are
6353 concatenated, with a space in between. {expr1} is
6354 used as the processed command, command line editing
6355 keys are not recognized.
6356 Cannot be followed by a comment.
6357 Examples: >
6358 :execute "buffer " nextbuf
6359 :execute "normal " count . "w"
6360 <
6361 ":execute" can be used to append a command to commands
6362 that don't accept a '|'. Example: >
6363 :execute '!ls' | echo "theend"
6365 < ":execute" is also a nice way to avoid having to type
6366 control characters in a Vim script for a ":normal"
6367 command: >
6368 :execute "normal ixxx\<Esc>"
6369 < This has an <Esc> character, see |expr-string|.
6371 Note: The executed string may be any command-line, but
6372 you cannot start or end a "while", "for" or "if"
6373 command. Thus this is illegal: >
6374 :execute 'while i > 5'
6375 :execute 'echo "test" | break'
6376 <
6377 It is allowed to have a "while" or "if" command
6378 completely in the executed string: >
6379 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
6380 <
6382 *:comment*
6383 ":execute", ":echo" and ":echon" cannot be followed by
6384 a comment directly, because they see the '"' as the
6385 start of a string. But, you can use '|' followed by a
6386 comment. Example: >
6387 :echo "foo" | "this is a comment
6389 ==============================================================================
6390 8. Exception handling *exception-handling*
6392 The Vim script language comprises an exception handling feature. This section
6393 explains how it can be used in a Vim script.
6395 Exceptions may be raised by Vim on an error or on interrupt, see
6396 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
6397 exception by using the ":throw" command, see |throw-catch|.
6400 TRY CONDITIONALS *try-conditionals*
6402 Exceptions can be caught or can cause cleanup code to be executed. You can
6403 use a try conditional to specify catch clauses (that catch exceptions) and/or
6404 a finally clause (to be executed for cleanup).
6405 A try conditional begins with a |:try| command and ends at the matching
6406 |:endtry| command. In between, you can use a |:catch| command to start
6407 a catch clause, or a |:finally| command to start a finally clause. There may
6408 be none or multiple catch clauses, but there is at most one finally clause,
6409 which must not be followed by any catch clauses. The lines before the catch
6410 clauses and the finally clause is called a try block. >
6412 :try
6413 : ...
6414 : ... TRY BLOCK
6415 : ...
6416 :catch /{pattern}/
6417 : ...
6418 : ... CATCH CLAUSE
6419 : ...
6420 :catch /{pattern}/
6421 : ...
6422 : ... CATCH CLAUSE
6423 : ...
6424 :finally
6425 : ...
6426 : ... FINALLY CLAUSE
6427 : ...
6428 :endtry
6430 The try conditional allows to watch code for exceptions and to take the
6431 appropriate actions. Exceptions from the try block may be caught. Exceptions
6432 from the try block and also the catch clauses may cause cleanup actions.
6433 When no exception is thrown during execution of the try block, the control
6434 is transferred to the finally clause, if present. After its execution, the
6435 script continues with the line following the ":endtry".
6436 When an exception occurs during execution of the try block, the remaining
6437 lines in the try block are skipped. The exception is matched against the
6438 patterns specified as arguments to the ":catch" commands. The catch clause
6439 after the first matching ":catch" is taken, other catch clauses are not
6440 executed. The catch clause ends when the next ":catch", ":finally", or
6441 ":endtry" command is reached - whatever is first. Then, the finally clause
6442 (if present) is executed. When the ":endtry" is reached, the script execution
6443 continues in the following line as usual.
6444 When an exception that does not match any of the patterns specified by the
6445 ":catch" commands is thrown in the try block, the exception is not caught by
6446 that try conditional and none of the catch clauses is executed. Only the
6447 finally clause, if present, is taken. The exception pends during execution of
6448 the finally clause. It is resumed at the ":endtry", so that commands after
6449 the ":endtry" are not executed and the exception might be caught elsewhere,
6450 see |try-nesting|.
6451 When during execution of a catch clause another exception is thrown, the
6452 remaining lines in that catch clause are not executed. The new exception is
6453 not matched against the patterns in any of the ":catch" commands of the same
6454 try conditional and none of its catch clauses is taken. If there is, however,
6455 a finally clause, it is executed, and the exception pends during its
6456 execution. The commands following the ":endtry" are not executed. The new
6457 exception might, however, be caught elsewhere, see |try-nesting|.
6458 When during execution of the finally clause (if present) an exception is
6459 thrown, the remaining lines in the finally clause are skipped. If the finally
6460 clause has been taken because of an exception from the try block or one of the
6461 catch clauses, the original (pending) exception is discarded. The commands
6462 following the ":endtry" are not executed, and the exception from the finally
6463 clause is propagated and can be caught elsewhere, see |try-nesting|.
6465 The finally clause is also executed, when a ":break" or ":continue" for
6466 a ":while" loop enclosing the complete try conditional is executed from the
6467 try block or a catch clause. Or when a ":return" or ":finish" is executed
6468 from the try block or a catch clause of a try conditional in a function or
6469 sourced script, respectively. The ":break", ":continue", ":return", or
6470 ":finish" pends during execution of the finally clause and is resumed when the
6471 ":endtry" is reached. It is, however, discarded when an exception is thrown
6472 from the finally clause.
6473 When a ":break" or ":continue" for a ":while" loop enclosing the complete
6474 try conditional or when a ":return" or ":finish" is encountered in the finally
6475 clause, the rest of the finally clause is skipped, and the ":break",
6476 ":continue", ":return" or ":finish" is executed as usual. If the finally
6477 clause has been taken because of an exception or an earlier ":break",
6478 ":continue", ":return", or ":finish" from the try block or a catch clause,
6479 this pending exception or command is discarded.
6481 For examples see |throw-catch| and |try-finally|.
6484 NESTING OF TRY CONDITIONALS *try-nesting*
6486 Try conditionals can be nested arbitrarily. That is, a complete try
6487 conditional can be put into the try block, a catch clause, or the finally
6488 clause of another try conditional. If the inner try conditional does not
6489 catch an exception thrown in its try block or throws a new exception from one
6490 of its catch clauses or its finally clause, the outer try conditional is
6491 checked according to the rules above. If the inner try conditional is in the
6492 try block of the outer try conditional, its catch clauses are checked, but
6493 otherwise only the finally clause is executed. It does not matter for
6494 nesting, whether the inner try conditional is directly contained in the outer
6495 one, or whether the outer one sources a script or calls a function containing
6496 the inner try conditional.
6498 When none of the active try conditionals catches an exception, just their
6499 finally clauses are executed. Thereafter, the script processing terminates.
6500 An error message is displayed in case of an uncaught exception explicitly
6501 thrown by a ":throw" command. For uncaught error and interrupt exceptions
6502 implicitly raised by Vim, the error message(s) or interrupt message are shown
6503 as usual.
6505 For examples see |throw-catch|.
6508 EXAMINING EXCEPTION HANDLING CODE *except-examine*
6510 Exception handling code can get tricky. If you are in doubt what happens, set
6511 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
6512 script file. Then you see when an exception is thrown, discarded, caught, or
6513 finished. When using a verbosity level of at least 14, things pending in
6514 a finally clause are also shown. This information is also given in debug mode
6515 (see |debug-scripts|).
6518 THROWING AND CATCHING EXCEPTIONS *throw-catch*
6520 You can throw any number or string as an exception. Use the |:throw| command
6521 and pass the value to be thrown as argument: >
6522 :throw 4711
6523 :throw "string"
6524 < *throw-expression*
6525 You can also specify an expression argument. The expression is then evaluated
6526 first, and the result is thrown: >
6527 :throw 4705 + strlen("string")
6528 :throw strpart("strings", 0, 6)
6530 An exception might be thrown during evaluation of the argument of the ":throw"
6531 command. Unless it is caught there, the expression evaluation is abandoned.
6532 The ":throw" command then does not throw a new exception.
6533 Example: >
6535 :function! Foo(arg)
6536 : try
6537 : throw a:arg
6538 : catch /foo/
6539 : endtry
6540 : return 1
6541 :endfunction
6542 :
6543 :function! Bar()
6544 : echo "in Bar"
6545 : return 4710
6546 :endfunction
6547 :
6548 :throw Foo("arrgh") + Bar()
6550 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
6551 executed. >
6552 :throw Foo("foo") + Bar()
6553 however displays "in Bar" and throws 4711.
6555 Any other command that takes an expression as argument might also be
6556 abandoned by an (uncaught) exception during the expression evaluation. The
6557 exception is then propagated to the caller of the command.
6558 Example: >
6560 :if Foo("arrgh")
6561 : echo "then"
6562 :else
6563 : echo "else"
6564 :endif
6566 Here neither of "then" or "else" is displayed.
6568 *catch-order*
6569 Exceptions can be caught by a try conditional with one or more |:catch|
6570 commands, see |try-conditionals|. The values to be caught by each ":catch"
6571 command can be specified as a pattern argument. The subsequent catch clause
6572 gets executed when a matching exception is caught.
6573 Example: >
6575 :function! Foo(value)
6576 : try
6577 : throw a:value
6578 : catch /^\d\+$/
6579 : echo "Number thrown"
6580 : catch /.*/
6581 : echo "String thrown"
6582 : endtry
6583 :endfunction
6584 :
6585 :call Foo(0x1267)
6586 :call Foo('string')
6588 The first call to Foo() displays "Number thrown", the second "String thrown".
6589 An exception is matched against the ":catch" commands in the order they are
6590 specified. Only the first match counts. So you should place the more
6591 specific ":catch" first. The following order does not make sense: >
6593 : catch /.*/
6594 : echo "String thrown"
6595 : catch /^\d\+$/
6596 : echo "Number thrown"
6598 The first ":catch" here matches always, so that the second catch clause is
6599 never taken.
6601 *throw-variables*
6602 If you catch an exception by a general pattern, you may access the exact value
6603 in the variable |v:exception|: >
6605 : catch /^\d\+$/
6606 : echo "Number thrown. Value is" v:exception
6608 You may also be interested where an exception was thrown. This is stored in
6609 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
6610 exception most recently caught as long it is not finished.
6611 Example: >
6613 :function! Caught()
6614 : if v:exception != ""
6615 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
6616 : else
6617 : echo 'Nothing caught'
6618 : endif
6619 :endfunction
6620 :
6621 :function! Foo()
6622 : try
6623 : try
6624 : try
6625 : throw 4711
6626 : finally
6627 : call Caught()
6628 : endtry
6629 : catch /.*/
6630 : call Caught()
6631 : throw "oops"
6632 : endtry
6633 : catch /.*/
6634 : call Caught()
6635 : finally
6636 : call Caught()
6637 : endtry
6638 :endfunction
6639 :
6640 :call Foo()
6642 This displays >
6644 Nothing caught
6645 Caught "4711" in function Foo, line 4
6646 Caught "oops" in function Foo, line 10
6647 Nothing caught
6649 A practical example: The following command ":LineNumber" displays the line
6650 number in the script or function where it has been used: >
6652 :function! LineNumber()
6653 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
6654 :endfunction
6655 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
6656 <
6657 *try-nested*
6658 An exception that is not caught by a try conditional can be caught by
6659 a surrounding try conditional: >
6661 :try
6662 : try
6663 : throw "foo"
6664 : catch /foobar/
6665 : echo "foobar"
6666 : finally
6667 : echo "inner finally"
6668 : endtry
6669 :catch /foo/
6670 : echo "foo"
6671 :endtry
6673 The inner try conditional does not catch the exception, just its finally
6674 clause is executed. The exception is then caught by the outer try
6675 conditional. The example displays "inner finally" and then "foo".
6677 *throw-from-catch*
6678 You can catch an exception and throw a new one to be caught elsewhere from the
6679 catch clause: >
6681 :function! Foo()
6682 : throw "foo"
6683 :endfunction
6684 :
6685 :function! Bar()
6686 : try
6687 : call Foo()
6688 : catch /foo/
6689 : echo "Caught foo, throw bar"
6690 : throw "bar"
6691 : endtry
6692 :endfunction
6693 :
6694 :try
6695 : call Bar()
6696 :catch /.*/
6697 : echo "Caught" v:exception
6698 :endtry
6700 This displays "Caught foo, throw bar" and then "Caught bar".
6702 *rethrow*
6703 There is no real rethrow in the Vim script language, but you may throw
6704 "v:exception" instead: >
6706 :function! Bar()
6707 : try
6708 : call Foo()
6709 : catch /.*/
6710 : echo "Rethrow" v:exception
6711 : throw v:exception
6712 : endtry
6713 :endfunction
6714 < *try-echoerr*
6715 Note that this method cannot be used to "rethrow" Vim error or interrupt
6716 exceptions, because it is not possible to fake Vim internal exceptions.
6717 Trying so causes an error exception. You should throw your own exception
6718 denoting the situation. If you want to cause a Vim error exception containing
6719 the original error exception value, you can use the |:echoerr| command: >
6721 :try
6722 : try
6723 : asdf
6724 : catch /.*/
6725 : echoerr v:exception
6726 : endtry
6727 :catch /.*/
6728 : echo v:exception
6729 :endtry
6731 This code displays
6733 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
6736 CLEANUP CODE *try-finally*
6738 Scripts often change global settings and restore them at their end. If the
6739 user however interrupts the script by pressing CTRL-C, the settings remain in
6740 an inconsistent state. The same may happen to you in the development phase of
6741 a script when an error occurs or you explicitly throw an exception without
6742 catching it. You can solve these problems by using a try conditional with
6743 a finally clause for restoring the settings. Its execution is guaranteed on
6744 normal control flow, on error, on an explicit ":throw", and on interrupt.
6745 (Note that errors and interrupts from inside the try conditional are converted
6746 to exceptions. When not caught, they terminate the script after the finally
6747 clause has been executed.)
6748 Example: >
6750 :try
6751 : let s:saved_ts = &ts
6752 : set ts=17
6753 :
6754 : " Do the hard work here.
6755 :
6756 :finally
6757 : let &ts = s:saved_ts
6758 : unlet s:saved_ts
6759 :endtry
6761 This method should be used locally whenever a function or part of a script
6762 changes global settings which need to be restored on failure or normal exit of
6763 that function or script part.
6765 *break-finally*
6766 Cleanup code works also when the try block or a catch clause is left by
6767 a ":continue", ":break", ":return", or ":finish".
6768 Example: >
6770 :let first = 1
6771 :while 1
6772 : try
6773 : if first
6774 : echo "first"
6775 : let first = 0
6776 : continue
6777 : else
6778 : throw "second"
6779 : endif
6780 : catch /.*/
6781 : echo v:exception
6782 : break
6783 : finally
6784 : echo "cleanup"
6785 : endtry
6786 : echo "still in while"
6787 :endwhile
6788 :echo "end"
6790 This displays "first", "cleanup", "second", "cleanup", and "end". >
6792 :function! Foo()
6793 : try
6794 : return 4711
6795 : finally
6796 : echo "cleanup\n"
6797 : endtry
6798 : echo "Foo still active"
6799 :endfunction
6800 :
6801 :echo Foo() "returned by Foo"
6803 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
6804 extra ":return" in the finally clause. (Above all, this would override the
6805 return value.)
6807 *except-from-finally*
6808 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
6809 a finally clause is possible, but not recommended since it abandons the
6810 cleanup actions for the try conditional. But, of course, interrupt and error
6811 exceptions might get raised from a finally clause.
6812 Example where an error in the finally clause stops an interrupt from
6813 working correctly: >
6815 :try
6816 : try
6817 : echo "Press CTRL-C for interrupt"
6818 : while 1
6819 : endwhile
6820 : finally
6821 : unlet novar
6822 : endtry
6823 :catch /novar/
6824 :endtry
6825 :echo "Script still running"
6826 :sleep 1
6828 If you need to put commands that could fail into a finally clause, you should
6829 think about catching or ignoring the errors in these commands, see
6830 |catch-errors| and |ignore-errors|.
6833 CATCHING ERRORS *catch-errors*
6835 If you want to catch specific errors, you just have to put the code to be
6836 watched in a try block and add a catch clause for the error message. The
6837 presence of the try conditional causes all errors to be converted to an
6838 exception. No message is displayed and |v:errmsg| is not set then. To find
6839 the right pattern for the ":catch" command, you have to know how the format of
6840 the error exception is.
6841 Error exceptions have the following format: >
6843 Vim({cmdname}):{errmsg}
6844 or >
6845 Vim:{errmsg}
6847 {cmdname} is the name of the command that failed; the second form is used when
6848 the command name is not known. {errmsg} is the error message usually produced
6849 when the error occurs outside try conditionals. It always begins with
6850 a capital "E", followed by a two or three-digit error number, a colon, and
6851 a space.
6853 Examples:
6855 The command >
6856 :unlet novar
6857 normally produces the error message >
6858 E108: No such variable: "novar"
6859 which is converted inside try conditionals to an exception >
6860 Vim(unlet):E108: No such variable: "novar"
6862 The command >
6863 :dwim
6864 normally produces the error message >
6865 E492: Not an editor command: dwim
6866 which is converted inside try conditionals to an exception >
6867 Vim:E492: Not an editor command: dwim
6869 You can catch all ":unlet" errors by a >
6870 :catch /^Vim(unlet):/
6871 or all errors for misspelled command names by a >
6872 :catch /^Vim:E492:/
6874 Some error messages may be produced by different commands: >
6875 :function nofunc
6876 and >
6877 :delfunction nofunc
6878 both produce the error message >
6879 E128: Function name must start with a capital: nofunc
6880 which is converted inside try conditionals to an exception >
6881 Vim(function):E128: Function name must start with a capital: nofunc
6882 or >
6883 Vim(delfunction):E128: Function name must start with a capital: nofunc
6884 respectively. You can catch the error by its number independently on the
6885 command that caused it if you use the following pattern: >
6886 :catch /^Vim(\a\+):E128:/
6888 Some commands like >
6889 :let x = novar
6890 produce multiple error messages, here: >
6891 E121: Undefined variable: novar
6892 E15: Invalid expression: novar
6893 Only the first is used for the exception value, since it is the most specific
6894 one (see |except-several-errors|). So you can catch it by >
6895 :catch /^Vim(\a\+):E121:/
6897 You can catch all errors related to the name "nofunc" by >
6898 :catch /\<nofunc\>/
6900 You can catch all Vim errors in the ":write" and ":read" commands by >
6901 :catch /^Vim(\(write\|read\)):E\d\+:/
6903 You can catch all Vim errors by the pattern >
6904 :catch /^Vim\((\a\+)\)\=:E\d\+:/
6905 <
6906 *catch-text*
6907 NOTE: You should never catch the error message text itself: >
6908 :catch /No such variable/
6909 only works in the english locale, but not when the user has selected
6910 a different language by the |:language| command. It is however helpful to
6911 cite the message text in a comment: >
6912 :catch /^Vim(\a\+):E108:/ " No such variable
6915 IGNORING ERRORS *ignore-errors*
6917 You can ignore errors in a specific Vim command by catching them locally: >
6919 :try
6920 : write
6921 :catch
6922 :endtry
6924 But you are strongly recommended NOT to use this simple form, since it could
6925 catch more than you want. With the ":write" command, some autocommands could
6926 be executed and cause errors not related to writing, for instance: >
6928 :au BufWritePre * unlet novar
6930 There could even be such errors you are not responsible for as a script
6931 writer: a user of your script might have defined such autocommands. You would
6932 then hide the error from the user.
6933 It is much better to use >
6935 :try
6936 : write
6937 :catch /^Vim(write):/
6938 :endtry
6940 which only catches real write errors. So catch only what you'd like to ignore
6941 intentionally.
6943 For a single command that does not cause execution of autocommands, you could
6944 even suppress the conversion of errors to exceptions by the ":silent!"
6945 command: >
6946 :silent! nunmap k
6947 This works also when a try conditional is active.
6950 CATCHING INTERRUPTS *catch-interrupt*
6952 When there are active try conditionals, an interrupt (CTRL-C) is converted to
6953 the exception "Vim:Interrupt". You can catch it like every exception. The
6954 script is not terminated, then.
6955 Example: >
6957 :function! TASK1()
6958 : sleep 10
6959 :endfunction
6961 :function! TASK2()
6962 : sleep 20
6963 :endfunction
6965 :while 1
6966 : let command = input("Type a command: ")
6967 : try
6968 : if command == ""
6969 : continue
6970 : elseif command == "END"
6971 : break
6972 : elseif command == "TASK1"
6973 : call TASK1()
6974 : elseif command == "TASK2"
6975 : call TASK2()
6976 : else
6977 : echo "\nIllegal command:" command
6978 : continue
6979 : endif
6980 : catch /^Vim:Interrupt$/
6981 : echo "\nCommand interrupted"
6982 : " Caught the interrupt. Continue with next prompt.
6983 : endtry
6984 :endwhile
6986 You can interrupt a task here by pressing CTRL-C; the script then asks for
6987 a new command. If you press CTRL-C at the prompt, the script is terminated.
6989 For testing what happens when CTRL-C would be pressed on a specific line in
6990 your script, use the debug mode and execute the |>quit| or |>interrupt|
6991 command on that line. See |debug-scripts|.
6994 CATCHING ALL *catch-all*
6996 The commands >
6998 :catch /.*/
6999 :catch //
7000 :catch
7002 catch everything, error exceptions, interrupt exceptions and exceptions
7003 explicitly thrown by the |:throw| command. This is useful at the top level of
7004 a script in order to catch unexpected things.
7005 Example: >
7007 :try
7008 :
7009 : " do the hard work here
7010 :
7011 :catch /MyException/
7012 :
7013 : " handle known problem
7014 :
7015 :catch /^Vim:Interrupt$/
7016 : echo "Script interrupted"
7017 :catch /.*/
7018 : echo "Internal error (" . v:exception . ")"
7019 : echo " - occurred at " . v:throwpoint
7020 :endtry
7021 :" end of script
7023 Note: Catching all might catch more things than you want. Thus, you are
7024 strongly encouraged to catch only for problems that you can really handle by
7025 specifying a pattern argument to the ":catch".
7026 Example: Catching all could make it nearly impossible to interrupt a script
7027 by pressing CTRL-C: >
7029 :while 1
7030 : try
7031 : sleep 1
7032 : catch
7033 : endtry
7034 :endwhile
7037 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
7039 Exceptions may be used during execution of autocommands. Example: >
7041 :autocmd User x try
7042 :autocmd User x throw "Oops!"
7043 :autocmd User x catch
7044 :autocmd User x echo v:exception
7045 :autocmd User x endtry
7046 :autocmd User x throw "Arrgh!"
7047 :autocmd User x echo "Should not be displayed"
7048 :
7049 :try
7050 : doautocmd User x
7051 :catch
7052 : echo v:exception
7053 :endtry
7055 This displays "Oops!" and "Arrgh!".
7057 *except-autocmd-Pre*
7058 For some commands, autocommands get executed before the main action of the
7059 command takes place. If an exception is thrown and not caught in the sequence
7060 of autocommands, the sequence and the command that caused its execution are
7061 abandoned and the exception is propagated to the caller of the command.
7062 Example: >
7064 :autocmd BufWritePre * throw "FAIL"
7065 :autocmd BufWritePre * echo "Should not be displayed"
7066 :
7067 :try
7068 : write
7069 :catch
7070 : echo "Caught:" v:exception "from" v:throwpoint
7071 :endtry
7073 Here, the ":write" command does not write the file currently being edited (as
7074 you can see by checking 'modified'), since the exception from the BufWritePre
7075 autocommand abandons the ":write". The exception is then caught and the
7076 script displays: >
7078 Caught: FAIL from BufWrite Auto commands for "*"
7079 <
7080 *except-autocmd-Post*
7081 For some commands, autocommands get executed after the main action of the
7082 command has taken place. If this main action fails and the command is inside
7083 an active try conditional, the autocommands are skipped and an error exception
7084 is thrown that can be caught by the caller of the command.
7085 Example: >
7087 :autocmd BufWritePost * echo "File successfully written!"
7088 :
7089 :try
7090 : write /i/m/p/o/s/s/i/b/l/e
7091 :catch
7092 : echo v:exception
7093 :endtry
7095 This just displays: >
7097 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
7099 If you really need to execute the autocommands even when the main action
7100 fails, trigger the event from the catch clause.
7101 Example: >
7103 :autocmd BufWritePre * set noreadonly
7104 :autocmd BufWritePost * set readonly
7105 :
7106 :try
7107 : write /i/m/p/o/s/s/i/b/l/e
7108 :catch
7109 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
7110 :endtry
7111 <
7112 You can also use ":silent!": >
7114 :let x = "ok"
7115 :let v:errmsg = ""
7116 :autocmd BufWritePost * if v:errmsg != ""
7117 :autocmd BufWritePost * let x = "after fail"
7118 :autocmd BufWritePost * endif
7119 :try
7120 : silent! write /i/m/p/o/s/s/i/b/l/e
7121 :catch
7122 :endtry
7123 :echo x
7125 This displays "after fail".
7127 If the main action of the command does not fail, exceptions from the
7128 autocommands will be catchable by the caller of the command: >
7130 :autocmd BufWritePost * throw ":-("
7131 :autocmd BufWritePost * echo "Should not be displayed"
7132 :
7133 :try
7134 : write
7135 :catch
7136 : echo v:exception
7137 :endtry
7138 <
7139 *except-autocmd-Cmd*
7140 For some commands, the normal action can be replaced by a sequence of
7141 autocommands. Exceptions from that sequence will be catchable by the caller
7142 of the command.
7143 Example: For the ":write" command, the caller cannot know whether the file
7144 had actually been written when the exception occurred. You need to tell it in
7145 some way. >
7147 :if !exists("cnt")
7148 : let cnt = 0
7149 :
7150 : autocmd BufWriteCmd * if &modified
7151 : autocmd BufWriteCmd * let cnt = cnt + 1
7152 : autocmd BufWriteCmd * if cnt % 3 == 2
7153 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7154 : autocmd BufWriteCmd * endif
7155 : autocmd BufWriteCmd * write | set nomodified
7156 : autocmd BufWriteCmd * if cnt % 3 == 0
7157 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7158 : autocmd BufWriteCmd * endif
7159 : autocmd BufWriteCmd * echo "File successfully written!"
7160 : autocmd BufWriteCmd * endif
7161 :endif
7162 :
7163 :try
7164 : write
7165 :catch /^BufWriteCmdError$/
7166 : if &modified
7167 : echo "Error on writing (file contents not changed)"
7168 : else
7169 : echo "Error after writing"
7170 : endif
7171 :catch /^Vim(write):/
7172 : echo "Error on writing"
7173 :endtry
7175 When this script is sourced several times after making changes, it displays
7176 first >
7177 File successfully written!
7178 then >
7179 Error on writing (file contents not changed)
7180 then >
7181 Error after writing
7182 etc.
7184 *except-autocmd-ill*
7185 You cannot spread a try conditional over autocommands for different events.
7186 The following code is ill-formed: >
7188 :autocmd BufWritePre * try
7189 :
7190 :autocmd BufWritePost * catch
7191 :autocmd BufWritePost * echo v:exception
7192 :autocmd BufWritePost * endtry
7193 :
7194 :write
7197 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
7199 Some programming languages allow to use hierarchies of exception classes or to
7200 pass additional information with the object of an exception class. You can do
7201 similar things in Vim.
7202 In order to throw an exception from a hierarchy, just throw the complete
7203 class name with the components separated by a colon, for instance throw the
7204 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
7205 When you want to pass additional information with your exception class, add
7206 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
7207 for an error when writing "myfile".
7208 With the appropriate patterns in the ":catch" command, you can catch for
7209 base classes or derived classes of your hierarchy. Additional information in
7210 parentheses can be cut out from |v:exception| with the ":substitute" command.
7211 Example: >
7213 :function! CheckRange(a, func)
7214 : if a:a < 0
7215 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
7216 : endif
7217 :endfunction
7218 :
7219 :function! Add(a, b)
7220 : call CheckRange(a:a, "Add")
7221 : call CheckRange(a:b, "Add")
7222 : let c = a:a + a:b
7223 : if c < 0
7224 : throw "EXCEPT:MATHERR:OVERFLOW"
7225 : endif
7226 : return c
7227 :endfunction
7228 :
7229 :function! Div(a, b)
7230 : call CheckRange(a:a, "Div")
7231 : call CheckRange(a:b, "Div")
7232 : if (a:b == 0)
7233 : throw "EXCEPT:MATHERR:ZERODIV"
7234 : endif
7235 : return a:a / a:b
7236 :endfunction
7237 :
7238 :function! Write(file)
7239 : try
7240 : execute "write" a:file
7241 : catch /^Vim(write):/
7242 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
7243 : endtry
7244 :endfunction
7245 :
7246 :try
7247 :
7248 : " something with arithmetics and I/O
7249 :
7250 :catch /^EXCEPT:MATHERR:RANGE/
7251 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
7252 : echo "Range error in" function
7253 :
7254 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
7255 : echo "Math error"
7256 :
7257 :catch /^EXCEPT:IO/
7258 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
7259 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
7260 : if file !~ '^/'
7261 : let file = dir . "/" . file
7262 : endif
7263 : echo 'I/O error for "' . file . '"'
7264 :
7265 :catch /^EXCEPT/
7266 : echo "Unspecified error"
7267 :
7268 :endtry
7270 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
7271 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
7272 exceptions with the "Vim" prefix; they are reserved for Vim.
7273 Vim error exceptions are parameterized with the name of the command that
7274 failed, if known. See |catch-errors|.
7277 PECULIARITIES
7278 *except-compat*
7279 The exception handling concept requires that the command sequence causing the
7280 exception is aborted immediately and control is transferred to finally clauses
7281 and/or a catch clause.
7283 In the Vim script language there are cases where scripts and functions
7284 continue after an error: in functions without the "abort" flag or in a command
7285 after ":silent!", control flow goes to the following line, and outside
7286 functions, control flow goes to the line following the outermost ":endwhile"
7287 or ":endif". On the other hand, errors should be catchable as exceptions
7288 (thus, requiring the immediate abortion).
7290 This problem has been solved by converting errors to exceptions and using
7291 immediate abortion (if not suppressed by ":silent!") only when a try
7292 conditional is active. This is no restriction since an (error) exception can
7293 be caught only from an active try conditional. If you want an immediate
7294 termination without catching the error, just use a try conditional without
7295 catch clause. (You can cause cleanup code being executed before termination
7296 by specifying a finally clause.)
7298 When no try conditional is active, the usual abortion and continuation
7299 behavior is used instead of immediate abortion. This ensures compatibility of
7300 scripts written for Vim 6.1 and earlier.
7302 However, when sourcing an existing script that does not use exception handling
7303 commands (or when calling one of its functions) from inside an active try
7304 conditional of a new script, you might change the control flow of the existing
7305 script on error. You get the immediate abortion on error and can catch the
7306 error in the new script. If however the sourced script suppresses error
7307 messages by using the ":silent!" command (checking for errors by testing
7308 |v:errmsg| if appropriate), its execution path is not changed. The error is
7309 not converted to an exception. (See |:silent|.) So the only remaining cause
7310 where this happens is for scripts that don't care about errors and produce
7311 error messages. You probably won't want to use such code from your new
7312 scripts.
7314 *except-syntax-err*
7315 Syntax errors in the exception handling commands are never caught by any of
7316 the ":catch" commands of the try conditional they belong to. Its finally
7317 clauses, however, is executed.
7318 Example: >
7320 :try
7321 : try
7322 : throw 4711
7323 : catch /\(/
7324 : echo "in catch with syntax error"
7325 : catch
7326 : echo "inner catch-all"
7327 : finally
7328 : echo "inner finally"
7329 : endtry
7330 :catch
7331 : echo 'outer catch-all caught "' . v:exception . '"'
7332 : finally
7333 : echo "outer finally"
7334 :endtry
7336 This displays: >
7337 inner finally
7338 outer catch-all caught "Vim(catch):E54: Unmatched \("
7339 outer finally
7340 The original exception is discarded and an error exception is raised, instead.
7342 *except-single-line*
7343 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
7344 a single line, but then syntax errors may make it difficult to recognize the
7345 "catch" line, thus you better avoid this.
7346 Example: >
7347 :try | unlet! foo # | catch | endtry
7348 raises an error exception for the trailing characters after the ":unlet!"
7349 argument, but does not see the ":catch" and ":endtry" commands, so that the
7350 error exception is discarded and the "E488: Trailing characters" message gets
7351 displayed.
7353 *except-several-errors*
7354 When several errors appear in a single command, the first error message is
7355 usually the most specific one and therefor converted to the error exception.
7356 Example: >
7357 echo novar
7358 causes >
7359 E121: Undefined variable: novar
7360 E15: Invalid expression: novar
7361 The value of the error exception inside try conditionals is: >
7362 Vim(echo):E121: Undefined variable: novar
7363 < *except-syntax-error*
7364 But when a syntax error is detected after a normal error in the same command,
7365 the syntax error is used for the exception being thrown.
7366 Example: >
7367 unlet novar #
7368 causes >
7369 E108: No such variable: "novar"
7370 E488: Trailing characters
7371 The value of the error exception inside try conditionals is: >
7372 Vim(unlet):E488: Trailing characters
7373 This is done because the syntax error might change the execution path in a way
7374 not intended by the user. Example: >
7375 try
7376 try | unlet novar # | catch | echo v:exception | endtry
7377 catch /.*/
7378 echo "outer catch:" v:exception
7379 endtry
7380 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
7381 a "E600: Missing :endtry" error message is given, see |except-single-line|.
7383 ==============================================================================
7384 9. Examples *eval-examples*
7386 Printing in Binary ~
7387 >
7388 :" The function Nr2Bin() returns the Hex string of a number.
7389 :func Nr2Bin(nr)
7390 : let n = a:nr
7391 : let r = ""
7392 : while n
7393 : let r = '01'[n % 2] . r
7394 : let n = n / 2
7395 : endwhile
7396 : return r
7397 :endfunc
7399 :" The function String2Bin() converts each character in a string to a
7400 :" binary string, separated with dashes.
7401 :func String2Bin(str)
7402 : let out = ''
7403 : for ix in range(strlen(a:str))
7404 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
7405 : endfor
7406 : return out[1:]
7407 :endfunc
7409 Example of its use: >
7410 :echo Nr2Bin(32)
7411 result: "100000" >
7412 :echo String2Bin("32")
7413 result: "110011-110010"
7416 Sorting lines ~
7418 This example sorts lines with a specific compare function. >
7420 :func SortBuffer()
7421 : let lines = getline(1, '$')
7422 : call sort(lines, function("Strcmp"))
7423 : call setline(1, lines)
7424 :endfunction
7426 As a one-liner: >
7427 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
7430 scanf() replacement ~
7431 *sscanf*
7432 There is no sscanf() function in Vim. If you need to extract parts from a
7433 line, you can use matchstr() and substitute() to do it. This example shows
7434 how to get the file name, line number and column number out of a line like
7435 "foobar.txt, 123, 45". >
7436 :" Set up the match bit
7437 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
7438 :"get the part matching the whole expression
7439 :let l = matchstr(line, mx)
7440 :"get each item out of the match
7441 :let file = substitute(l, mx, '\1', '')
7442 :let lnum = substitute(l, mx, '\2', '')
7443 :let col = substitute(l, mx, '\3', '')
7445 The input is in the variable "line", the results in the variables "file",
7446 "lnum" and "col". (idea from Michael Geddes)
7449 getting the scriptnames in a Dictionary ~
7450 *scriptnames-dictionary*
7451 The |:scriptnames| command can be used to get a list of all script files that
7452 have been sourced. There is no equivalent function or variable for this
7453 (because it's rarely needed). In case you need to manipulate the list this
7454 code can be used: >
7455 " Get the output of ":scriptnames" in the scriptnames_output variable.
7456 let scriptnames_output = ''
7457 redir => scriptnames_output
7458 silent scriptnames
7459 redir END
7461 " Split the output into lines and parse each line. Add an entry to the
7462 " "scripts" dictionary.
7463 let scripts = {}
7464 for line in split(scriptnames_output, "\n")
7465 " Only do non-blank lines.
7466 if line =~ '\S'
7467 " Get the first number in the line.
7468 let nr = matchstr(line, '\d\+')
7469 " Get the file name, remove the script number " 123: ".
7470 let name = substitute(line, '.\+:\s*', '', '')
7471 " Add an item to the Dictionary
7472 let scripts[nr] = name
7473 endif
7474 endfor
7475 unlet scriptnames_output
7477 ==============================================================================
7478 10. No +eval feature *no-eval-feature*
7480 When the |+eval| feature was disabled at compile time, none of the expression
7481 evaluation commands are available. To prevent this from causing Vim scripts
7482 to generate all kinds of errors, the ":if" and ":endif" commands are still
7483 recognized, though the argument of the ":if" and everything between the ":if"
7484 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
7485 only if the commands are at the start of the line. The ":else" command is not
7486 recognized.
7488 Example of how to avoid executing commands when the |+eval| feature is
7489 missing: >
7491 :if 1
7492 : echo "Expression evaluation is compiled in"
7493 :else
7494 : echo "You will _never_ see this message"
7495 :endif
7497 ==============================================================================
7498 11. The sandbox *eval-sandbox* *sandbox* *E48*
7500 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
7501 options are evaluated in a sandbox. This means that you are protected from
7502 these expressions having nasty side effects. This gives some safety for when
7503 these options are set from a modeline. It is also used when the command from
7504 a tags file is executed and for CTRL-R = in the command line.
7505 The sandbox is also used for the |:sandbox| command.
7507 These items are not allowed in the sandbox:
7508 - changing the buffer text
7509 - defining or changing mapping, autocommands, functions, user commands
7510 - setting certain options (see |option-summary|)
7511 - setting certain v: variables (see |v:var|) *E794*
7512 - executing a shell command
7513 - reading or writing a file
7514 - jumping to another buffer or editing a file
7515 - executing Python, Perl, etc. commands
7516 This is not guaranteed 100% secure, but it should block most attacks.
7518 *:san* *:sandbox*
7519 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
7520 option that may have been set from a modeline, e.g.
7521 'foldexpr'.
7523 *sandbox-option*
7524 A few options contain an expression. When this expression is evaluated it may
7525 have to be done in the sandbox to avoid a security risk. But the sandbox is
7526 restrictive, thus this only happens when the option was set from an insecure
7527 location. Insecure in this context are:
7528 - sourcing a .vimrc or .exrc in the current directory
7529 - while executing in the sandbox
7530 - value coming from a modeline
7532 Note that when in the sandbox and saving an option value and restoring it, the
7533 option will still be marked as it was set in the sandbox.
7535 ==============================================================================
7536 12. Textlock *textlock*
7538 In a few situations it is not allowed to change the text in the buffer, jump
7539 to another window and some other things that might confuse or break what Vim
7540 is currently doing. This mostly applies to things that happen when Vim is
7541 actually doing something else. For example, evaluating the 'balloonexpr' may
7542 happen any moment the mouse cursor is resting at some position.
7544 This is not allowed when the textlock is active:
7545 - changing the buffer text
7546 - jumping to another buffer or window
7547 - editing another file
7548 - closing a window or quitting Vim
7549 - etc.
7552 vim:tw=78:ts=8:ft=help:norl: