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