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