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