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