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