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