Mercurial > vim
annotate runtime/doc/eval.txt @ 2033:de5a43c5eedc
Update documentation files.
author | Bram Moolenaar <bram@zimbu.org> |
---|---|
date | Wed, 06 Jan 2010 20:52:26 +0100 |
parents | 6ba0265d1f1b |
children | afcf9db31561 |
rev | line source |
---|---|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1 *eval.txt* For Vim version 7.2. Last change: 2010 Jan 05 |
1621 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
7 | 5 |
6 | |
7 Expression evaluation *expression* *expr* *E15* *eval* | |
8 | |
9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
10 | |
11 Note: Expression evaluation can be disabled at compile time. If this has been | |
1621 | 12 done, the features in this document are not available. See |+eval| and |
99 | 13 |no-eval-feature|. |
7 | 14 |
85 | 15 1. Variables |variables| |
16 1.1 Variable types | |
87 | 17 1.2 Function references |Funcref| |
161 | 18 1.3 Lists |Lists| |
99 | 19 1.4 Dictionaries |Dictionaries| |
20 1.5 More about variables |more-variables| | |
85 | 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| | |
634 | 31 12. Textlock |textlock| |
7 | 32 |
33 {Vi does not have any of these commands} | |
34 | |
35 ============================================================================== | |
36 1. Variables *variables* | |
37 | |
85 | 38 1.1 Variable types ~ |
114 | 39 *E712* |
1621 | 40 There are six types of variables: |
41 | |
42 Number A 32 bit signed number. |expr-number| *Number* | |
99 | 43 Examples: -123 0x10 0177 |
44 | |
1621 | 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 | |
48 | |
99 | 49 String A NUL terminated string of 8-bit unsigned characters (bytes). |
1621 | 50 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
99 | 51 |
52 Funcref A reference to a function |Funcref|. | |
53 Example: function("strlen") | |
54 | |
55 List An ordered sequence of items |List|. | |
56 Example: [1, 2, ['a', 'b']] | |
55 | 57 |
370 | 58 Dictionary An associative, unordered array: Each entry has a key and a |
59 value. |Dictionary| | |
60 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
61 | |
55 | 62 The Number and String types are converted automatically, depending on how they |
63 are used. | |
7 | 64 |
65 Conversion from a Number to a String is by making the ASCII representation of | |
66 the Number. Examples: > | |
67 Number 123 --> String "123" | |
68 Number 0 --> String "0" | |
69 Number -1 --> String "-1" | |
70 | |
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 | |
81 | |
82 To force conversion from String to Number, add zero to it: > | |
83 :echo "0100" + 0 | |
782 | 84 < 64 ~ |
85 | |
86 To avoid a leading zero to cause octal conversion, or for using a different | |
87 base, use |str2nr()|. | |
7 | 88 |
89 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
90 | |
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") | |
153 | 96 < *E745* *E728* *E703* *E729* *E730* *E731* |
97 List, Dictionary and Funcref types are not automatically converted. | |
85 | 98 |
1621 | 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. | |
103 | |
104 *E706* *sticky-type-checking* | |
85 | 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 | |
1621 | 107 equivalent though, as well are Float and Number. Consider this sequence of |
108 commands: > | |
85 | 109 :let l = "string" |
87 | 110 :let l = 44 " changes type from String to Number |
1621 | 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! | |
85 | 114 |
115 | |
87 | 116 1.2 Function references ~ |
153 | 117 *Funcref* *E695* *E718* |
1621 | 118 A Funcref variable is obtained with the |function()| function. It can be used |
114 | 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: > | |
55 | 121 |
122 :let Fn = function("MyFunc") | |
123 :echo Fn() | |
114 | 124 < *E704* *E705* *E707* |
819 | 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. | |
85 | 127 |
114 | 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 | |
133 | |
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|. | |
136 | |
137 A Funcref can also be used with the |:call| command: > | |
138 :call Fn() | |
139 :call dict.init() | |
85 | 140 |
141 The name of the referenced function can be obtained with |string()|. > | |
119 | 142 :let func = string(Fn) |
85 | 143 |
144 You can use |call()| to invoke a Funcref and use a list variable for the | |
145 arguments: > | |
119 | 146 :let r = call(Fn, mylist) |
85 | 147 |
148 | |
87 | 149 1.3 Lists ~ |
161 | 150 *List* *Lists* *E686* |
55 | 151 A List is an ordered sequence of items. An item can be of any type. Items |
1621 | 152 can be accessed by their index number. Items can be added and removed at any |
55 | 153 position in the sequence. |
154 | |
85 | 155 |
156 List creation ~ | |
157 *E696* *E697* | |
55 | 158 A List is created with a comma separated list of items in square brackets. |
85 | 159 Examples: > |
160 :let mylist = [1, two, 3, "four"] | |
161 :let emptylist = [] | |
55 | 162 |
1621 | 163 An item can be any expression. Using a List for an item creates a |
842 | 164 List of Lists: > |
85 | 165 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 166 |
167 An extra comma after the last item is ignored. | |
168 | |
85 | 169 |
170 List index ~ | |
171 *list-index* *E684* | |
55 | 172 An item in the List can be accessed by putting the index in square brackets |
85 | 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 | |
55 | 175 :let item = mylist[2] " get the third item: 3 |
85 | 176 |
87 | 177 When the resulting item is a list this can be repeated: > |
85 | 178 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 179 < |
85 | 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. > | |
55 | 182 :let last = mylist[-1] " get the last item: "four" |
183 | |
85 | 184 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 185 is not available it returns zero or the default value you specify: > |
85 | 186 :echo get(mylist, idx) |
187 :echo get(mylist, idx, "NONE") | |
188 | |
189 | |
190 List concatenation ~ | |
191 | |
192 Two lists can be concatenated with the "+" operator: > | |
193 :let longlist = mylist + [5, 6] | |
119 | 194 :let mylist += [7, 8] |
85 | 195 |
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. | |
198 | |
199 | |
200 Sublist ~ | |
201 | |
55 | 202 A part of the List can be obtained by specifying the first and last index, |
203 separated by a colon in square brackets: > | |
85 | 204 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 205 |
206 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 207 similar to -1. > |
90 | 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 | |
85 | 211 |
842 | 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. | |
215 | |
216 If the second index is equal to or greater than the length of the list the | |
217 length minus one is used: > | |
829 | 218 :let mylist = [0, 1, 2, 3] |
219 :echo mylist[2:8] " result: [2, 3] | |
220 | |
270 | 221 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
1621 | 222 using a single letter variable before the ":". Insert a space when needed: |
270 | 223 mylist[s : e]. |
224 | |
85 | 225 |
226 List identity ~ | |
99 | 227 *list-identity* |
85 | 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 | |
114 | 235 < [1, 2, 3, 4] |
85 | 236 |
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 | |
87 | 239 a list item in the list will also change the item in the copied list: > |
85 | 240 :let aa = [[1, 'a'], 2, 3] |
241 :let bb = copy(aa) | |
114 | 242 :call add(aa, 4) |
85 | 243 :let aa[0][1] = 'aaa' |
244 :echo aa | |
114 | 245 < [[1, aaa], 2, 3, 4] > |
85 | 246 :echo bb |
114 | 247 < [[1, aaa], 2, 3] |
85 | 248 |
87 | 249 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 250 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 251 |
252 The operator "is" can be used to check if two variables refer to the same | |
114 | 253 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 254 the same value. > |
255 :let alist = [1, 2, 3] | |
256 :let blist = [1, 2, 3] | |
257 :echo alist is blist | |
114 | 258 < 0 > |
87 | 259 :echo alist == blist |
114 | 260 < 1 |
85 | 261 |
323 | 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 | |
388 | 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" | |
323 | 268 < 1 > |
388 | 269 echo [4] == ["4"] |
323 | 270 < 0 |
271 | |
388 | 272 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 273 can compare simple values this way too by putting them in a list: > |
388 | 274 |
275 :let a = 5 | |
276 :let b = "5" | |
1621 | 277 :echo a == b |
388 | 278 < 1 > |
1621 | 279 :echo [a] == [b] |
388 | 280 < 0 |
323 | 281 |
85 | 282 |
283 List unpack ~ | |
284 | |
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 | |
288 | |
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 | |
293 | |
294 This works like: > | |
295 :let var1 = mylist[0] | |
296 :let var2 = mylist[1] | |
95 | 297 :let rest = mylist[2:] |
85 | 298 |
299 Except that there is no error if there are only two items. "rest" will be an | |
300 empty list then. | |
301 | |
302 | |
303 List modification ~ | |
304 *list-modification* | |
87 | 305 To change a specific item of a list use |:let| this way: > |
85 | 306 :let list[4] = "four" |
307 :let listlist[0][3] = item | |
308 | |
87 | 309 To change part of a list you can specify the first and last item to be |
114 | 310 modified. The value must at least have the number of items in the range: > |
87 | 311 :let list[3:5] = [3, 4, 5] |
312 | |
85 | 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 | |
114 | 318 :call add(list, [1, 2]) " append a List as one new item |
85 | 319 :call extend(list, [1, 2]) " extend the list with two more items |
320 :let i = remove(list, 3) " remove item 3 | |
108 | 321 :unlet list[3] " idem |
85 | 322 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 323 :unlet list[3 : ] " idem |
114 | 324 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
325 | |
326 Changing the order of items in a list: > | |
87 | 327 :call sort(list) " sort a list alphabetically |
328 :call reverse(list) " reverse the order of items | |
329 | |
85 | 330 |
331 For loop ~ | |
332 | |
87 | 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: > | |
114 | 335 :for item in mylist |
336 : call Doit(item) | |
85 | 337 :endfor |
338 | |
339 This works like: > | |
340 :let index = 0 | |
341 :while index < len(mylist) | |
114 | 342 : let item = mylist[index] |
343 : :call Doit(item) | |
85 | 344 : let index = index + 1 |
345 :endwhile | |
346 | |
347 Note that all items in the list should be of the same type, otherwise this | |
114 | 348 results in error |E706|. To avoid this |:unlet| the variable at the end of |
87 | 349 the loop. |
85 | 350 |
95 | 351 If all you want to do is modify each item in the list then the |map()| |
114 | 352 function will be a simpler method than a for loop. |
95 | 353 |
1621 | 354 Just like the |:let| command, |:for| also accepts a list of variables. This |
85 | 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 | |
359 | |
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. | |
362 | |
114 | 363 It is also possible to put remaining items in a List variable: > |
85 | 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 | |
370 | |
371 | |
372 List functions ~ | |
114 | 373 *E714* |
85 | 374 Functions that are useful with a List: > |
87 | 375 :let r = call(funcname, list) " call a function with an argument list |
85 | 376 :if empty(list) " check if list is empty |
102 | 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 | |
87 | 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 | |
85 | 382 :let lines = getline(1, 10) " get ten text lines from buffer |
383 :call append('$', lines) " append text lines in buffer | |
95 | 384 :let list = split("a b c") " create list from items in a string |
385 :let string = join(list, ', ') " create string from list items | |
102 | 386 :let s = string(list) " String representation of list |
387 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
99 | 388 |
258 | 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, '+') | |
392 | |
99 | 393 |
394 1.4 Dictionaries ~ | |
114 | 395 *Dictionaries* *Dictionary* |
99 | 396 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 397 entry can be located with the key. The entries are stored without a specific |
398 ordering. | |
99 | 399 |
400 | |
401 Dictionary creation ~ | |
114 | 402 *E720* *E721* *E722* *E723* |
99 | 403 A Dictionary is created with a comma separated list of entries in curly |
114 | 404 braces. Each entry has a key and a value, separated by a colon. Each key can |
405 only appear once. Examples: > | |
99 | 406 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
407 :let emptydict = {} | |
114 | 408 < *E713* *E716* *E717* |
99 | 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 | |
1621 | 411 entry. Note that the String '04' and the Number 04 are different, since the |
114 | 412 Number will be converted to the String '4'. |
413 | |
1621 | 414 A value can be any expression. Using a Dictionary for a value creates a |
99 | 415 nested Dictionary: > |
416 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
417 | |
418 An extra comma after the last entry is ignored. | |
419 | |
420 | |
421 Accessing entries ~ | |
422 | |
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 | |
426 | |
114 | 427 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 428 |
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 | |
433 | |
434 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
435 key lookup can be repeated: > | |
114 | 436 :echo dict.key[idx].key |
99 | 437 |
438 | |
439 Dictionary to List conversion ~ | |
440 | |
1621 | 441 You may want to loop over the entries in a dictionary. For this you need to |
99 | 442 turn the Dictionary into a List and pass it to |:for|. |
443 | |
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 | |
448 | |
449 The List of keys is unsorted. You may want to sort them first: > | |
450 :for key in sort(keys(mydict)) | |
451 | |
452 To loop over the values use the |values()| function: > | |
453 :for v in values(mydict) | |
454 : echo "value: " . v | |
455 :endfor | |
456 | |
457 If you want both the key and the value use the |items()| function. It returns | |
1621 | 458 a List in which each item is a List with two items, the key and the value: > |
1156 | 459 :for [key, value] in items(mydict) |
460 : echo key . ': ' . value | |
99 | 461 :endfor |
462 | |
463 | |
464 Dictionary identity ~ | |
161 | 465 *dict-identity* |
99 | 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 | |
474 | |
327 | 475 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
476 more info see |list-identity|. | |
99 | 477 |
478 | |
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 | |
485 | |
108 | 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'] | |
99 | 491 |
492 Merging a Dictionary with another is done with |extend()|: > | |
114 | 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. | |
119 | 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. | |
99 | 499 |
500 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 501 :call filter(dict, 'v:val =~ "x"') |
114 | 502 This removes all entries from "dict" with a value not matching 'x'. |
102 | 503 |
504 | |
505 Dictionary function ~ | |
114 | 506 *Dictionary-function* *self* *E725* |
102 | 507 When a function is defined with the "dict" attribute it can be used in a |
1621 | 508 special way with a dictionary. Example: > |
102 | 509 :function Mylen() dict |
114 | 510 : return len(self.data) |
102 | 511 :endfunction |
114 | 512 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
513 :echo mydict.len() | |
102 | 514 |
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. | |
518 | |
114 | 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. | |
521 | |
819 | 522 *numbered-function* *anonymous-function* |
102 | 523 To avoid the extra name for the function it can be defined and directly |
524 assigned to a Dictionary in this way: > | |
114 | 525 :let mydict = {'data': [0, 1, 2, 3]} |
526 :function mydict.len() dict | |
527 : return len(self.data) | |
102 | 528 :endfunction |
114 | 529 :echo mydict.len() |
530 | |
531 The function will then get a number and the value of dict.len is a |Funcref| | |
1621 | 532 that references this function. The function can only be used through a |
114 | 533 |Funcref|. It will automatically be deleted when there is no |Funcref| |
534 remaining that refers to it. | |
535 | |
536 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 537 |
538 | |
539 Functions for Dictionaries ~ | |
114 | 540 *E715* |
541 Functions that can be used with a Dictionary: > | |
102 | 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 | |
99 | 550 |
551 | |
552 1.5 More about variables ~ | |
85 | 553 *more-variables* |
7 | 554 If you need to know the type of a variable or expression, use the |type()| |
555 function. | |
556 | |
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|. | |
560 | |
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|. | |
564 | |
565 variable name can be stored where ~ | |
566 my_var_6 not | |
567 My_Var_6 session file | |
568 MY_VAR_6 viminfo file | |
569 | |
570 | |
571 It's possible to form a variable name with curly braces, see | |
572 |curly-braces-names|. | |
573 | |
574 ============================================================================== | |
575 2. Expression syntax *expression-syntax* | |
576 | |
577 Expression syntax summary, from least to most significant: | |
578 | |
579 |expr1| expr2 ? expr1 : expr1 if-then-else | |
580 | |
581 |expr2| expr3 || expr3 .. logical OR | |
582 | |
583 |expr3| expr4 && expr4 .. logical AND | |
584 | |
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 | |
593 | |
594 expr5 ==? expr5 equal, ignoring case | |
595 expr5 ==# expr5 equal, match case | |
596 etc. As above, append ? for ignoring case, # for | |
597 matching case | |
598 | |
685 | 599 expr5 is expr5 same |List| instance |
600 expr5 isnot expr5 different |List| instance | |
79 | 601 |
602 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 603 expr6 - expr6 .. number subtraction |
604 expr6 . expr6 .. string concatenation | |
605 | |
606 |expr6| expr7 * expr7 .. number multiplication | |
607 expr7 / expr7 .. number division | |
608 expr7 % expr7 .. number modulo | |
609 | |
610 |expr7| ! expr7 logical NOT | |
611 - expr7 unary minus | |
612 + expr7 unary plus | |
102 | 613 |
614 | |
685 | 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 | |
102 | 619 |
620 |expr9| number number constant | |
26 | 621 "string" string constant, backslash is special |
99 | 622 'string' string constant, ' is doubled |
685 | 623 [expr1, ...] |List| |
624 {expr1: expr1, ...} |Dictionary| | |
7 | 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 | |
633 | |
634 | |
635 ".." indicates that the operations in this level can be concatenated. | |
636 Example: > | |
637 &nu || &list && &shell == "csh" | |
638 | |
639 All expressions within one level are parsed from left to right. | |
640 | |
641 | |
642 expr1 *expr1* *E109* | |
643 ----- | |
644 | |
645 expr2 ? expr1 : expr1 | |
646 | |
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 | |
652 | |
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 | |
657 | |
658 To keep this readable, using |line-continuation| is suggested: > | |
659 :echo lnum == 1 | |
660 :\ ? "top" | |
661 :\ : lnum == 1000 | |
662 :\ ? "last" | |
663 :\ : lnum | |
664 | |
1156 | 665 You should always put a space before the ':', otherwise it can be mistaken for |
666 use in a variable such as "a:1". | |
667 | |
7 | 668 |
669 expr2 and expr3 *expr2* *expr3* | |
670 --------------- | |
671 | |
672 *expr-barbar* *expr-&&* | |
673 The "||" and "&&" operators take one argument on each side. The arguments | |
674 are (converted to) Numbers. The result is: | |
675 | |
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 | |
682 | |
683 The operators can be concatenated, for example: > | |
684 | |
685 &nu || &list && &shell == "csh" | |
686 | |
687 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
688 | |
689 &nu || (&list && &shell == "csh") | |
690 | |
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: > | |
693 | |
694 let a = 1 | |
695 echo a || b | |
696 | |
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: > | |
699 | |
700 echo exists("b") && b == "yes" | |
701 | |
702 This is valid whether "b" has been defined or not. The second clause will | |
703 only be evaluated if "b" has been defined. | |
704 | |
705 | |
706 expr4 *expr4* | |
707 ----- | |
708 | |
709 expr5 {cmp} expr5 | |
710 | |
711 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
712 if it evaluates to true. | |
713 | |
1621 | 714 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 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-!~?* | |
79 | 720 *expr-is* |
7 | 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 !~ !~# !~? | |
79 | 730 same instance is |
731 different instance isnot | |
7 | 732 |
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 | |
737 | |
85 | 738 *E691* *E692* |
685 | 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. | |
79 | 742 |
114 | 743 *E735* *E736* |
685 | 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| | |
114 | 746 recursively. Ignoring case means case is ignored when comparing item values. |
747 | |
85 | 748 *E693* *E694* |
685 | 749 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
750 equal" can be used. Case is never ignored. | |
751 | |
752 When using "is" or "isnot" with a |List| this checks if the expressions are | |
1621 | 753 referring to the same |List| instance. A copy of a |List| is different from |
685 | 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 | |
1621 | 756 different type means the values are different. "4 == '4'" is true, "4 is '4'" |
79 | 757 is false. |
758 | |
7 | 759 When comparing a String with a Number, the String is converted to a Number, |
1621 | 760 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
7 | 761 because 'x' converted to a Number is zero. |
762 | |
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. | |
766 | |
1621 | 767 When using the operators with a trailing '#', or the short version and |
1156 | 768 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 769 |
770 When using the operators with a trailing '?', or the short version and | |
1156 | 771 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
772 | |
773 'smartcase' is not used. | |
7 | 774 |
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 | |
786 | |
787 | |
788 expr5 and expr6 *expr5* *expr6* | |
789 --------------- | |
685 | 790 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 791 expr6 - expr6 .. Number subtraction *expr--* |
792 expr6 . expr6 .. String concatenation *expr-.* | |
793 | |
692 | 794 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 795 result is a new list with the two lists Concatenated. |
79 | 796 |
797 expr7 * expr7 .. number multiplication *expr-star* | |
798 expr7 / expr7 .. number division *expr-/* | |
799 expr7 % expr7 .. number modulo *expr-%* | |
7 | 800 |
801 For all, except ".", Strings are converted to Numbers. | |
802 | |
803 Note the difference between "+" and ".": | |
804 "123" + "456" = 579 | |
805 "123" . "456" = "123456" | |
806 | |
1621 | 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. | |
818 | |
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) | |
824 | |
7 | 825 When the righthand side of '%' is zero, the result is 0. |
826 | |
685 | 827 None of these work for |Funcref|s. |
79 | 828 |
1621 | 829 . and % do not work for Float. *E804* |
830 | |
7 | 831 |
832 expr7 *expr7* | |
833 ----- | |
834 ! expr7 logical NOT *expr-!* | |
835 - expr7 unary minus *expr-unary--* | |
836 + expr7 unary plus *expr-unary-+* | |
837 | |
838 For '!' non-zero becomes zero, zero becomes one. | |
839 For '-' the sign of the number is changed. | |
840 For '+' the number is unchanged. | |
841 | |
842 A String will be converted to a Number first. | |
843 | |
1621 | 844 These three can be repeated and mixed. Examples: |
7 | 845 !-1 == 0 |
846 !!8 == 1 | |
847 --9 == 9 | |
848 | |
849 | |
850 expr8 *expr8* | |
851 ----- | |
685 | 852 expr8[expr1] item of String or |List| *expr-[]* *E111* |
102 | 853 |
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 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
856 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
857 an alternative. |
55 | 858 |
859 Index zero gives the first character. This is like it works in C. Careful: | |
860 text column numbers start with one! Example, to get the character under the | |
861 cursor: > | |
823 | 862 :let c = getline(".")[col(".") - 1] |
7 | 863 |
864 If the length of the String is less than the index, the result is an empty | |
55 | 865 String. A negative index always results in an empty string (reason: backwards |
866 compatibility). Use [-1:] to get the last byte. | |
867 | |
685 | 868 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 869 for possible index values. If the index is out of range this results in an |
1621 | 870 error. Example: > |
55 | 871 :let item = mylist[-1] " get last item |
872 | |
685 | 873 Generally, if a |List| index is equal to or higher than the length of the |
874 |List|, or more negative than the length of the |List|, this results in an | |
875 error. | |
55 | 876 |
99 | 877 |
102 | 878 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
879 | |
880 If expr8 is a Number or String this results in the substring with the bytes | |
881 from expr1a to and including expr1b. expr8 is used as a String, expr1a and | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
882 expr1b are used as a Number. This doesn't recognize multi-byte encodings, see |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
883 |byteidx()| for computing the indexes. |
55 | 884 |
885 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
886 string minus one is used. | |
887 | |
888 A negative number can be used to measure from the end of the string. -1 is | |
889 the last character, -2 the last but one, etc. | |
890 | |
891 If an index goes out of range for the string characters are omitted. If | |
892 expr1b is smaller than expr1a the result is an empty string. | |
893 | |
894 Examples: > | |
895 :let c = name[-1:] " last byte of a string | |
896 :let c = name[-2:-2] " last but one byte of a string | |
897 :let s = line(".")[4:] " from the fifth byte to the end | |
898 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
899 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
900 *sublist* *slice* |
685 | 901 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 902 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 903 just above, except that indexes out of range cause an error. Examples: > |
55 | 904 :let l = mylist[:3] " first four items |
905 :let l = mylist[4:4] " List with one item | |
906 :let l = mylist[:] " shallow copy of a List | |
907 | |
685 | 908 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
909 error. | |
910 | |
911 | |
912 expr8.name entry in a |Dictionary| *expr-entry* | |
913 | |
914 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
915 name will be used as a key in the |Dictionary|. This is just like: | |
916 expr8[name]. | |
99 | 917 |
918 The name must consist of alphanumeric characters, just like a variable name, | |
919 but it may start with a number. Curly braces cannot be used. | |
920 | |
921 There must not be white space before or after the dot. | |
922 | |
923 Examples: > | |
924 :let dict = {"one": 1, 2: "two"} | |
925 :echo dict.one | |
926 :echo dict .2 | |
927 | |
928 Note that the dot is also used for String concatenation. To avoid confusion | |
929 always put spaces around the dot for String concatenation. | |
930 | |
931 | |
685 | 932 expr8(expr1, ...) |Funcref| function call |
102 | 933 |
934 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
935 | |
936 | |
937 | |
938 *expr9* | |
7 | 939 number |
940 ------ | |
941 number number constant *expr-number* | |
942 | |
943 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
944 | |
1621 | 945 *floating-point-format* |
946 Floating point numbers can be written in two forms: | |
947 | |
948 [-+]{N}.{M} | |
949 [-+]{N}.{M}e[-+]{exp} | |
950 | |
951 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
952 contain digits. | |
953 [-+] means there is an optional plus or minus sign. | |
954 {exp} is the exponent, power of 10. | |
955 Only a decimal point is accepted, not a comma. No matter what the current | |
956 locale is. | |
957 {only when compiled with the |+float| feature} | |
958 | |
959 Examples: | |
960 123.456 | |
961 +0.0001 | |
962 55.0 | |
963 -0.123 | |
964 1.234e03 | |
965 1.0E-6 | |
966 -3.1416e+88 | |
967 | |
968 These are INVALID: | |
969 3. empty {M} | |
970 1e40 missing .{M} | |
971 | |
1698 | 972 *float-pi* *float-e* |
973 A few useful values to copy&paste: > | |
974 :let pi = 3.14159265359 | |
975 :let e = 2.71828182846 | |
976 | |
1621 | 977 Rationale: |
978 Before floating point was introduced, the text "123.456" was interpreted as | |
979 the two numbers "123" and "456", both converted to a string and concatenated, | |
980 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 981 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 982 incompatibility was accepted in favor of being able to use the normal notation |
983 for floating point numbers. | |
984 | |
985 *floating-point-precision* | |
986 The precision and range of floating points numbers depends on what "double" | |
987 means in the library Vim was compiled with. There is no way to change this at | |
988 runtime. | |
989 | |
990 The default for displaying a |Float| is to use 6 decimal places, like using | |
991 printf("%g", f). You can select something else when using the |printf()| | |
992 function. Example: > | |
993 :echo printf('%.15e', atan(1)) | |
994 < 7.853981633974483e-01 | |
995 | |
996 | |
7 | 997 |
998 string *expr-string* *E114* | |
999 ------ | |
1000 "string" string constant *expr-quote* | |
1001 | |
1002 Note that double quotes are used. | |
1003 | |
1004 A string constant accepts these special characters: | |
1005 \... three-digit octal number (e.g., "\316") | |
1006 \.. two-digit octal number (must be followed by non-digit) | |
1007 \. one-digit octal number (must be followed by non-digit) | |
1008 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1009 \x. byte specified with one hex number (must be followed by non-hex char) | |
1010 \X.. same as \x.. | |
1011 \X. same as \x. | |
1621 | 1012 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1013 current value of 'encoding' (e.g., "\u02a4") |
1014 \U.... same as \u.... | |
1015 \b backspace <BS> | |
1016 \e escape <Esc> | |
1017 \f formfeed <FF> | |
1018 \n newline <NL> | |
1019 \r return <CR> | |
1020 \t tab <Tab> | |
1021 \\ backslash | |
1022 \" double quote | |
1023 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. | |
1024 | |
1156 | 1025 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1026 encodings. Use "\u00ff" to store character 255 according to the current value | |
1027 of 'encoding'. | |
1028 | |
7 | 1029 Note that "\000" and "\x00" force the end of the string. |
1030 | |
1031 | |
1032 literal-string *literal-string* *E115* | |
1033 --------------- | |
26 | 1034 'string' string constant *expr-'* |
7 | 1035 |
1036 Note that single quotes are used. | |
1037 | |
1621 | 1038 This string is taken as it is. No backslashes are removed or have a special |
99 | 1039 meaning. The only exception is that two quotes stand for one quote. |
26 | 1040 |
1041 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1042 to be doubled. These two commands are equivalent: > |
26 | 1043 if a =~ "\\s*" |
1044 if a =~ '\s*' | |
7 | 1045 |
1046 | |
1047 option *expr-option* *E112* *E113* | |
1048 ------ | |
1049 &option option value, local value if possible | |
1050 &g:option global option value | |
1051 &l:option local option value | |
1052 | |
1053 Examples: > | |
1054 echo "tabstop is " . &tabstop | |
1055 if &insertmode | |
1056 | |
1057 Any option name can be used here. See |options|. When using the local value | |
1058 and there is no buffer-local or window-local value, the global value is used | |
1059 anyway. | |
1060 | |
1061 | |
1156 | 1062 register *expr-register* *@r* |
7 | 1063 -------- |
1064 @r contents of register 'r' | |
1065 | |
1066 The result is the contents of the named register, as a single string. | |
1067 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1068 register use @" or @@. See |registers| for an explanation of the available |
336 | 1069 registers. |
1070 | |
1071 When using the '=' register you get the expression itself, not what it | |
1072 evaluates to. Use |eval()| to evaluate it. | |
7 | 1073 |
1074 | |
1075 nesting *expr-nesting* *E110* | |
1076 ------- | |
1077 (expr1) nested expression | |
1078 | |
1079 | |
1080 environment variable *expr-env* | |
1081 -------------------- | |
1082 $VAR environment variable | |
1083 | |
1084 The String value of any environment variable. When it is not defined, the | |
1085 result is an empty string. | |
1086 *expr-env-expand* | |
1087 Note that there is a difference between using $VAR directly and using | |
1088 expand("$VAR"). Using it directly will only expand environment variables that | |
1089 are known inside the current Vim session. Using expand() will first try using | |
1090 the environment variables known inside the current Vim session. If that | |
1091 fails, a shell will be used to expand the variable. This can be slow, but it | |
1092 does expand all variables that the shell knows about. Example: > | |
1093 :echo $version | |
1094 :echo expand("$version") | |
1095 The first one probably doesn't echo anything, the second echoes the $version | |
1096 variable (if your shell supports it). | |
1097 | |
1098 | |
1099 internal variable *expr-variable* | |
1100 ----------------- | |
1101 variable internal variable | |
1102 See below |internal-variables|. | |
1103 | |
1104 | |
170 | 1105 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1106 ------------- |
1107 function(expr1, ...) function call | |
1108 See below |functions|. | |
1109 | |
1110 | |
1111 ============================================================================== | |
1112 3. Internal variable *internal-variables* *E121* | |
1113 *E461* | |
1114 An internal variable name can be made up of letters, digits and '_'. But it | |
1115 cannot start with a digit. It's also possible to use curly braces, see | |
1116 |curly-braces-names|. | |
1117 | |
1118 An internal variable is created with the ":let" command |:let|. | |
87 | 1119 An internal variable is explicitly destroyed with the ":unlet" command |
1120 |:unlet|. | |
1121 Using a name that is not an internal variable or refers to a variable that has | |
1122 been destroyed results in an error. | |
7 | 1123 |
1124 There are several name spaces for variables. Which one is to be used is | |
1125 specified by what is prepended: | |
1126 | |
1127 (nothing) In a function: local to a function; otherwise: global | |
1128 |buffer-variable| b: Local to the current buffer. | |
1129 |window-variable| w: Local to the current window. | |
819 | 1130 |tabpage-variable| t: Local to the current tab page. |
7 | 1131 |global-variable| g: Global. |
1132 |local-variable| l: Local to a function. | |
1133 |script-variable| s: Local to a |:source|'ed Vim script. | |
1134 |function-argument| a: Function argument (only inside a function). | |
1621 | 1135 |vim-variable| v: Global, predefined by Vim. |
7 | 1136 |
685 | 1137 The scope name by itself can be used as a |Dictionary|. For example, to |
1138 delete all script-local variables: > | |
133 | 1139 :for k in keys(s:) |
1140 : unlet s:[k] | |
1141 :endfor | |
1142 < | |
7 | 1143 *buffer-variable* *b:var* |
1144 A variable name that is preceded with "b:" is local to the current buffer. | |
1145 Thus you can have several "b:foo" variables, one for each buffer. | |
1146 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1147 |:bdelete|. | |
1148 | |
1149 One local buffer variable is predefined: | |
1150 *b:changedtick-variable* *changetick* | |
1151 b:changedtick The total number of changes to the current buffer. It is | |
1152 incremented for each change. An undo command is also a change | |
1153 in this case. This can be used to perform an action only when | |
1154 the buffer has changed. Example: > | |
1155 :if my_changedtick != b:changedtick | |
1621 | 1156 : let my_changedtick = b:changedtick |
1157 : call My_Update() | |
7 | 1158 :endif |
1159 < | |
1160 *window-variable* *w:var* | |
1161 A variable name that is preceded with "w:" is local to the current window. It | |
1162 is deleted when the window is closed. | |
1163 | |
819 | 1164 *tabpage-variable* *t:var* |
1165 A variable name that is preceded with "t:" is local to the current tab page, | |
1166 It is deleted when the tab page is closed. {not available when compiled | |
1167 without the +windows feature} | |
1168 | |
7 | 1169 *global-variable* *g:var* |
1170 Inside functions global variables are accessed with "g:". Omitting this will | |
1621 | 1171 access a variable local to a function. But "g:" can also be used in any other |
7 | 1172 place if you like. |
1173 | |
1174 *local-variable* *l:var* | |
1175 Inside functions local variables are accessed without prepending anything. | |
1156 | 1176 But you can also prepend "l:" if you like. However, without prepending "l:" |
1177 you may run into reserved variable names. For example "count". By itself it | |
1178 refers to "v:count". Using "l:count" you can have a local variable with the | |
1179 same name. | |
7 | 1180 |
1181 *script-variable* *s:var* | |
1182 In a Vim script variables starting with "s:" can be used. They cannot be | |
1183 accessed from outside of the scripts, thus are local to the script. | |
1184 | |
1185 They can be used in: | |
1186 - commands executed while the script is sourced | |
1187 - functions defined in the script | |
1188 - autocommands defined in the script | |
1189 - functions and autocommands defined in functions and autocommands which were | |
1190 defined in the script (recursively) | |
1191 - user defined commands defined in the script | |
1192 Thus not in: | |
1193 - other scripts sourced from this one | |
1194 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1195 - menus |
7 | 1196 - etc. |
1197 | |
1156 | 1198 Script variables can be used to avoid conflicts with global variable names. |
1199 Take this example: > | |
7 | 1200 |
1201 let s:counter = 0 | |
1202 function MyCounter() | |
1203 let s:counter = s:counter + 1 | |
1204 echo s:counter | |
1205 endfunction | |
1206 command Tick call MyCounter() | |
1207 | |
1208 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1209 that script will not be changed, only the "s:counter" in the script where | |
1210 "Tick" was defined is used. | |
1211 | |
1212 Another example that does the same: > | |
1213 | |
1214 let s:counter = 0 | |
1215 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1216 | |
1217 When calling a function and invoking a user-defined command, the context for | |
9 | 1218 script variables is set to the script where the function or command was |
7 | 1219 defined. |
1220 | |
1221 The script variables are also available when a function is defined inside a | |
1222 function that is defined in a script. Example: > | |
1223 | |
1224 let s:counter = 0 | |
1225 function StartCounting(incr) | |
1226 if a:incr | |
1227 function MyCounter() | |
1228 let s:counter = s:counter + 1 | |
1229 endfunction | |
1230 else | |
1231 function MyCounter() | |
1232 let s:counter = s:counter - 1 | |
1233 endfunction | |
1234 endif | |
1235 endfunction | |
1236 | |
1237 This defines the MyCounter() function either for counting up or counting down | |
1238 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1239 called, the s:counter variable will be accessible in MyCounter(). | |
1240 | |
1241 When the same script is sourced again it will use the same script variables. | |
1242 They will remain valid as long as Vim is running. This can be used to | |
1243 maintain a counter: > | |
1244 | |
1245 if !exists("s:counter") | |
1246 let s:counter = 1 | |
1247 echo "script executed for the first time" | |
1248 else | |
1249 let s:counter = s:counter + 1 | |
1250 echo "script executed " . s:counter . " times now" | |
1251 endif | |
1252 | |
1253 Note that this means that filetype plugins don't get a different set of script | |
1254 variables for each buffer. Use local buffer variables instead |b:var|. | |
1255 | |
1256 | |
1257 Predefined Vim variables: *vim-variable* *v:var* | |
1258 | |
189 | 1259 *v:beval_col* *beval_col-variable* |
1260 v:beval_col The number of the column, over which the mouse pointer is. | |
1261 This is the byte index in the |v:beval_lnum| line. | |
1262 Only valid while evaluating the 'balloonexpr' option. | |
1263 | |
1264 *v:beval_bufnr* *beval_bufnr-variable* | |
1265 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1266 valid while evaluating the 'balloonexpr' option. | |
1267 | |
1268 *v:beval_lnum* *beval_lnum-variable* | |
1269 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1270 valid while evaluating the 'balloonexpr' option. | |
1271 | |
1272 *v:beval_text* *beval_text-variable* | |
374 | 1273 v:beval_text The text under or after the mouse pointer. Usually a word as |
1274 it is useful for debugging a C program. 'iskeyword' applies, | |
1275 but a dot and "->" before the position is included. When on a | |
1276 ']' the text before it is used, including the matching '[' and | |
189 | 1277 word before it. When on a Visual area within one line the |
1278 highlighted text is used. | |
1279 Only valid while evaluating the 'balloonexpr' option. | |
1280 | |
1281 *v:beval_winnr* *beval_winnr-variable* | |
1282 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
1283 valid while evaluating the 'balloonexpr' option. | |
1284 | |
844 | 1285 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1286 v:char Argument for evaluating 'formatexpr' and used for the typed |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1287 character when using <expr> in an abbreviation |map-<expr>|. |
844 | 1288 |
7 | 1289 *v:charconvert_from* *charconvert_from-variable* |
1290 v:charconvert_from | |
1291 The name of the character encoding of a file to be converted. | |
1292 Only valid while evaluating the 'charconvert' option. | |
1293 | |
1294 *v:charconvert_to* *charconvert_to-variable* | |
1295 v:charconvert_to | |
1296 The name of the character encoding of a file after conversion. | |
1297 Only valid while evaluating the 'charconvert' option. | |
1298 | |
1299 *v:cmdarg* *cmdarg-variable* | |
1300 v:cmdarg This variable is used for two purposes: | |
1301 1. The extra arguments given to a file read/write command. | |
1302 Currently these are "++enc=" and "++ff=". This variable is | |
1303 set before an autocommand event for a file read/write | |
1304 command is triggered. There is a leading space to make it | |
1305 possible to append this variable directly after the | |
1621 | 1306 read/write command. Note: The "+cmd" argument isn't |
7 | 1307 included here, because it will be executed anyway. |
1308 2. When printing a PostScript file with ":hardcopy" this is | |
1309 the argument for the ":hardcopy" command. This can be used | |
1310 in 'printexpr'. | |
1311 | |
1312 *v:cmdbang* *cmdbang-variable* | |
1313 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1314 was used the value is 1, otherwise it is 0. Note that this | |
1315 can only be used in autocommands. For user commands |<bang>| | |
1316 can be used. | |
1317 | |
1318 *v:count* *count-variable* | |
1319 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1320 to get the count before a mapping. Read-only. Example: > |
7 | 1321 :map _x :<C-U>echo "the count is " . v:count<CR> |
1322 < Note: The <C-U> is required to remove the line range that you | |
1323 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1324 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1325 just like what happens in the command, "d6w" for the example. |
667 | 1326 Also used for evaluating the 'formatexpr' option. |
7 | 1327 "count" also works, for backwards compatibility. |
1328 | |
1329 *v:count1* *count1-variable* | |
1330 v:count1 Just like "v:count", but defaults to one when no count is | |
1331 used. | |
1332 | |
1333 *v:ctype* *ctype-variable* | |
1334 v:ctype The current locale setting for characters of the runtime | |
1335 environment. This allows Vim scripts to be aware of the | |
1336 current locale encoding. Technical: it's the value of | |
1337 LC_CTYPE. When not using a locale the value is "C". | |
1338 This variable can not be set directly, use the |:language| | |
1339 command. | |
1340 See |multi-lang|. | |
1341 | |
1342 *v:dying* *dying-variable* | |
1621 | 1343 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1344 one. When multiple signals are caught the number increases. |
1345 Can be used in an autocommand to check if Vim didn't | |
1346 terminate normally. {only works on Unix} | |
1347 Example: > | |
1348 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif | |
1349 < | |
1350 *v:errmsg* *errmsg-variable* | |
1351 v:errmsg Last given error message. It's allowed to set this variable. | |
1352 Example: > | |
1353 :let v:errmsg = "" | |
1354 :silent! next | |
1355 :if v:errmsg != "" | |
1356 : ... handle error | |
1357 < "errmsg" also works, for backwards compatibility. | |
1358 | |
1359 *v:exception* *exception-variable* | |
1360 v:exception The value of the exception most recently caught and not | |
1361 finished. See also |v:throwpoint| and |throw-variables|. | |
1362 Example: > | |
1363 :try | |
1364 : throw "oops" | |
1365 :catch /.*/ | |
1366 : echo "caught" v:exception | |
1367 :endtry | |
1368 < Output: "caught oops". | |
1369 | |
179 | 1370 *v:fcs_reason* *fcs_reason-variable* |
1371 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1372 Can be used in an autocommand to decide what to do and/or what | |
1373 to set v:fcs_choice to. Possible values: | |
1374 deleted file no longer exists | |
1375 conflict file contents, mode or timestamp was | |
1376 changed and buffer is modified | |
1377 changed file contents has changed | |
1378 mode mode of file changed | |
1379 time only file timestamp changed | |
1380 | |
1381 *v:fcs_choice* *fcs_choice-variable* | |
1382 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1383 triggered. Can be used in an autocommand to tell Vim what to | |
1384 do with the affected buffer: | |
1385 reload Reload the buffer (does not work if | |
1386 the file was deleted). | |
1387 ask Ask the user what to do, as if there | |
1388 was no autocommand. Except that when | |
1389 only the timestamp changed nothing | |
1390 will happen. | |
1391 <empty> Nothing, the autocommand should do | |
1392 everything that needs to be done. | |
1393 The default is empty. If another (invalid) value is used then | |
1394 Vim behaves like it is empty, there is no warning message. | |
1395 | |
7 | 1396 *v:fname_in* *fname_in-variable* |
579 | 1397 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1398 option used for ~ |
1399 'charconvert' file to be converted | |
1400 'diffexpr' original file | |
1401 'patchexpr' original file | |
1402 'printexpr' file to be printed | |
593 | 1403 And set to the swap file name for |SwapExists|. |
7 | 1404 |
1405 *v:fname_out* *fname_out-variable* | |
1406 v:fname_out The name of the output file. Only valid while | |
1407 evaluating: | |
1408 option used for ~ | |
1409 'charconvert' resulting converted file (*) | |
1410 'diffexpr' output of diff | |
1411 'patchexpr' resulting patched file | |
1412 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1413 file") it will be equal to v:fname_in. When doing conversion |
7 | 1414 for a read command (e.g., ":e file") it will be a temporary |
1415 file and different from v:fname_in. | |
1416 | |
1417 *v:fname_new* *fname_new-variable* | |
1418 v:fname_new The name of the new version of the file. Only valid while | |
1419 evaluating 'diffexpr'. | |
1420 | |
1421 *v:fname_diff* *fname_diff-variable* | |
1422 v:fname_diff The name of the diff (patch) file. Only valid while | |
1423 evaluating 'patchexpr'. | |
1424 | |
1425 *v:folddashes* *folddashes-variable* | |
1426 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1427 fold. | |
29 | 1428 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1429 |
1430 *v:foldlevel* *foldlevel-variable* | |
1431 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1432 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1433 |
1434 *v:foldend* *foldend-variable* | |
1435 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1436 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1437 |
1438 *v:foldstart* *foldstart-variable* | |
1439 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1440 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1441 |
11 | 1442 *v:insertmode* *insertmode-variable* |
1443 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1444 events. Values: | |
1445 i Insert mode | |
1446 r Replace mode | |
1447 v Virtual Replace mode | |
1448 | |
102 | 1449 *v:key* *key-variable* |
685 | 1450 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1451 evaluating the expression used with |map()| and |filter()|. |
1452 Read-only. | |
1453 | |
7 | 1454 *v:lang* *lang-variable* |
1455 v:lang The current locale setting for messages of the runtime | |
1456 environment. This allows Vim scripts to be aware of the | |
1457 current language. Technical: it's the value of LC_MESSAGES. | |
1458 The value is system dependent. | |
1459 This variable can not be set directly, use the |:language| | |
1460 command. | |
1461 It can be different from |v:ctype| when messages are desired | |
1462 in a different language than what is used for character | |
1463 encoding. See |multi-lang|. | |
1464 | |
1465 *v:lc_time* *lc_time-variable* | |
1466 v:lc_time The current locale setting for time messages of the runtime | |
1467 environment. This allows Vim scripts to be aware of the | |
1468 current language. Technical: it's the value of LC_TIME. | |
1469 This variable can not be set directly, use the |:language| | |
1470 command. See |multi-lang|. | |
1471 | |
1472 *v:lnum* *lnum-variable* | |
29 | 1473 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr' |
839 | 1474 expressions, tab page number for 'guitablabel' and |
1475 'guitabtooltip'. Only valid while one of these expressions is | |
1476 being evaluated. Read-only when in the |sandbox|. | |
7 | 1477 |
1029 | 1478 *v:mouse_win* *mouse_win-variable* |
1479 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1480 First window has number 1, like with |winnr()|. The value is | |
1481 zero when there was no mouse button click. | |
1482 | |
1483 *v:mouse_lnum* *mouse_lnum-variable* | |
1484 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1485 This is the text line number, not the screen line number. The | |
1486 value is zero when there was no mouse button click. | |
1487 | |
1488 *v:mouse_col* *mouse_col-variable* | |
1489 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1490 This is the screen column number, like with |virtcol()|. The | |
1491 value is zero when there was no mouse button click. | |
1492 | |
1733 | 1493 *v:oldfiles* *oldfiles-variable* |
1494 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1495 startup. These are the files that Vim remembers marks for. | |
1496 The length of the List is limited by the ' argument of the | |
1497 'viminfo' option (default is 100). | |
1498 Also see |:oldfiles| and |c_#<|. | |
1499 The List can be modified, but this has no effect on what is | |
1500 stored in the |viminfo| file later. If you use values other | |
1501 than String this will cause trouble. | |
1502 {only when compiled with the +viminfo feature} | |
1503 | |
1490 | 1504 *v:operator* *operator-variable* |
1505 v:operator The last operator given in Normal mode. This is a single | |
1506 character except for commands starting with <g> or <z>, | |
1507 in which case it is two characters. Best used alongside | |
1508 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1509 Operator-pending mode and then use the operator, e.g.: > | |
1510 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1511 < The value remains set until another operator is entered, thus | |
1512 don't expect it to be empty. | |
1513 v:operator is not set for |:delete|, |:yank| or other Ex | |
1514 commands. | |
1515 Read-only. | |
1516 | |
7 | 1517 *v:prevcount* *prevcount-variable* |
1518 v:prevcount The count given for the last but one Normal mode command. | |
1519 This is the v:count value of the previous command. Useful if | |
1490 | 1520 you want to cancel Visual or Operator-pending mode and then |
1521 use the count, e.g.: > | |
7 | 1522 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1523 < Read-only. | |
1524 | |
170 | 1525 *v:profiling* *profiling-variable* |
1621 | 1526 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1527 See |profiling|. |
1528 | |
7 | 1529 *v:progname* *progname-variable* |
1530 v:progname Contains the name (with path removed) with which Vim was | |
1531 invoked. Allows you to do special initialisations for "view", | |
1532 "evim" etc., or any other name you might symlink to Vim. | |
1533 Read-only. | |
1534 | |
1535 *v:register* *register-variable* | |
1536 v:register The name of the register supplied to the last normal mode | |
1537 command. Empty if none were supplied. |getreg()| |setreg()| | |
1538 | |
540 | 1539 *v:scrollstart* *scrollstart-variable* |
1540 v:scrollstart String describing the script or function that caused the | |
1541 screen to scroll up. It's only set when it is empty, thus the | |
1542 first reason is remembered. It is set to "Unknown" for a | |
1543 typed command. | |
1544 This can be used to find out why your script causes the | |
1545 hit-enter prompt. | |
1546 | |
7 | 1547 *v:servername* *servername-variable* |
1548 v:servername The resulting registered |x11-clientserver| name if any. | |
1549 Read-only. | |
1550 | |
1621 | 1551 |
1552 v:searchforward *v:searchforward* *searchforward-variable* | |
1553 Search direction: 1 after a forward search, 0 after a | |
1554 backward search. It is reset to forward when directly setting | |
1555 the last search pattern, see |quote/|. | |
1556 Note that the value is restored when returning from a | |
1557 function. |function-search-undo|. | |
1558 Read-write. | |
1559 | |
7 | 1560 *v:shell_error* *shell_error-variable* |
1561 v:shell_error Result of the last shell command. When non-zero, the last | |
1562 shell command had an error. When zero, there was no problem. | |
1563 This only works when the shell returns the error code to Vim. | |
1564 The value -1 is often used when the command could not be | |
1565 executed. Read-only. | |
1566 Example: > | |
1567 :!mv foo bar | |
1568 :if v:shell_error | |
1569 : echo 'could not rename "foo" to "bar"!' | |
1570 :endif | |
1571 < "shell_error" also works, for backwards compatibility. | |
1572 | |
1573 *v:statusmsg* *statusmsg-variable* | |
1574 v:statusmsg Last given status message. It's allowed to set this variable. | |
1575 | |
579 | 1576 *v:swapname* *swapname-variable* |
1577 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1578 the swap file found. Read-only. | |
1579 | |
1580 *v:swapchoice* *swapchoice-variable* | |
1581 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1582 for handling an existing swap file: | |
1583 'o' Open read-only | |
1584 'e' Edit anyway | |
1585 'r' Recover | |
1586 'd' Delete swapfile | |
1587 'q' Quit | |
1588 'a' Abort | |
1621 | 1589 The value should be a single-character string. An empty value |
579 | 1590 results in the user being asked, as would happen when there is |
1591 no SwapExists autocommand. The default is empty. | |
1592 | |
590 | 1593 *v:swapcommand* *swapcommand-variable* |
625 | 1594 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1595 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1596 another Vim open the file and jump to the right place. For |
590 | 1597 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1598 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1599 |
7 | 1600 *v:termresponse* *termresponse-variable* |
1601 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1602 termcap entry. It is set when Vim receives an escape sequence |
7 | 1603 that starts with ESC [ or CSI and ends in a 'c', with only |
1604 digits, ';' and '.' in between. | |
1605 When this option is set, the TermResponse autocommand event is | |
1606 fired, so that you can react to the response from the | |
1607 terminal. | |
1608 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1609 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1610 patch level (since this was introduced in patch 95, it's | |
1611 always 95 or bigger). Pc is always zero. | |
1612 {only when compiled with |+termresponse| feature} | |
1613 | |
1614 *v:this_session* *this_session-variable* | |
1615 v:this_session Full filename of the last loaded or saved session file. See | |
1616 |:mksession|. It is allowed to set this variable. When no | |
1617 session file has been saved, this variable is empty. | |
1618 "this_session" also works, for backwards compatibility. | |
1619 | |
1620 *v:throwpoint* *throwpoint-variable* | |
1621 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1622 finished was thrown. Not set when commands are typed. See |
7 | 1623 also |v:exception| and |throw-variables|. |
1624 Example: > | |
1625 :try | |
1626 : throw "oops" | |
1627 :catch /.*/ | |
1628 : echo "Exception from" v:throwpoint | |
1629 :endtry | |
1630 < Output: "Exception from test.vim, line 2" | |
1631 | |
102 | 1632 *v:val* *val-variable* |
1621 | 1633 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1634 valid while evaluating the expression used with |map()| and |
102 | 1635 |filter()|. Read-only. |
1636 | |
7 | 1637 *v:version* *version-variable* |
1638 v:version Version number of Vim: Major version number times 100 plus | |
1639 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1640 is 501. Read-only. "version" also works, for backwards | |
1641 compatibility. | |
1642 Use |has()| to check if a certain patch was included, e.g.: > | |
1643 if has("patch123") | |
1644 < Note that patch numbers are specific to the version, thus both | |
1645 version 5.0 and 5.1 may have a patch 123, but these are | |
1646 completely different. | |
1647 | |
1648 *v:warningmsg* *warningmsg-variable* | |
1649 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1650 | |
1651 ============================================================================== | |
1652 4. Builtin Functions *functions* | |
1653 | |
1654 See |function-list| for a list grouped by what the function is used for. | |
1655 | |
236 | 1656 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1657 |
1658 USAGE RESULT DESCRIPTION ~ | |
1659 | |
1621 | 1660 abs( {expr}) Float or Number absolute value of {expr} |
685 | 1661 add( {list}, {item}) List append {item} to |List| {list} |
55 | 1662 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1663 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1664 argc() Number number of files in the argument list |
55 | 1665 argidx() Number current index in the argument list |
7 | 1666 argv( {nr}) String {nr} entry of the argument list |
818 | 1667 argv( ) List the argument list |
1621 | 1668 atan( {expr}) Float arc tangent of {expr} |
7 | 1669 browse( {save}, {title}, {initdir}, {default}) |
1670 String put up a file requester | |
1621 | 1671 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1672 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1673 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1674 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1675 bufname( {expr}) String Name of the buffer {expr} |
1676 bufnr( {expr}) Number Number of the buffer {expr} | |
1677 bufwinnr( {expr}) Number window number of buffer {expr} | |
1678 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1679 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1680 call( {func}, {arglist} [, {dict}]) |
1681 any call {func} with arguments {arglist} | |
1621 | 1682 ceil( {expr}) Float round {expr} up |
1683 changenr() Number current change number | |
7 | 1684 char2nr( {expr}) Number ASCII value of first char in {expr} |
55 | 1685 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1686 clearmatches() none clear all matches |
7 | 1687 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1688 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1689 complete_add( {expr}) Number add completion match |
1621 | 1690 complete_check() Number check for key typed during completion |
7 | 1691 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1692 Number number of choice picked by user | |
55 | 1693 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1694 cos( {expr}) Float cosine of {expr} |
95 | 1695 count( {list}, {expr} [, {start} [, {ic}]]) |
1696 Number count how many {expr} are in {list} | |
7 | 1697 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1698 Number checks existence of cscope connection | |
703 | 1699 cursor( {lnum}, {col} [, {coladd}]) |
1700 Number move cursor to {lnum}, {col}, {coladd} | |
1701 cursor( {list}) Number move cursor to position in {list} | |
55 | 1702 deepcopy( {expr}) any make a full copy of {expr} |
7 | 1703 delete( {fname}) Number delete file {fname} |
1704 did_filetype() Number TRUE if FileType autocommand event used | |
55 | 1705 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1706 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
85 | 1707 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1708 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1709 eval( {string}) any evaluate {string} into its value |
55 | 1710 eventhandler( ) Number TRUE if inside an event handler |
7 | 1711 executable( {expr}) Number 1 if executable {expr} exists |
1712 exists( {expr}) Number TRUE if {expr} exists | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1713 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1714 List/Dict insert items of {expr2} into {expr1} |
1754 | 1715 expand( {expr} [, {flag}]) String expand special keywords in {expr} |
1621 | 1716 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1717 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1718 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1719 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1720 {string} is 0 | |
95 | 1721 finddir( {name}[, {path}[, {count}]]) |
824 | 1722 String find directory {name} in {path} |
19 | 1723 findfile( {name}[, {path}[, {count}]]) |
824 | 1724 String find file {name} in {path} |
1621 | 1725 float2nr( {expr}) Number convert Float {expr} to a Number |
1726 floor( {expr}) Float round {expr} down | |
1586 | 1727 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1728 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1729 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1730 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1731 foldlevel( {lnum}) Number fold level at {lnum} |
55 | 1732 foldtext( ) String line displayed for closed fold |
824 | 1733 foldtextresult( {lnum}) String text for closed fold at {lnum} |
7 | 1734 foreground( ) Number bring the Vim window to the foreground |
55 | 1735 function( {name}) Funcref reference to function {name} |
1405 | 1736 garbagecollect( [at_exit]) none free memory, breaking cyclic references |
82 | 1737 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1738 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1739 getbufline( {expr}, {lnum} [, {end}]) |
1740 List lines {lnum} to {end} of buffer {expr} | |
824 | 1741 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr} |
55 | 1742 getchar( [expr]) Number get one character from the user |
1743 getcharmod( ) Number modifiers for the last typed character | |
7 | 1744 getcmdline() String return the current command-line |
1745 getcmdpos() Number return cursor position in command-line | |
531 | 1746 getcmdtype() String return the current command-line type |
7 | 1747 getcwd() String the current working directory |
20 | 1748 getfperm( {fname}) String file permissions of file {fname} |
1749 getfsize( {fname}) Number size in bytes of file {fname} | |
37 | 1750 getfontname( [{name}]) String name of font being used |
7 | 1751 getftime( {fname}) Number last modification time of file |
20 | 1752 getftype( {fname}) String description of type of file {fname} |
161 | 1753 getline( {lnum}) String line {lnum} of current buffer |
1754 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1755 getloclist( {nr}) List list of location list items |
1326 | 1756 getmatches() List list of current matches |
1548 | 1757 getpid() Number process ID of Vim |
703 | 1758 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1759 getqflist() List list of quickfix items |
282 | 1760 getreg( [{regname} [, 1]]) String contents of register |
55 | 1761 getregtype( [{regname}]) String type of register |
831 | 1762 gettabwinvar( {tabnr}, {winnr}, {name}) |
1763 any {name} in {winnr} in tab page {tabnr} | |
7 | 1764 getwinposx() Number X coord in pixels of GUI Vim window |
1765 getwinposy() Number Y coord in pixels of GUI Vim window | |
824 | 1766 getwinvar( {nr}, {varname}) any variable {varname} in window {nr} |
1754 | 1767 glob( {expr} [, {flag}]) String expand file wildcards in {expr} |
1768 globpath( {path}, {expr} [, {flag}]) | |
1769 String do glob({expr}) for all dirs in {path} | |
7 | 1770 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1771 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
1104 | 1772 haslocaldir() Number TRUE if current window executed |:lcd| |
782 | 1773 hasmapto( {what} [, {mode} [, {abbr}]]) |
1774 Number TRUE if mapping to {what} exists | |
7 | 1775 histadd( {history},{item}) String add an item to a history |
1776 histdel( {history} [, {item}]) String remove an item from a history | |
1777 histget( {history} [, {index}]) String get the item {index} from a history | |
1778 histnr( {history}) Number highest index of a history | |
1779 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1780 hlID( {name}) Number syntax ID of highlight group {name} | |
1781 hostname() String name of the machine Vim is running on | |
55 | 1782 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1783 indent( {lnum}) Number indent of line {lnum} | |
95 | 1784 index( {list}, {expr} [, {start} [, {ic}]]) |
1785 Number index in {list} where {expr} appears | |
531 | 1786 input( {prompt} [, {text} [, {completion}]]) |
1787 String get input from the user | |
7 | 1788 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1789 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1790 inputrestore() Number restore typeahead |
1791 inputsave() Number save and clear typeahead | |
7 | 1792 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1793 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
7 | 1794 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1795 islocked( {expr}) Number TRUE if {expr} is locked |
685 | 1796 items( {dict}) List key-value pairs in {dict} |
95 | 1797 join( {list} [, {sep}]) String join {list} items into one String |
685 | 1798 keys( {dict}) List keys in {dict} |
55 | 1799 len( {expr}) Number the length of {expr} |
1800 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1801 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1802 line( {expr}) Number line nr of cursor, last line or mark | |
1803 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1804 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1805 localtime() Number current time |
1621 | 1806 log10( {expr}) Float logarithm of Float {expr} to base 10 |
102 | 1807 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
782 | 1808 maparg( {name}[, {mode} [, {abbr}]]) |
1809 String rhs of mapping {name} in mode {mode} | |
1810 mapcheck( {name}[, {mode} [, {abbr}]]) | |
1811 String check for mappings matching {name} | |
19 | 1812 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1813 Number position where {pat} matches in {expr} |
1326 | 1814 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
1815 Number highlight {pattern} with {group} | |
819 | 1816 matcharg( {nr}) List arguments of |:match| |
1326 | 1817 matchdelete( {id}) Number delete match identified by {id} |
19 | 1818 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1819 Number position where {pat} ends in {expr} |
158 | 1820 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
1821 List match and submatches of {pat} in {expr} | |
19 | 1822 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
1823 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1824 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1825 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1826 mkdir( {name} [, {path} [, {prot}]]) |
168 | 1827 Number create directory {name} |
1621 | 1828 mode( [expr]) String current editing mode |
7 | 1829 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
1830 nr2char( {expr}) String single char with ASCII value {expr} | |
819 | 1831 pathshorten( {expr}) String shorten directory names in a path |
1621 | 1832 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 1833 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 1834 printf( {fmt}, {expr1}...) String format text |
1835 pumvisible() Number whether popup menu is visible | |
99 | 1836 range( {expr} [, {max} [, {stride}]]) |
1837 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1838 readfile( {fname} [, {binary} [, {max}]]) |
168 | 1839 List get list of lines from file {fname} |
794 | 1840 reltime( [{start} [, {end}]]) List get time value |
1841 reltimestr( {time}) String turn time value into a String | |
7 | 1842 remote_expr( {server}, {string} [, {idvar}]) |
1843 String send expression | |
1844 remote_foreground( {server}) Number bring Vim server to the foreground | |
1845 remote_peek( {serverid} [, {retvar}]) | |
1846 Number check for reply string | |
1847 remote_read( {serverid}) String read reply string | |
1848 remote_send( {server}, {string} [, {idvar}]) | |
1849 String send key sequence | |
79 | 1850 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 1851 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 1852 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
1853 repeat( {expr}, {count}) String repeat {expr} {count} times | |
1854 resolve( {filename}) String get filename a shortcut points to | |
82 | 1855 reverse( {list}) List reverse {list} in-place |
1621 | 1856 round( {expr}) Float round off {expr} |
1496 | 1857 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1858 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1859 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 1860 Number search for variable declaration |
1496 | 1861 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 1862 Number search for other end of start/end pair |
1496 | 1863 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 1864 List search for other end of start/end pair |
1496 | 1865 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 1866 List search for {pattern} |
7 | 1867 server2client( {clientid}, {string}) |
1868 Number send reply string | |
1869 serverlist() String get a list of available servers | |
1870 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
1871 setcmdpos( {pos}) Number set cursor position in command-line | |
1872 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
647 | 1873 setloclist( {nr}, {list}[, {action}]) |
1874 Number modify location list using {list} | |
1326 | 1875 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1876 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 1877 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 1878 setreg( {n}, {v}[, {opt}]) Number set register to value and type |
831 | 1879 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
1880 {winnr} in tab page {tabnr} to {val} | |
7 | 1881 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
1661 | 1882 shellescape( {string} [, {special}]) |
1883 String escape {string} for use as shell | |
985 | 1884 command argument |
55 | 1885 simplify( {filename}) String simplify filename as much as possible |
1621 | 1886 sin( {expr}) Float sine of {expr} |
82 | 1887 sort( {list} [, {func}]) List sort {list}, using {func} to compare |
374 | 1888 soundfold( {word}) String sound-fold {word} |
344 | 1889 spellbadword() String badly spelled word at cursor |
537 | 1890 spellsuggest( {word} [, {max} [, {capital}]]) |
1891 List spelling suggestions | |
282 | 1892 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 1893 List make |List| from {pat} separated {expr} |
1621 | 1894 sqrt( {expr} Float squar root of {expr} |
1895 str2float( {expr}) Float convert String to Float | |
1896 str2nr( {expr} [, {base}]) Number convert String to Number | |
7 | 1897 strftime( {format}[, {time}]) String time in specified format |
133 | 1898 stridx( {haystack}, {needle}[, {start}]) |
1899 Number index of {needle} in {haystack} | |
95 | 1900 string( {expr}) String String representation of {expr} value |
7 | 1901 strlen( {expr}) Number length of the String {expr} |
1902 strpart( {src}, {start}[, {len}]) | |
1903 String {len} characters of {src} at {start} | |
140 | 1904 strridx( {haystack}, {needle} [, {start}]) |
1905 Number last index of {needle} in {haystack} | |
7 | 1906 strtrans( {expr}) String translate string to make it printable |
55 | 1907 submatch( {nr}) String specific match in ":substitute" |
7 | 1908 substitute( {expr}, {pat}, {sub}, {flags}) |
1909 String all {pat} in {expr} replaced with {sub} | |
32 | 1910 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 1911 synIDattr( {synID}, {what} [, {mode}]) |
1912 String attribute {what} of syntax ID {synID} | |
1913 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1914 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 1915 system( {expr} [, {input}]) String output of shell command/filter {expr} |
677 | 1916 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
1917 tabpagenr( [{arg}]) Number number of current or last tab page | |
1918 tabpagewinnr( {tabarg}[, {arg}]) | |
1919 Number number of current window in tab page | |
1920 taglist( {expr}) List list of tags matching {expr} | |
1621 | 1921 tagfiles() List tags files used |
7 | 1922 tempname() String name for a temporary file |
1923 tolower( {expr}) String the String {expr} switched to lowercase | |
1924 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 1925 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
1926 to chars in {tostr} | |
1621 | 1927 trunc( {expr} Float truncate Float {expr} |
7 | 1928 type( {name}) Number type of variable {name} |
685 | 1929 values( {dict}) List values in {dict} |
7 | 1930 virtcol( {expr}) Number screen column of cursor or mark |
1931 visualmode( [expr]) String last visual mode used | |
1932 winbufnr( {nr}) Number buffer number of window {nr} | |
1933 wincol() Number window column of the cursor | |
1934 winheight( {nr}) Number height of window {nr} | |
1935 winline() Number window line of the cursor | |
674 | 1936 winnr( [{expr}]) Number number of current window |
55 | 1937 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1938 winrestview( {dict}) none restore view of current window |
712 | 1939 winsaveview() Dict save view of current window |
7 | 1940 winwidth( {nr}) Number width of window {nr} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1941 writefile( {list}, {fname} [, {binary}]) |
158 | 1942 Number write list of lines to file {fname} |
7 | 1943 |
1621 | 1944 abs({expr}) *abs()* |
1945 Return the absolute value of {expr}. When {expr} evaluates to | |
1946 a |Float| abs() returns a |Float|. When {expr} can be | |
1947 converted to a |Number| abs() returns a |Number|. Otherwise | |
1948 abs() gives an error message and returns -1. | |
1949 Examples: > | |
1950 echo abs(1.456) | |
1951 < 1.456 > | |
1952 echo abs(-5.456) | |
1953 < 5.456 > | |
1954 echo abs(-4) | |
1955 < 4 | |
1956 {only available when compiled with the |+float| feature} | |
1957 | |
82 | 1958 add({list}, {expr}) *add()* |
685 | 1959 Append the item {expr} to |List| {list}. Returns the |
1960 resulting |List|. Examples: > | |
82 | 1961 :let alist = add([1, 2, 3], item) |
1962 :call add(mylist, "woodstock") | |
685 | 1963 < Note that when {expr} is a |List| it is appended as a single |
692 | 1964 item. Use |extend()| to concatenate |Lists|. |
85 | 1965 Use |insert()| to add an item at another position. |
55 | 1966 |
82 | 1967 |
1968 append({lnum}, {expr}) *append()* | |
685 | 1969 When {expr} is a |List|: Append each item of the |List| as a |
1970 text line below line {lnum} in the current buffer. | |
153 | 1971 Otherwise append {expr} as one text line below line {lnum} in |
1972 the current buffer. | |
1973 {lnum} can be zero to insert a line before the first one. | |
82 | 1974 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 1975 0 for success. Example: > |
55 | 1976 :let failed = append(line('$'), "# THE END") |
82 | 1977 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 1978 < |
7 | 1979 *argc()* |
1980 argc() The result is the number of files in the argument list of the | |
1981 current window. See |arglist|. | |
1982 | |
1983 *argidx()* | |
1984 argidx() The result is the current index in the argument list. 0 is | |
1985 the first file. argc() - 1 is the last one. See |arglist|. | |
1986 | |
1987 *argv()* | |
818 | 1988 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 1989 current window. See |arglist|. "argv(0)" is the first one. |
1990 Example: > | |
1991 :let i = 0 | |
1992 :while i < argc() | |
1621 | 1993 : let f = escape(fnameescape(argv(i)), '.') |
7 | 1994 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
1995 : let i = i + 1 | |
1996 :endwhile | |
818 | 1997 < Without the {nr} argument a |List| with the whole |arglist| is |
1998 returned. | |
1999 | |
1621 | 2000 atan({expr}) *atan()* |
2001 Return the principal value of the arc tangent of {expr}, in | |
2002 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2003 {expr} must evaluate to a |Float| or a |Number|. | |
2004 Examples: > | |
2005 :echo atan(100) | |
2006 < 1.560797 > | |
2007 :echo atan(-4.01) | |
2008 < -1.326405 | |
2009 {only available when compiled with the |+float| feature} | |
2010 | |
7 | 2011 *browse()* |
2012 browse({save}, {title}, {initdir}, {default}) | |
2013 Put up a file requester. This only works when "has("browse")" | |
2014 returns non-zero (only in some GUI versions). | |
2015 The input fields are: | |
2016 {save} when non-zero, select file to write | |
2017 {title} title for the requester | |
2018 {initdir} directory to start browsing in | |
2019 {default} default file name | |
2020 When the "Cancel" button is hit, something went wrong, or | |
2021 browsing is not possible, an empty string is returned. | |
2022 | |
29 | 2023 *browsedir()* |
2024 browsedir({title}, {initdir}) | |
2025 Put up a directory requester. This only works when | |
2026 "has("browse")" returns non-zero (only in some GUI versions). | |
2027 On systems where a directory browser is not supported a file | |
2028 browser is used. In that case: select a file in the directory | |
2029 to be used. | |
2030 The input fields are: | |
2031 {title} title for the requester | |
2032 {initdir} directory to start browsing in | |
2033 When the "Cancel" button is hit, something went wrong, or | |
2034 browsing is not possible, an empty string is returned. | |
2035 | |
7 | 2036 bufexists({expr}) *bufexists()* |
2037 The result is a Number, which is non-zero if a buffer called | |
2038 {expr} exists. | |
9 | 2039 If the {expr} argument is a number, buffer numbers are used. |
7 | 2040 If the {expr} argument is a string it must match a buffer name |
9 | 2041 exactly. The name can be: |
2042 - Relative to the current directory. | |
2043 - A full path. | |
1621 | 2044 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2045 - A URL name. |
7 | 2046 Unlisted buffers will be found. |
2047 Note that help files are listed by their short name in the | |
2048 output of |:buffers|, but bufexists() requires using their | |
2049 long name to be able to find them. | |
1621 | 2050 bufexists() may report a buffer exists, but to use the name |
2051 with a |:buffer| command you may need to use |expand()|. Esp | |
2052 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2053 Use "bufexists(0)" to test for the existence of an alternate |
2054 file name. | |
2055 *buffer_exists()* | |
2056 Obsolete name: buffer_exists(). | |
2057 | |
2058 buflisted({expr}) *buflisted()* | |
2059 The result is a Number, which is non-zero if a buffer called | |
2060 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2061 The {expr} argument is used like with |bufexists()|. |
7 | 2062 |
2063 bufloaded({expr}) *bufloaded()* | |
2064 The result is a Number, which is non-zero if a buffer called | |
2065 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2066 The {expr} argument is used like with |bufexists()|. |
7 | 2067 |
2068 bufname({expr}) *bufname()* | |
2069 The result is the name of a buffer, as it is displayed by the | |
2070 ":ls" command. | |
2071 If {expr} is a Number, that buffer number's name is given. | |
2072 Number zero is the alternate buffer for the current window. | |
2073 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2074 with the buffer names. This is always done like 'magic' is |
7 | 2075 set and 'cpoptions' is empty. When there is more than one |
2076 match an empty string is returned. | |
2077 "" or "%" can be used for the current buffer, "#" for the | |
2078 alternate buffer. | |
2079 A full match is preferred, otherwise a match at the start, end | |
1156 | 2080 or middle of the buffer name is accepted. If you only want a |
2081 full match then put "^" at the start and "$" at the end of the | |
2082 pattern. | |
7 | 2083 Listed buffers are found first. If there is a single match |
2084 with a listed buffer, that one is returned. Next unlisted | |
2085 buffers are searched for. | |
2086 If the {expr} is a String, but you want to use it as a buffer | |
2087 number, force it to be a Number by adding zero to it: > | |
2088 :echo bufname("3" + 0) | |
2089 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2090 string is returned. > | |
2091 bufname("#") alternate buffer name | |
2092 bufname(3) name of buffer 3 | |
2093 bufname("%") name of current buffer | |
2094 bufname("file2") name of buffer where "file2" matches. | |
2095 < *buffer_name()* | |
2096 Obsolete name: buffer_name(). | |
2097 | |
2098 *bufnr()* | |
707 | 2099 bufnr({expr} [, {create}]) |
2100 The result is the number of a buffer, as it is displayed by | |
7 | 2101 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2102 above. |
2103 If the buffer doesn't exist, -1 is returned. Or, if the | |
2104 {create} argument is present and not zero, a new, unlisted, | |
2105 buffer is created and its number is returned. | |
7 | 2106 bufnr("$") is the last buffer: > |
2107 :let last_buffer = bufnr("$") | |
2108 < The result is a Number, which is the highest buffer number | |
2109 of existing buffers. Note that not all buffers with a smaller | |
2110 number necessarily exist, because ":bwipeout" may have removed | |
2111 them. Use bufexists() to test for the existence of a buffer. | |
2112 *buffer_number()* | |
2113 Obsolete name: buffer_number(). | |
2114 *last_buffer_nr()* | |
2115 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2116 | |
2117 bufwinnr({expr}) *bufwinnr()* | |
2118 The result is a Number, which is the number of the first | |
2119 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2120 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2121 there is no such window, -1 is returned. Example: > |
2122 | |
2123 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2124 | |
2125 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2126 |:wincmd|. | |
1156 | 2127 Only deals with the current tab page. |
7 | 2128 |
2129 | |
2130 byte2line({byte}) *byte2line()* | |
2131 Return the line number that contains the character at byte | |
2132 count {byte} in the current buffer. This includes the | |
2133 end-of-line character, depending on the 'fileformat' option | |
2134 for the current buffer. The first character has byte count | |
2135 one. | |
2136 Also see |line2byte()|, |go| and |:goto|. | |
2137 {not available when compiled without the |+byte_offset| | |
2138 feature} | |
2139 | |
18 | 2140 byteidx({expr}, {nr}) *byteidx()* |
2141 Return byte index of the {nr}'th character in the string | |
2142 {expr}. Use zero for the first character, it returns zero. | |
2143 This function is only useful when there are multibyte | |
2144 characters, otherwise the returned value is equal to {nr}. | |
2145 Composing characters are counted as a separate character. | |
2146 Example : > | |
2147 echo matchstr(str, ".", byteidx(str, 3)) | |
2148 < will display the fourth character. Another way to do the | |
2149 same: > | |
2150 let s = strpart(str, byteidx(str, 3)) | |
2151 echo strpart(s, 0, byteidx(s, 1)) | |
2152 < If there are less than {nr} characters -1 is returned. | |
2153 If there are exactly {nr} characters the length of the string | |
2154 is returned. | |
2155 | |
102 | 2156 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2157 Call function {func} with the items in |List| {arglist} as |
79 | 2158 arguments. |
685 | 2159 {func} can either be a |Funcref| or the name of a function. |
79 | 2160 a:firstline and a:lastline are set to the cursor line. |
2161 Returns the return value of the called function. | |
102 | 2162 {dict} is for functions with the "dict" attribute. It will be |
2163 used to set the local variable "self". |Dictionary-function| | |
79 | 2164 |
1621 | 2165 ceil({expr}) *ceil()* |
2166 Return the smallest integral value greater than or equal to | |
2167 {expr} as a |Float| (round up). | |
2168 {expr} must evaluate to a |Float| or a |Number|. | |
2169 Examples: > | |
2170 echo ceil(1.456) | |
2171 < 2.0 > | |
2172 echo ceil(-5.456) | |
2173 < -5.0 > | |
2174 echo ceil(4.0) | |
2175 < 4.0 | |
2176 {only available when compiled with the |+float| feature} | |
2177 | |
777 | 2178 changenr() *changenr()* |
2179 Return the number of the most recent change. This is the same | |
2180 number as what is displayed with |:undolist| and can be used | |
2181 with the |:undo| command. | |
2182 When a change was made it is the number of that change. After | |
2183 redo it is the number of the redone change. After undo it is | |
2184 one less than the number of the undone change. | |
2185 | |
7 | 2186 char2nr({expr}) *char2nr()* |
2187 Return number value of the first char in {expr}. Examples: > | |
2188 char2nr(" ") returns 32 | |
2189 char2nr("ABC") returns 65 | |
2190 < The current 'encoding' is used. Example for "utf-8": > | |
1156 | 2191 char2nr("á") returns 225 |
2192 char2nr("á"[0]) returns 195 | |
1621 | 2193 < |nr2char()| does the opposite. |
7 | 2194 |
2195 cindent({lnum}) *cindent()* | |
2196 Get the amount of indent for line {lnum} according the C | |
2197 indenting rules, as with 'cindent'. | |
2198 The indent is counted in spaces, the value of 'tabstop' is | |
2199 relevant. {lnum} is used just like in |getline()|. | |
2200 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2201 feature, -1 is returned. | |
548 | 2202 See |C-indenting|. |
7 | 2203 |
1326 | 2204 clearmatches() *clearmatches()* |
2205 Clears all matches previously defined by |matchadd()| and the | |
2206 |:match| commands. | |
2207 | |
7 | 2208 *col()* |
24 | 2209 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2210 position given with {expr}. The accepted positions are: |
2211 . the cursor position | |
2212 $ the end of the cursor line (the result is the | |
2213 number of characters in the cursor line plus one) | |
2214 'x position of mark x (if the mark is not set, 0 is | |
2215 returned) | |
1317 | 2216 Additionally {expr} can be [lnum, col]: a |List| with the line |
2217 and column number. Most useful when the column is "$", to get | |
1621 | 2218 the last column of a specific line. When "lnum" or "col" is |
1317 | 2219 out of range then col() returns zero. |
1156 | 2220 To get the line number use |line()|. To get both use |
703 | 2221 |getpos()|. |
7 | 2222 For the screen column position use |virtcol()|. |
2223 Note that only marks in the current file can be used. | |
2224 Examples: > | |
2225 col(".") column of cursor | |
2226 col("$") length of cursor line plus one | |
2227 col("'t") column of mark t | |
2228 col("'" . markname) column of mark markname | |
1621 | 2229 < The first column is 1. 0 is returned for an error. |
1156 | 2230 For an uppercase mark the column may actually be in another |
2231 buffer. | |
7 | 2232 For the cursor position, when 'virtualedit' is active, the |
2233 column is one higher if the cursor is after the end of the | |
2234 line. This can be used to obtain the column in Insert mode: > | |
2235 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2236 \<C-O>:set ve=all<CR> | |
2237 \<C-O>:echo col(".") . "\n" <Bar> | |
2238 \let &ve = save_ve<CR> | |
2239 < | |
464 | 2240 |
724 | 2241 complete({startcol}, {matches}) *complete()* *E785* |
2242 Set the matches for Insert mode completion. | |
2243 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2244 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2245 with an expression mapping. | |
724 | 2246 {startcol} is the byte offset in the line where the completed |
2247 text start. The text up to the cursor is the original text | |
2248 that will be replaced by the matches. Use col('.') for an | |
2249 empty string. "col('.') - 1" will replace one character by a | |
2250 match. | |
2251 {matches} must be a |List|. Each |List| item is one match. | |
2252 See |complete-items| for the kind of items that are possible. | |
2253 Note that the after calling this function you need to avoid | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2254 inserting anything that would cause completion to stop. |
724 | 2255 The match can be selected with CTRL-N and CTRL-P as usual with |
2256 Insert mode completion. The popup menu will appear if | |
2257 specified, see |ins-completion-menu|. | |
2258 Example: > | |
1156 | 2259 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2260 |
2261 func! ListMonths() | |
2262 call complete(col('.'), ['January', 'February', 'March', | |
2263 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2264 \ 'October', 'November', 'December']) | |
2265 return '' | |
2266 endfunc | |
2267 < This isn't very useful, but it shows how it works. Note that | |
2268 an empty string is returned to avoid a zero being inserted. | |
2269 | |
464 | 2270 complete_add({expr}) *complete_add()* |
2271 Add {expr} to the list of matches. Only to be used by the | |
2272 function specified with the 'completefunc' option. | |
2273 Returns 0 for failure (empty string or out of memory), | |
2274 1 when the match was added, 2 when the match was already in | |
2275 the list. | |
1621 | 2276 See |complete-functions| for an explanation of {expr}. It is |
786 | 2277 the same as one item in the list that 'omnifunc' would return. |
464 | 2278 |
2279 complete_check() *complete_check()* | |
2280 Check for a key typed while looking for completion matches. | |
2281 This is to be used when looking for matches takes some time. | |
2282 Returns non-zero when searching for matches is to be aborted, | |
2283 zero otherwise. | |
2284 Only to be used by the function specified with the | |
2285 'completefunc' option. | |
2286 | |
7 | 2287 *confirm()* |
2288 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2289 Confirm() offers the user a dialog, from which a choice can be | |
2290 made. It returns the number of the choice. For the first | |
2291 choice this is 1. | |
2292 Note: confirm() is only supported when compiled with dialog | |
2293 support, see |+dialog_con| and |+dialog_gui|. | |
2294 {msg} is displayed in a |dialog| with {choices} as the | |
2295 alternatives. When {choices} is missing or empty, "&OK" is | |
2296 used (and translated). | |
2297 {msg} is a String, use '\n' to include a newline. Only on | |
2298 some systems the string is wrapped when it doesn't fit. | |
2299 {choices} is a String, with the individual choices separated | |
2300 by '\n', e.g. > | |
2301 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2302 < The letter after the '&' is the shortcut key for that choice. | |
2303 Thus you can type 'c' to select "Cancel". The shortcut does | |
2304 not need to be the first letter: > | |
2305 confirm("file has been modified", "&Save\nSave &All") | |
2306 < For the console, the first letter of each choice is used as | |
2307 the default shortcut key. | |
2308 The optional {default} argument is the number of the choice | |
2309 that is made if the user hits <CR>. Use 1 to make the first | |
2310 choice the default one. Use 0 to not set a default. If | |
2311 {default} is omitted, 1 is used. | |
1621 | 2312 The optional {type} argument gives the type of dialog. This |
7 | 2313 is only used for the icon of the Win32 GUI. It can be one of |
2314 these values: "Error", "Question", "Info", "Warning" or | |
2315 "Generic". Only the first character is relevant. When {type} | |
2316 is omitted, "Generic" is used. | |
2317 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
2318 or another valid interrupt key, confirm() returns 0. | |
2319 | |
2320 An example: > | |
2321 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2322 :if choice == 0 | |
2323 : echo "make up your mind!" | |
2324 :elseif choice == 3 | |
2325 : echo "tasteful" | |
2326 :else | |
2327 : echo "I prefer bananas myself." | |
2328 :endif | |
2329 < In a GUI dialog, buttons are used. The layout of the buttons | |
2330 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2331 the buttons are always put vertically. Otherwise, confirm() |
7 | 2332 tries to put the buttons in one horizontal line. If they |
2333 don't fit, a vertical layout is used anyway. For some systems | |
2334 the horizontal layout is always used. | |
2335 | |
55 | 2336 *copy()* |
1621 | 2337 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2338 different from using {expr} directly. |
685 | 2339 When {expr} is a |List| a shallow copy is created. This means |
2340 that the original |List| can be changed without changing the | |
1621 | 2341 copy, and vice versa. But the items are identical, thus |
2342 changing an item changes the contents of both |Lists|. Also | |
685 | 2343 see |deepcopy()|. |
55 | 2344 |
1621 | 2345 cos({expr}) *cos()* |
2346 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2347 {expr} must evaluate to a |Float| or a |Number|. | |
2348 Examples: > | |
2349 :echo cos(100) | |
2350 < 0.862319 > | |
2351 :echo cos(-4.01) | |
2352 < -0.646043 | |
2353 {only available when compiled with the |+float| feature} | |
2354 | |
2355 | |
102 | 2356 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2357 Return the number of times an item with value {expr} appears |
685 | 2358 in |List| or |Dictionary| {comp}. |
102 | 2359 If {start} is given then start with the item with this index. |
685 | 2360 {start} can only be used with a |List|. |
79 | 2361 When {ic} is given and it's non-zero then case is ignored. |
2362 | |
2363 | |
7 | 2364 *cscope_connection()* |
2365 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2366 Checks for the existence of a |cscope| connection. If no | |
2367 parameters are specified, then the function returns: | |
2368 0, if cscope was not available (not compiled in), or | |
2369 if there are no cscope connections; | |
2370 1, if there is at least one cscope connection. | |
2371 | |
2372 If parameters are specified, then the value of {num} | |
2373 determines how existence of a cscope connection is checked: | |
2374 | |
2375 {num} Description of existence check | |
2376 ----- ------------------------------ | |
2377 0 Same as no parameters (e.g., "cscope_connection()"). | |
2378 1 Ignore {prepend}, and use partial string matches for | |
2379 {dbpath}. | |
2380 2 Ignore {prepend}, and use exact string matches for | |
2381 {dbpath}. | |
2382 3 Use {prepend}, use partial string matches for both | |
2383 {dbpath} and {prepend}. | |
2384 4 Use {prepend}, use exact string matches for both | |
2385 {dbpath} and {prepend}. | |
2386 | |
2387 Note: All string comparisons are case sensitive! | |
2388 | |
2389 Examples. Suppose we had the following (from ":cs show"): > | |
2390 | |
2391 # pid database name prepend path | |
2392 0 27664 cscope.out /usr/local | |
2393 < | |
2394 Invocation Return Val ~ | |
2395 ---------- ---------- > | |
2396 cscope_connection() 1 | |
2397 cscope_connection(1, "out") 1 | |
2398 cscope_connection(2, "out") 0 | |
2399 cscope_connection(3, "out") 0 | |
2400 cscope_connection(3, "out", "local") 1 | |
2401 cscope_connection(4, "out") 0 | |
2402 cscope_connection(4, "out", "local") 0 | |
2403 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2404 < | |
703 | 2405 cursor({lnum}, {col} [, {off}]) *cursor()* |
2406 cursor({list}) | |
1156 | 2407 Positions the cursor at the column (byte count) {col} in the |
2408 line {lnum}. The first column is one. | |
703 | 2409 When there is one argument {list} this is used as a |List| |
707 | 2410 with two or three items {lnum}, {col} and {off}. This is like |
2411 the return value of |getpos()|, but without the first item. | |
7 | 2412 Does not change the jumplist. |
2413 If {lnum} is greater than the number of lines in the buffer, | |
2414 the cursor will be positioned at the last line in the buffer. | |
2415 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 2416 If {col} is greater than the number of bytes in the line, |
7 | 2417 the cursor will be positioned at the last character in the |
2418 line. | |
2419 If {col} is zero, the cursor will stay in the current column. | |
703 | 2420 When 'virtualedit' is used {off} specifies the offset in |
2421 screen columns from the start of the character. E.g., a | |
1266 | 2422 position within a <Tab> or after the last character. |
1851 | 2423 Returns 0 when the position could be set, -1 otherwise. |
7 | 2424 |
55 | 2425 |
164 | 2426 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 2427 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2428 different from using {expr} directly. |
685 | 2429 When {expr} is a |List| a full copy is created. This means |
2430 that the original |List| can be changed without changing the | |
1621 | 2431 copy, and vice versa. When an item is a |List|, a copy for it |
55 | 2432 is made, recursively. Thus changing an item in the copy does |
685 | 2433 not change the contents of the original |List|. |
2434 When {noref} is omitted or zero a contained |List| or | |
2435 |Dictionary| is only copied once. All references point to | |
2436 this single copy. With {noref} set to 1 every occurrence of a | |
2437 |List| or |Dictionary| results in a new copy. This also means | |
2438 that a cyclic reference causes deepcopy() to fail. | |
114 | 2439 *E724* |
2440 Nesting is possible up to 100 levels. When there is an item | |
164 | 2441 that refers back to a higher level making a deep copy with |
2442 {noref} set to 1 will fail. | |
55 | 2443 Also see |copy()|. |
2444 | |
2445 delete({fname}) *delete()* | |
2446 Deletes the file by the name {fname}. The result is a Number, | |
7 | 2447 which is 0 if the file was deleted successfully, and non-zero |
2448 when the deletion failed. | |
685 | 2449 Use |remove()| to delete an item from a |List|. |
7 | 2450 |
2451 *did_filetype()* | |
2452 did_filetype() Returns non-zero when autocommands are being executed and the | |
2453 FileType event has been triggered at least once. Can be used | |
2454 to avoid triggering the FileType event again in the scripts | |
2455 that detect the file type. |FileType| | |
2456 When editing another file, the counter is reset, thus this | |
2457 really checks if the FileType event has been triggered for the | |
2458 current buffer. This allows an autocommand that starts | |
2459 editing another buffer to set 'filetype' and load a syntax | |
2460 file. | |
2461 | |
32 | 2462 diff_filler({lnum}) *diff_filler()* |
2463 Returns the number of filler lines above line {lnum}. | |
2464 These are the lines that were inserted at this point in | |
2465 another diff'ed window. These filler lines are shown in the | |
2466 display but don't exist in the buffer. | |
2467 {lnum} is used like with |getline()|. Thus "." is the current | |
2468 line, "'m" mark m, etc. | |
2469 Returns 0 if the current window is not in diff mode. | |
2470 | |
2471 diff_hlID({lnum}, {col}) *diff_hlID()* | |
2472 Returns the highlight ID for diff mode at line {lnum} column | |
2473 {col} (byte index). When the current line does not have a | |
2474 diff change zero is returned. | |
2475 {lnum} is used like with |getline()|. Thus "." is the current | |
2476 line, "'m" mark m, etc. | |
2477 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
2478 line. | |
2479 The highlight ID can be used with |synIDattr()| to obtain | |
2480 syntax information about the highlighting. | |
2481 | |
85 | 2482 empty({expr}) *empty()* |
2483 Return the Number 1 if {expr} is empty, zero otherwise. | |
685 | 2484 A |List| or |Dictionary| is empty when it does not have any |
1621 | 2485 items. A Number is empty when its value is zero. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2486 For a long |List| this is much faster than comparing the |
685 | 2487 length with zero. |
85 | 2488 |
7 | 2489 escape({string}, {chars}) *escape()* |
2490 Escape the characters in {chars} that occur in {string} with a | |
2491 backslash. Example: > | |
2492 :echo escape('c:\program files\vim', ' \') | |
2493 < results in: > | |
2494 c:\\program\ files\\vim | |
1621 | 2495 < Also see |shellescape()|. |
2496 | |
2497 *eval()* | |
95 | 2498 eval({string}) Evaluate {string} and return the result. Especially useful to |
2499 turn the result of |string()| back into the original value. | |
1621 | 2500 This works for Numbers, Floats, Strings and composites of |
2501 them. Also works for |Funcref|s that refer to existing | |
2502 functions. | |
95 | 2503 |
7 | 2504 eventhandler() *eventhandler()* |
2505 Returns 1 when inside an event handler. That is that Vim got | |
2506 interrupted while waiting for the user to type a character, | |
2507 e.g., when dropping a file on Vim. This means interactive | |
2508 commands cannot be used. Otherwise zero is returned. | |
2509 | |
2510 executable({expr}) *executable()* | |
2511 This function checks if an executable with the name {expr} | |
2512 exists. {expr} must be the name of the program without any | |
10 | 2513 arguments. |
2514 executable() uses the value of $PATH and/or the normal | |
2515 searchpath for programs. *PATHEXT* | |
2516 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
2517 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 2518 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
2519 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 2520 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 2521 the name without an extension. When 'shell' looks like a |
10 | 2522 Unix shell, then the name is also tried without adding an |
2523 extension. | |
2524 On MS-DOS and MS-Windows it only checks if the file exists and | |
2525 is not a directory, not if it's really executable. | |
819 | 2526 On MS-Windows an executable in the same directory as Vim is |
2527 always found. Since this directory is added to $PATH it | |
2528 should also work to execute it |win32-PATH|. | |
7 | 2529 The result is a Number: |
2530 1 exists | |
2531 0 does not exist | |
2532 -1 not implemented on this system | |
2533 | |
2534 *exists()* | |
2535 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
2536 defined, zero otherwise. The {expr} argument is a string, | |
2537 which contains one of these: | |
2538 &option-name Vim option (only checks if it exists, | |
2539 not if it really works) | |
2540 +option-name Vim option that works. | |
2541 $ENVNAME environment variable (could also be | |
2542 done by comparing with an empty | |
2543 string) | |
2544 *funcname built-in function (see |functions|) | |
2545 or user defined function (see | |
2546 |user-functions|). | |
2547 varname internal variable (see | |
1621 | 2548 |internal-variables|). Also works |
685 | 2549 for |curly-braces-names|, |Dictionary| |
2550 entries, |List| items, etc. Beware | |
1668 | 2551 that evaluating an index may cause an |
2552 error message for an invalid | |
2553 expression. E.g.: > | |
2554 :let l = [1, 2, 3] | |
2555 :echo exists("l[5]") | |
2556 < 0 > | |
2557 :echo exists("l[xx]") | |
2558 < E121: Undefined variable: xx | |
2559 0 | |
7 | 2560 :cmdname Ex command: built-in command, user |
2561 command or command modifier |:command|. | |
2562 Returns: | |
2563 1 for match with start of a command | |
2564 2 full match with a command | |
2565 3 matches several user commands | |
2566 To check for a supported command | |
2567 always check the return value to be 2. | |
864 | 2568 :2match The |:2match| command. |
2569 :3match The |:3match| command. | |
7 | 2570 #event autocommand defined for this event |
2571 #event#pattern autocommand defined for this event and | |
2572 pattern (the pattern is taken | |
2573 literally and compared to the | |
2574 autocommand patterns character by | |
2575 character) | |
613 | 2576 #group autocommand group exists |
2577 #group#event autocommand defined for this group and | |
2578 event. | |
2579 #group#event#pattern | |
856 | 2580 autocommand defined for this group, |
613 | 2581 event and pattern. |
615 | 2582 ##event autocommand for this event is |
2583 supported. | |
7 | 2584 For checking for a supported feature use |has()|. |
2585 | |
2586 Examples: > | |
2587 exists("&shortname") | |
2588 exists("$HOSTNAME") | |
2589 exists("*strftime") | |
2590 exists("*s:MyFunc") | |
2591 exists("bufcount") | |
2592 exists(":Make") | |
613 | 2593 exists("#CursorHold") |
7 | 2594 exists("#BufReadPre#*.gz") |
613 | 2595 exists("#filetypeindent") |
2596 exists("#filetypeindent#FileType") | |
2597 exists("#filetypeindent#FileType#*") | |
615 | 2598 exists("##ColorScheme") |
7 | 2599 < There must be no space between the symbol (&/$/*/#) and the |
2600 name. | |
867 | 2601 There must be no extra characters after the name, although in |
2602 a few cases this is ignored. That may become more strict in | |
2603 the future, thus don't count on it! | |
2604 Working example: > | |
2605 exists(":make") | |
2606 < NOT working example: > | |
2607 exists(":make install") | |
859 | 2608 |
2609 < Note that the argument must be a string, not the name of the | |
2610 variable itself. For example: > | |
7 | 2611 exists(bufcount) |
2612 < This doesn't check for existence of the "bufcount" variable, | |
853 | 2613 but gets the value of "bufcount", and checks if that exists. |
7 | 2614 |
2615 expand({expr} [, {flag}]) *expand()* | |
2616 Expand wildcards and the following special keywords in {expr}. | |
2617 The result is a String. | |
2618 | |
2619 When there are several matches, they are separated by <NL> | |
2620 characters. [Note: in version 5.0 a space was used, which | |
2621 caused problems when a file name contains a space] | |
2622 | |
1621 | 2623 If the expansion fails, the result is an empty string. A name |
7 | 2624 for a non-existing file is not included. |
2625 | |
2626 When {expr} starts with '%', '#' or '<', the expansion is done | |
2627 like for the |cmdline-special| variables with their associated | |
2628 modifiers. Here is a short overview: | |
2629 | |
2630 % current file name | |
2631 # alternate file name | |
2632 #n alternate file name n | |
2633 <cfile> file name under the cursor | |
2634 <afile> autocmd file name | |
2635 <abuf> autocmd buffer number (as a String!) | |
2636 <amatch> autocmd matched name | |
2637 <sfile> sourced script file name | |
2638 <cword> word under the cursor | |
2639 <cWORD> WORD under the cursor | |
2640 <client> the {clientid} of the last received | |
2641 message |server2client()| | |
2642 Modifiers: | |
2643 :p expand to full path | |
2644 :h head (last path component removed) | |
2645 :t tail (last path component only) | |
2646 :r root (one extension removed) | |
2647 :e extension only | |
2648 | |
2649 Example: > | |
2650 :let &tags = expand("%:p:h") . "/tags" | |
2651 < Note that when expanding a string that starts with '%', '#' or | |
2652 '<', any following text is ignored. This does NOT work: > | |
2653 :let doesntwork = expand("%:h.bak") | |
2654 < Use this: > | |
2655 :let doeswork = expand("%:h") . ".bak" | |
2656 < Also note that expanding "<cfile>" and others only returns the | |
2657 referenced file name without further expansion. If "<cfile>" | |
2658 is "~/.cshrc", you need to do another expand() to have the | |
2659 "~/" expanded into the path of the home directory: > | |
2660 :echo expand(expand("<cfile>")) | |
2661 < | |
2662 There cannot be white space between the variables and the | |
2663 following modifier. The |fnamemodify()| function can be used | |
2664 to modify normal file names. | |
2665 | |
2666 When using '%' or '#', and the current or alternate file name | |
2667 is not defined, an empty string is used. Using "%:p" in a | |
2668 buffer with no name, results in the current directory, with a | |
2669 '/' added. | |
2670 | |
2671 When {expr} does not start with '%', '#' or '<', it is | |
2672 expanded like a file name is expanded on the command line. | |
2673 'suffixes' and 'wildignore' are used, unless the optional | |
2674 {flag} argument is given and it is non-zero. Names for | |
444 | 2675 non-existing files are included. The "**" item can be used to |
2676 search in a directory tree. For example, to find all "README" | |
2677 files in the current directory and below: > | |
2678 :echo expand("**/README") | |
2679 < | |
7 | 2680 Expand() can also be used to expand variables and environment |
2681 variables that are only known in a shell. But this can be | |
1621 | 2682 slow, because a shell must be started. See |expr-env-expand|. |
7 | 2683 The expanded variable is still handled like a list of file |
1621 | 2684 names. When an environment variable cannot be expanded, it is |
7 | 2685 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
2686 "$FOOBAR". | |
2687 | |
2688 See |glob()| for finding existing files. See |system()| for | |
2689 getting the raw output of an external command. | |
2690 | |
102 | 2691 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 2692 {expr1} and {expr2} must be both |Lists| or both |
2693 |Dictionaries|. | |
2694 | |
2695 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 2696 If {expr3} is given insert the items of {expr2} before item |
2697 {expr3} in {expr1}. When {expr3} is zero insert before the | |
2698 first item. When {expr3} is equal to len({expr1}) then | |
2699 {expr2} is appended. | |
79 | 2700 Examples: > |
2701 :echo sort(extend(mylist, [7, 5])) | |
2702 :call extend(mylist, [2, 3], 1) | |
1699 | 2703 < When {expr1} is the same List as {expr2} then the number of |
2704 items copied is equal to the original length of the List. | |
2705 E.g., when {expr3} is 1 you get N new copies of the first item | |
2706 (where N is the original length of the List). | |
2707 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 2708 two lists into a new list use the + operator: > |
79 | 2709 :let newlist = [1, 2, 3] + [4, 5] |
102 | 2710 < |
692 | 2711 If they are |Dictionaries|: |
102 | 2712 Add all entries from {expr2} to {expr1}. |
2713 If a key exists in both {expr1} and {expr2} then {expr3} is | |
2714 used to decide what to do: | |
2715 {expr3} = "keep": keep the value of {expr1} | |
2716 {expr3} = "force": use the value of {expr2} | |
856 | 2717 {expr3} = "error": give an error message *E737* |
102 | 2718 When {expr3} is omitted then "force" is assumed. |
2719 | |
2720 {expr1} is changed when {expr2} is not empty. If necessary | |
2721 make a copy of {expr1} first. | |
2722 {expr2} remains unchanged. | |
2723 Returns {expr1}. | |
2724 | |
79 | 2725 |
842 | 2726 feedkeys({string} [, {mode}]) *feedkeys()* |
2727 Characters in {string} are queued for processing as if they | |
1621 | 2728 come from a mapping or were typed by the user. They are added |
1156 | 2729 to the end of the typeahead buffer, thus if a mapping is still |
842 | 2730 being executed these characters come after them. |
2731 The function does not wait for processing of keys contained in | |
2732 {string}. | |
2733 To include special keys into {string}, use double-quotes | |
2734 and "\..." notation |expr-quote|. For example, | |
1215 | 2735 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 2736 feedkeys('\<CR>') pushes 5 characters. |
2737 If {mode} is absent, keys are remapped. | |
2738 {mode} is a String, which can contain these character flags: | |
843 | 2739 'm' Remap keys. This is default. |
2740 'n' Do not remap keys. | |
2741 't' Handle keys as if typed; otherwise they are handled as | |
2742 if coming from a mapping. This matters for undo, | |
2743 opening folds, etc. | |
842 | 2744 Return value is always 0. |
2745 | |
7 | 2746 filereadable({file}) *filereadable()* |
2747 The result is a Number, which is TRUE when a file with the | |
2748 name {file} exists, and can be read. If {file} doesn't exist, | |
2749 or is a directory, the result is FALSE. {file} is any | |
2750 expression, which is used as a String. | |
1156 | 2751 If you don't care about the file being readable you can use |
2752 |glob()|. | |
7 | 2753 *file_readable()* |
2754 Obsolete name: file_readable(). | |
2755 | |
95 | 2756 |
1156 | 2757 filewritable({file}) *filewritable()* |
2758 The result is a Number, which is 1 when a file with the | |
2759 name {file} exists, and can be written. If {file} doesn't | |
1621 | 2760 exist, or is not writable, the result is 0. If {file} is a |
1156 | 2761 directory, and we can write to it, the result is 2. |
2762 | |
2763 | |
102 | 2764 filter({expr}, {string}) *filter()* |
685 | 2765 {expr} must be a |List| or a |Dictionary|. |
102 | 2766 For each item in {expr} evaluate {string} and when the result |
685 | 2767 is zero remove the item from the |List| or |Dictionary|. |
102 | 2768 Inside {string} |v:val| has the value of the current item. |
685 | 2769 For a |Dictionary| |v:key| has the key of the current item. |
102 | 2770 Examples: > |
2771 :call filter(mylist, 'v:val !~ "OLD"') | |
2772 < Removes the items where "OLD" appears. > | |
2773 :call filter(mydict, 'v:key >= 8') | |
2774 < Removes the items with a key below 8. > | |
2775 :call filter(var, 0) | |
685 | 2776 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 2777 |
102 | 2778 Note that {string} is the result of expression and is then |
2779 used as an expression again. Often it is good to use a | |
2780 |literal-string| to avoid having to double backslashes. | |
2781 | |
685 | 2782 The operation is done in-place. If you want a |List| or |
2783 |Dictionary| to remain unmodified make a copy first: > | |
650 | 2784 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 2785 |
685 | 2786 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 2787 When an error is encountered while evaluating {string} no |
2788 further items in {expr} are processed. | |
95 | 2789 |
2790 | |
19 | 2791 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 2792 Find directory {name} in {path}. Supports both downwards and |
2793 upwards recursive directory searches. See |file-searching| | |
2794 for the syntax of {path}. | |
2795 Returns the path of the first found match. When the found | |
2796 directory is below the current directory a relative path is | |
2797 returned. Otherwise a full path is returned. | |
19 | 2798 If {path} is omitted or empty then 'path' is used. |
2799 If the optional {count} is given, find {count}'s occurrence of | |
794 | 2800 {name} in {path} instead of the first one. |
809 | 2801 When {count} is negative return all the matches in a |List|. |
19 | 2802 This is quite similar to the ex-command |:find|. |
794 | 2803 {only available when compiled with the +file_in_path feature} |
2804 | |
2805 findfile({name}[, {path}[, {count}]]) *findfile()* | |
2806 Just like |finddir()|, but find a file instead of a directory. | |
2807 Uses 'suffixesadd'. | |
19 | 2808 Example: > |
2809 :echo findfile("tags.vim", ".;") | |
1156 | 2810 < Searches from the directory of the current file upwards until |
2811 it finds the file "tags.vim". | |
7 | 2812 |
1621 | 2813 float2nr({expr}) *float2nr()* |
2814 Convert {expr} to a Number by omitting the part after the | |
2815 decimal point. | |
2816 {expr} must evaluate to a |Float| or a Number. | |
2817 When the value of {expr} is out of range for a |Number| the | |
2818 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
2819 in -0x80000000. | |
2820 Examples: > | |
2821 echo float2nr(3.95) | |
2822 < 3 > | |
2823 echo float2nr(-23.45) | |
2824 < -23 > | |
2825 echo float2nr(1.0e100) | |
2826 < 2147483647 > | |
2827 echo float2nr(-1.0e150) | |
2828 < -2147483647 > | |
2829 echo float2nr(1.0e-100) | |
2830 < 0 | |
2831 {only available when compiled with the |+float| feature} | |
2832 | |
2833 | |
2834 floor({expr}) *floor()* | |
2835 Return the largest integral value less than or equal to | |
2836 {expr} as a |Float| (round down). | |
2837 {expr} must evaluate to a |Float| or a |Number|. | |
2838 Examples: > | |
2839 echo floor(1.856) | |
2840 < 1.0 > | |
2841 echo floor(-5.456) | |
2842 < -6.0 > | |
2843 echo floor(4.0) | |
2844 < 4.0 | |
2845 {only available when compiled with the |+float| feature} | |
2846 | |
1586 | 2847 fnameescape({string}) *fnameescape()* |
1621 | 2848 Escape {string} for use as file name command argument. All |
1586 | 2849 characters that have a special meaning, such as '%' and '|' |
2850 are escaped with a backslash. | |
1621 | 2851 For most systems the characters escaped are |
2852 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
2853 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 2854 A leading '+' and '>' is also escaped (special after |:edit| |
2855 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 2856 Example: > |
1700 | 2857 :let fname = '+some str%nge|name' |
1586 | 2858 :exe "edit " . fnameescape(fname) |
2859 < results in executing: > | |
1700 | 2860 edit \+some\ str\%nge\|name |
1586 | 2861 |
7 | 2862 fnamemodify({fname}, {mods}) *fnamemodify()* |
2863 Modify file name {fname} according to {mods}. {mods} is a | |
2864 string of characters like it is used for file names on the | |
2865 command line. See |filename-modifiers|. | |
2866 Example: > | |
2867 :echo fnamemodify("main.c", ":p:h") | |
2868 < results in: > | |
2869 /home/mool/vim/vim/src | |
1621 | 2870 < Note: Environment variables don't work in {fname}, use |
7 | 2871 |expand()| first then. |
2872 | |
2873 foldclosed({lnum}) *foldclosed()* | |
2874 The result is a Number. If the line {lnum} is in a closed | |
2875 fold, the result is the number of the first line in that fold. | |
2876 If the line {lnum} is not in a closed fold, -1 is returned. | |
2877 | |
2878 foldclosedend({lnum}) *foldclosedend()* | |
2879 The result is a Number. If the line {lnum} is in a closed | |
2880 fold, the result is the number of the last line in that fold. | |
2881 If the line {lnum} is not in a closed fold, -1 is returned. | |
2882 | |
2883 foldlevel({lnum}) *foldlevel()* | |
2884 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 2885 in the current buffer. For nested folds the deepest level is |
7 | 2886 returned. If there is no fold at line {lnum}, zero is |
2887 returned. It doesn't matter if the folds are open or closed. | |
2888 When used while updating folds (from 'foldexpr') -1 is | |
2889 returned for lines where folds are still to be updated and the | |
2890 foldlevel is unknown. As a special case the level of the | |
2891 previous line is usually available. | |
2892 | |
2893 *foldtext()* | |
2894 foldtext() Returns a String, to be displayed for a closed fold. This is | |
2895 the default function used for the 'foldtext' option and should | |
2896 only be called from evaluating 'foldtext'. It uses the | |
2897 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
2898 The returned string looks like this: > | |
2899 +-- 45 lines: abcdef | |
1621 | 2900 < The number of dashes depends on the foldlevel. The "45" is |
7 | 2901 the number of lines in the fold. "abcdef" is the text in the |
2902 first non-blank line of the fold. Leading white space, "//" | |
2903 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
2904 options is removed. | |
2905 {not available when compiled without the |+folding| feature} | |
2906 | |
29 | 2907 foldtextresult({lnum}) *foldtextresult()* |
2908 Returns the text that is displayed for the closed fold at line | |
2909 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
2910 When there is no closed fold at {lnum} an empty string is | |
2911 returned. | |
2912 {lnum} is used like with |getline()|. Thus "." is the current | |
2913 line, "'m" mark m, etc. | |
2914 Useful when exporting folded text, e.g., to HTML. | |
2915 {not available when compiled without the |+folding| feature} | |
2916 | |
7 | 2917 *foreground()* |
1621 | 2918 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 2919 a client to a Vim server. |remote_send()| |
2920 On Win32 systems this might not work, the OS does not always | |
2921 allow a window to bring itself to the foreground. Use | |
2922 |remote_foreground()| instead. | |
2923 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
2924 Win32 console version} | |
2925 | |
82 | 2926 |
85 | 2927 function({name}) *function()* *E700* |
685 | 2928 Return a |Funcref| variable that refers to function {name}. |
55 | 2929 {name} can be a user defined function or an internal function. |
2930 | |
82 | 2931 |
1405 | 2932 garbagecollect([at_exit]) *garbagecollect()* |
692 | 2933 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 2934 references. There is hardly ever a need to invoke this |
2935 function, as it is automatically done when Vim runs out of | |
2936 memory or is waiting for the user to press a key after | |
2937 'updatetime'. Items without circular references are always | |
2938 freed when they become unused. | |
685 | 2939 This is useful if you have deleted a very big |List| and/or |
2940 |Dictionary| with circular references in a script that runs | |
2941 for a long time. | |
1405 | 2942 When the optional "at_exit" argument is one, garbage |
2943 collection will also be done when exiting Vim, if it wasn't | |
2944 done before. This is useful when checking for memory leaks. | |
370 | 2945 |
140 | 2946 get({list}, {idx} [, {default}]) *get()* |
685 | 2947 Get item {idx} from |List| {list}. When this item is not |
82 | 2948 available return {default}. Return zero when {default} is |
2949 omitted. | |
102 | 2950 get({dict}, {key} [, {default}]) |
685 | 2951 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 2952 item is not available return {default}. Return zero when |
2953 {default} is omitted. | |
2954 | |
435 | 2955 *getbufline()* |
2956 getbufline({expr}, {lnum} [, {end}]) | |
685 | 2957 Return a |List| with the lines starting from {lnum} to {end} |
2958 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
2959 |List| with only the line {lnum} is returned. | |
435 | 2960 |
2961 For the use of {expr}, see |bufname()| above. | |
2962 | |
448 | 2963 For {lnum} and {end} "$" can be used for the last line of the |
2964 buffer. Otherwise a number must be used. | |
435 | 2965 |
2966 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 2967 lines in the buffer, an empty |List| is returned. |
435 | 2968 |
2969 When {end} is greater than the number of lines in the buffer, | |
2970 it is treated as {end} is set to the number of lines in the | |
685 | 2971 buffer. When {end} is before {lnum} an empty |List| is |
435 | 2972 returned. |
2973 | |
448 | 2974 This function works only for loaded buffers. For unloaded and |
685 | 2975 non-existing buffers, an empty |List| is returned. |
435 | 2976 |
2977 Example: > | |
2978 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 2979 |
2980 getbufvar({expr}, {varname}) *getbufvar()* | |
2981 The result is the value of option or local buffer variable | |
2982 {varname} in buffer {expr}. Note that the name without "b:" | |
2983 must be used. | |
1668 | 2984 When {varname} is empty returns a dictionary with all the |
2985 buffer-local variables. | |
216 | 2986 This also works for a global or buffer-local option, but it |
2987 doesn't work for a global variable, window-local variable or | |
2988 window-local option. | |
82 | 2989 For the use of {expr}, see |bufname()| above. |
2990 When the buffer or variable doesn't exist an empty string is | |
2991 returned, there is no error message. | |
2992 Examples: > | |
2993 :let bufmodified = getbufvar(1, "&mod") | |
2994 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
2995 < | |
7 | 2996 getchar([expr]) *getchar()* |
867 | 2997 Get a single character from the user or input stream. |
7 | 2998 If [expr] is omitted, wait until a character is available. |
2999 If [expr] is 0, only get a character when one is available. | |
867 | 3000 Return zero otherwise. |
7 | 3001 If [expr] is 1, only check if a character is available, it is |
867 | 3002 not consumed. Return zero if no character available. |
3003 | |
3004 Without {expr} and when {expr} is 0 a whole character or | |
3005 special key is returned. If it is an 8-bit character, the | |
3006 result is a number. Use nr2char() to convert it to a String. | |
3007 Otherwise a String is returned with the encoded character. | |
3008 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3009 (decimal: 128). This is the same value as the string |
3010 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3011 String when a modifier (shift, control, alt) was used that is | |
3012 not included in the character. | |
867 | 3013 |
3014 When {expr} is 1 only the first byte is returned. For a | |
872 | 3015 one-byte character it is the character itself as a number. |
3016 Use nr2char() to convert it to a String. | |
867 | 3017 |
1029 | 3018 When the user clicks a mouse button, the mouse event will be |
3019 returned. The position can then be found in |v:mouse_col|, | |
3020 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3021 mouse as it would normally happen: > | |
3022 let c = getchar() | |
1621 | 3023 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3024 exe v:mouse_win . "wincmd w" |
3025 exe v:mouse_lnum | |
3026 exe "normal " . v:mouse_col . "|" | |
3027 endif | |
3028 < | |
7 | 3029 There is no prompt, you will somehow have to make clear to the |
3030 user that a character has to be typed. | |
3031 There is no mapping for the character. | |
3032 Key codes are replaced, thus when the user presses the <Del> | |
3033 key you get the code for the <Del> key, not the raw character | |
3034 sequence. Examples: > | |
3035 getchar() == "\<Del>" | |
3036 getchar() == "\<S-Left>" | |
3037 < This example redefines "f" to ignore case: > | |
3038 :nmap f :call FindChar()<CR> | |
3039 :function FindChar() | |
3040 : let c = nr2char(getchar()) | |
3041 : while col('.') < col('$') - 1 | |
3042 : normal l | |
3043 : if getline('.')[col('.') - 1] ==? c | |
3044 : break | |
3045 : endif | |
3046 : endwhile | |
3047 :endfunction | |
3048 | |
3049 getcharmod() *getcharmod()* | |
3050 The result is a Number which is the state of the modifiers for | |
3051 the last obtained character with getchar() or in another way. | |
3052 These values are added together: | |
3053 2 shift | |
3054 4 control | |
3055 8 alt (meta) | |
3056 16 mouse double click | |
3057 32 mouse triple click | |
3058 64 mouse quadruple click | |
3059 128 Macintosh only: command | |
3060 Only the modifiers that have not been included in the | |
1621 | 3061 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3062 without a modifier. |
7 | 3063 |
3064 getcmdline() *getcmdline()* | |
3065 Return the current command-line. Only works when the command | |
3066 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3067 |c_CTRL-R_=|. | |
3068 Example: > | |
3069 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3070 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3071 |
95 | 3072 getcmdpos() *getcmdpos()* |
7 | 3073 Return the position of the cursor in the command line as a |
3074 byte count. The first column is 1. | |
3075 Only works when editing the command line, thus requires use of | |
3076 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise. | |
531 | 3077 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3078 | |
3079 getcmdtype() *getcmdtype()* | |
3080 Return the current command-line type. Possible return values | |
3081 are: | |
532 | 3082 : normal Ex command |
3083 > debug mode command |debug-mode| | |
3084 / forward search command | |
3085 ? backward search command | |
3086 @ |input()| command | |
3087 - |:insert| or |:append| command | |
531 | 3088 Only works when editing the command line, thus requires use of |
3089 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string | |
3090 otherwise. | |
3091 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. | |
7 | 3092 |
3093 *getcwd()* | |
3094 getcwd() The result is a String, which is the name of the current | |
3095 working directory. | |
3096 | |
3097 getfsize({fname}) *getfsize()* | |
3098 The result is a Number, which is the size in bytes of the | |
3099 given file {fname}. | |
3100 If {fname} is a directory, 0 is returned. | |
3101 If the file {fname} can't be found, -1 is returned. | |
1293 | 3102 If the size of {fname} is too big to fit in a Number then -2 |
3103 is returned. | |
7 | 3104 |
37 | 3105 getfontname([{name}]) *getfontname()* |
3106 Without an argument returns the name of the normal font being | |
3107 used. Like what is used for the Normal highlight group | |
3108 |hl-Normal|. | |
3109 With an argument a check is done whether {name} is a valid | |
3110 font name. If not then an empty string is returned. | |
3111 Otherwise the actual font name is returned, or {name} if the | |
3112 GUI does not support obtaining the real name. | |
824 | 3113 Only works when the GUI is running, thus not in your vimrc or |
819 | 3114 gvimrc file. Use the |GUIEnter| autocommand to use this |
3115 function just after the GUI has started. | |
37 | 3116 Note that the GTK 2 GUI accepts any font name, thus checking |
3117 for a valid name does not work. | |
3118 | |
20 | 3119 getfperm({fname}) *getfperm()* |
3120 The result is a String, which is the read, write, and execute | |
3121 permissions of the given file {fname}. | |
3122 If {fname} does not exist or its directory cannot be read, an | |
3123 empty string is returned. | |
3124 The result is of the form "rwxrwxrwx", where each group of | |
3125 "rwx" flags represent, in turn, the permissions of the owner | |
3126 of the file, the group the file belongs to, and other users. | |
3127 If a user does not have a given permission the flag for this | |
3128 is replaced with the string "-". Example: > | |
3129 :echo getfperm("/etc/passwd") | |
3130 < This will hopefully (from a security point of view) display | |
3131 the string "rw-r--r--" or even "rw-------". | |
205 | 3132 |
7 | 3133 getftime({fname}) *getftime()* |
3134 The result is a Number, which is the last modification time of | |
3135 the given file {fname}. The value is measured as seconds | |
3136 since 1st Jan 1970, and may be passed to strftime(). See also | |
3137 |localtime()| and |strftime()|. | |
3138 If the file {fname} can't be found -1 is returned. | |
3139 | |
20 | 3140 getftype({fname}) *getftype()* |
3141 The result is a String, which is a description of the kind of | |
3142 file of the given file {fname}. | |
3143 If {fname} does not exist an empty string is returned. | |
3144 Here is a table over different kinds of files and their | |
3145 results: | |
3146 Normal file "file" | |
3147 Directory "dir" | |
3148 Symbolic link "link" | |
3149 Block device "bdev" | |
3150 Character device "cdev" | |
3151 Socket "socket" | |
3152 FIFO "fifo" | |
3153 All other "other" | |
3154 Example: > | |
3155 getftype("/home") | |
3156 < Note that a type such as "link" will only be returned on | |
3157 systems that support it. On some systems only "dir" and | |
3158 "file" are returned. | |
3159 | |
7 | 3160 *getline()* |
82 | 3161 getline({lnum} [, {end}]) |
3162 Without {end} the result is a String, which is line {lnum} | |
3163 from the current buffer. Example: > | |
7 | 3164 getline(1) |
3165 < When {lnum} is a String that doesn't start with a | |
3166 digit, line() is called to translate the String into a Number. | |
3167 To get the line under the cursor: > | |
3168 getline(".") | |
3169 < When {lnum} is smaller than 1 or bigger than the number of | |
3170 lines in the buffer, an empty string is returned. | |
3171 | |
685 | 3172 When {end} is given the result is a |List| where each item is |
3173 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3174 including line {end}. |
3175 {end} is used in the same way as {lnum}. | |
3176 Non-existing lines are silently omitted. | |
685 | 3177 When {end} is before {lnum} an empty |List| is returned. |
82 | 3178 Example: > |
3179 :let start = line('.') | |
3180 :let end = search("^$") - 1 | |
3181 :let lines = getline(start, end) | |
3182 | |
1156 | 3183 < To get lines from another buffer see |getbufline()| |
3184 | |
647 | 3185 getloclist({nr}) *getloclist()* |
3186 Returns a list with all the entries in the location list for | |
3187 window {nr}. When {nr} is zero the current window is used. | |
3188 For a location list window, the displayed location list is | |
648 | 3189 returned. For an invalid window number {nr}, an empty list is |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3190 returned. Otherwise, same as |getqflist()|. |
82 | 3191 |
1326 | 3192 getmatches() *getmatches()* |
3193 Returns a |List| with all matches previously defined by | |
3194 |matchadd()| and the |:match| commands. |getmatches()| is | |
3195 useful in combination with |setmatches()|, as |setmatches()| | |
3196 can restore a list of matches saved by |getmatches()|. | |
3197 Example: > | |
3198 :echo getmatches() | |
3199 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3200 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3201 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3202 :let m = getmatches() | |
3203 :call clearmatches() | |
3204 :echo getmatches() | |
3205 < [] > | |
3206 :call setmatches(m) | |
3207 :echo getmatches() | |
3208 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3209 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3210 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3211 :unlet m | |
3212 < | |
3213 | |
230 | 3214 getqflist() *getqflist()* |
3215 Returns a list with all the current quickfix errors. Each | |
3216 list item is a dictionary with these entries: | |
3217 bufnr number of buffer that has the file name, use | |
3218 bufname() to get the name | |
3219 lnum line number in the buffer (first line is 1) | |
3220 col column number (first column is 1) | |
233 | 3221 vcol non-zero: "col" is visual column |
3222 zero: "col" is byte index | |
230 | 3223 nr error number |
1065 | 3224 pattern search pattern used to locate the error |
230 | 3225 text description of the error |
3226 type type of the error, 'E', '1', etc. | |
3227 valid non-zero: recognized error message | |
3228 | |
515 | 3229 When there is no error list or it's empty an empty list is |
1065 | 3230 returned. Quickfix list entries with non-existing buffer |
3231 number are returned with "bufnr" set to zero. | |
515 | 3232 |
230 | 3233 Useful application: Find pattern matches in multiple files and |
3234 do something with them: > | |
3235 :vimgrep /theword/jg *.c | |
3236 :for d in getqflist() | |
3237 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
3238 :endfor | |
3239 | |
3240 | |
282 | 3241 getreg([{regname} [, 1]]) *getreg()* |
7 | 3242 The result is a String, which is the contents of register |
236 | 3243 {regname}. Example: > |
7 | 3244 :let cliptext = getreg('*') |
3245 < getreg('=') returns the last evaluated value of the expression | |
236 | 3246 register. (For use in maps.) |
282 | 3247 getreg('=', 1) returns the expression itself, so that it can |
3248 be restored with |setreg()|. For other registers the extra | |
3249 argument is ignored, thus you can always give it. | |
7 | 3250 If {regname} is not specified, |v:register| is used. |
3251 | |
82 | 3252 |
7 | 3253 getregtype([{regname}]) *getregtype()* |
3254 The result is a String, which is type of register {regname}. | |
3255 The value will be one of: | |
3256 "v" for |characterwise| text | |
3257 "V" for |linewise| text | |
3258 "<CTRL-V>{width}" for |blockwise-visual| text | |
3259 0 for an empty or unknown register | |
3260 <CTRL-V> is one character with value 0x16. | |
3261 If {regname} is not specified, |v:register| is used. | |
3262 | |
831 | 3263 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()* |
1156 | 3264 Get the value of window-local variable {varname} in window |
3265 {winnr} in tab page {tabnr}. | |
3266 When {varname} starts with "&" get the value of a window-local | |
3267 option. | |
831 | 3268 Tabs are numbered starting with one. For the current tabpage |
3269 use |getwinvar()|. | |
3270 When {winnr} is zero the current window is used. | |
3271 This also works for a global option, buffer-local option and | |
3272 window-local option, but it doesn't work for a global variable | |
3273 or buffer-local variable. | |
1156 | 3274 When {varname} is empty a dictionary with all window-local |
3275 variables is returned. | |
3276 Note that {varname} must be the name without "w:". | |
831 | 3277 Examples: > |
3278 :let list_is_on = gettabwinvar(1, 2, '&list') | |
3279 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 3280 < |
7 | 3281 *getwinposx()* |
3282 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
3283 the left hand side of the GUI Vim window. The result will be | |
3284 -1 if the information is not available. | |
3285 | |
3286 *getwinposy()* | |
3287 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 3288 the top of the GUI Vim window. The result will be -1 if the |
7 | 3289 information is not available. |
3290 | |
831 | 3291 getwinvar({winnr}, {varname}) *getwinvar()* |
3292 Like |gettabwinvar()| for the current tabpage. | |
7 | 3293 Examples: > |
3294 :let list_is_on = getwinvar(2, '&list') | |
3295 :echo "myvar = " . getwinvar(1, 'myvar') | |
3296 < | |
1754 | 3297 glob({expr} [, {flag}]) *glob()* |
3298 Expand the file wildcards in {expr}. See |wildcards| for the | |
1156 | 3299 use of special characters. |
3300 The result is a String. | |
7 | 3301 When there are several matches, they are separated by <NL> |
3302 characters. | |
1754 | 3303 Unless the optional {flag} argument is given and is non-zero, |
3304 the 'suffixes' and 'wildignore' options apply: Names matching | |
3305 one of the patterns in 'wildignore' will be skipped and | |
3306 'suffixes' affect the ordering of matches. | |
7 | 3307 If the expansion fails, the result is an empty string. |
3308 A name for a non-existing file is not included. | |
3309 | |
3310 For most systems backticks can be used to get files names from | |
3311 any external command. Example: > | |
3312 :let tagfiles = glob("`find . -name tags -print`") | |
3313 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
3314 < The result of the program inside the backticks should be one | |
1621 | 3315 item per line. Spaces inside an item are allowed. |
7 | 3316 |
3317 See |expand()| for expanding special Vim variables. See | |
3318 |system()| for getting the raw output of an external command. | |
3319 | |
1754 | 3320 globpath({path}, {expr} [, {flag}]) *globpath()* |
7 | 3321 Perform glob() on all directories in {path} and concatenate |
3322 the results. Example: > | |
3323 :echo globpath(&rtp, "syntax/c.vim") | |
3324 < {path} is a comma-separated list of directory names. Each | |
3325 directory name is prepended to {expr} and expanded like with | |
1754 | 3326 |glob()|. A path separator is inserted when needed. |
7 | 3327 To add a comma inside a directory name escape it with a |
3328 backslash. Note that on MS-Windows a directory may have a | |
3329 trailing backslash, remove it if you put a comma after it. | |
3330 If the expansion fails for one of the directories, there is no | |
3331 error message. | |
1754 | 3332 Unless the optional {flag} argument is given and is non-zero, |
3333 the 'suffixes' and 'wildignore' options apply: Names matching | |
3334 one of the patterns in 'wildignore' will be skipped and | |
3335 'suffixes' affect the ordering of matches. | |
7 | 3336 |
444 | 3337 The "**" item can be used to search in a directory tree. |
3338 For example, to find all "README.txt" files in the directories | |
3339 in 'runtimepath' and below: > | |
3340 :echo globpath(&rtp, "**/README.txt") | |
1668 | 3341 < Upwards search and limiting the depth of "**" is not |
3342 supported, thus using 'path' will not always work properly. | |
3343 | |
7 | 3344 *has()* |
3345 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
3346 supported, zero otherwise. The {feature} argument is a | |
3347 string. See |feature-list| below. | |
3348 Also see |exists()|. | |
3349 | |
102 | 3350 |
3351 has_key({dict}, {key}) *has_key()* | |
685 | 3352 The result is a Number, which is 1 if |Dictionary| {dict} has |
3353 an entry with key {key}. Zero otherwise. | |
102 | 3354 |
1104 | 3355 haslocaldir() *haslocaldir()* |
3356 The result is a Number, which is 1 when the current | |
1621 | 3357 window has set a local path via |:lcd|, and 0 otherwise. |
102 | 3358 |
782 | 3359 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 3360 The result is a Number, which is 1 if there is a mapping that |
3361 contains {what} in somewhere in the rhs (what it is mapped to) | |
3362 and this mapping exists in one of the modes indicated by | |
3363 {mode}. | |
782 | 3364 When {abbr} is there and it is non-zero use abbreviations |
786 | 3365 instead of mappings. Don't forget to specify Insert and/or |
3366 Command-line mode. | |
7 | 3367 Both the global mappings and the mappings local to the current |
3368 buffer are checked for a match. | |
3369 If no matching mapping is found 0 is returned. | |
3370 The following characters are recognized in {mode}: | |
3371 n Normal mode | |
3372 v Visual mode | |
3373 o Operator-pending mode | |
3374 i Insert mode | |
3375 l Language-Argument ("r", "f", "t", etc.) | |
3376 c Command-line mode | |
3377 When {mode} is omitted, "nvo" is used. | |
3378 | |
3379 This function is useful to check if a mapping already exists | |
1621 | 3380 to a function in a Vim script. Example: > |
7 | 3381 :if !hasmapto('\ABCdoit') |
3382 : map <Leader>d \ABCdoit | |
3383 :endif | |
3384 < This installs the mapping to "\ABCdoit" only if there isn't | |
3385 already a mapping to "\ABCdoit". | |
3386 | |
3387 histadd({history}, {item}) *histadd()* | |
3388 Add the String {item} to the history {history} which can be | |
3389 one of: *hist-names* | |
3390 "cmd" or ":" command line history | |
3391 "search" or "/" search pattern history | |
1621 | 3392 "expr" or "=" typed expression history |
7 | 3393 "input" or "@" input line history |
3394 If {item} does already exist in the history, it will be | |
3395 shifted to become the newest entry. | |
3396 The result is a Number: 1 if the operation was successful, | |
3397 otherwise 0 is returned. | |
3398 | |
3399 Example: > | |
3400 :call histadd("input", strftime("%Y %b %d")) | |
3401 :let date=input("Enter date: ") | |
3402 < This function is not available in the |sandbox|. | |
3403 | |
3404 histdel({history} [, {item}]) *histdel()* | |
236 | 3405 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 3406 for the possible values of {history}. |
3407 | |
1668 | 3408 If the parameter {item} evaluates to a String, it is used as a |
3409 regular expression. All entries matching that expression will | |
3410 be removed from the history (if there are any). | |
7 | 3411 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 3412 If {item} evaluates to a Number, it will be interpreted as |
3413 an index, see |:history-indexing|. The respective entry will | |
3414 be removed if it exists. | |
7 | 3415 |
3416 The result is a Number: 1 for a successful operation, | |
3417 otherwise 0 is returned. | |
3418 | |
3419 Examples: | |
3420 Clear expression register history: > | |
3421 :call histdel("expr") | |
3422 < | |
3423 Remove all entries starting with "*" from the search history: > | |
3424 :call histdel("/", '^\*') | |
3425 < | |
3426 The following three are equivalent: > | |
3427 :call histdel("search", histnr("search")) | |
3428 :call histdel("search", -1) | |
3429 :call histdel("search", '^'.histget("search", -1).'$') | |
3430 < | |
3431 To delete the last search pattern and use the last-but-one for | |
3432 the "n" command and 'hlsearch': > | |
3433 :call histdel("search", -1) | |
3434 :let @/ = histget("search", -1) | |
3435 | |
3436 histget({history} [, {index}]) *histget()* | |
3437 The result is a String, the entry with Number {index} from | |
3438 {history}. See |hist-names| for the possible values of | |
3439 {history}, and |:history-indexing| for {index}. If there is | |
3440 no such entry, an empty String is returned. When {index} is | |
3441 omitted, the most recent item from the history is used. | |
3442 | |
3443 Examples: | |
3444 Redo the second last search from history. > | |
3445 :execute '/' . histget("search", -2) | |
3446 | |
3447 < Define an Ex command ":H {num}" that supports re-execution of | |
3448 the {num}th entry from the output of |:history|. > | |
3449 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
3450 < | |
3451 histnr({history}) *histnr()* | |
3452 The result is the Number of the current entry in {history}. | |
3453 See |hist-names| for the possible values of {history}. | |
3454 If an error occurred, -1 is returned. | |
3455 | |
3456 Example: > | |
3457 :let inp_index = histnr("expr") | |
3458 < | |
3459 hlexists({name}) *hlexists()* | |
3460 The result is a Number, which is non-zero if a highlight group | |
3461 called {name} exists. This is when the group has been | |
3462 defined in some way. Not necessarily when highlighting has | |
3463 been defined for it, it may also have been used for a syntax | |
3464 item. | |
3465 *highlight_exists()* | |
3466 Obsolete name: highlight_exists(). | |
3467 | |
3468 *hlID()* | |
3469 hlID({name}) The result is a Number, which is the ID of the highlight group | |
3470 with name {name}. When the highlight group doesn't exist, | |
3471 zero is returned. | |
3472 This can be used to retrieve information about the highlight | |
1621 | 3473 group. For example, to get the background color of the |
7 | 3474 "Comment" group: > |
3475 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
3476 < *highlightID()* | |
3477 Obsolete name: highlightID(). | |
3478 | |
3479 hostname() *hostname()* | |
3480 The result is a String, which is the name of the machine on | |
236 | 3481 which Vim is currently running. Machine names greater than |
7 | 3482 256 characters long are truncated. |
3483 | |
3484 iconv({expr}, {from}, {to}) *iconv()* | |
3485 The result is a String, which is the text {expr} converted | |
3486 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3487 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3488 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3489 are replaced with "?". |
7 | 3490 The encoding names are whatever the iconv() library function |
3491 can accept, see ":!man 3 iconv". | |
3492 Most conversions require Vim to be compiled with the |+iconv| | |
3493 feature. Otherwise only UTF-8 to latin1 conversion and back | |
3494 can be done. | |
3495 This can be used to display messages with special characters, | |
3496 no matter what 'encoding' is set to. Write the message in | |
3497 UTF-8 and use: > | |
3498 echo iconv(utf8_str, "utf-8", &enc) | |
3499 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
3500 from/to UCS-2 is automatically changed to use UTF-8. You | |
3501 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
3502 {only available when compiled with the +multi_byte feature} | |
3503 | |
3504 *indent()* | |
3505 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
3506 current buffer. The indent is counted in spaces, the value | |
3507 of 'tabstop' is relevant. {lnum} is used just like in | |
3508 |getline()|. | |
3509 When {lnum} is invalid -1 is returned. | |
3510 | |
79 | 3511 |
95 | 3512 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 3513 Return the lowest index in |List| {list} where the item has a |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3514 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3515 the String "4" is different from the Number 4. And the number |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3516 4 is different from the Float 4.0. The value of 'ignorecase' |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3517 is not used here, case always matters. |
153 | 3518 If {start} is given then start looking at the item with index |
3519 {start} (may be negative for an item relative to the end). | |
79 | 3520 When {ic} is given and it is non-zero, ignore case. Otherwise |
3521 case must match. | |
3522 -1 is returned when {expr} is not found in {list}. | |
3523 Example: > | |
3524 :let idx = index(words, "the") | |
87 | 3525 :if index(numbers, 123) >= 0 |
79 | 3526 |
3527 | |
531 | 3528 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 3529 The result is a String, which is whatever the user typed on |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3530 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3531 string, or a blank string (for no prompt). A '\n' can be used |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3532 in the prompt to start a new line. |
531 | 3533 The highlighting set with |:echohl| is used for the prompt. |
3534 The input is entered just like a command-line, with the same | |
1621 | 3535 editing commands and mappings. There is a separate history |
531 | 3536 for lines typed for input(). |
3537 Example: > | |
3538 :if input("Coffee or beer? ") == "beer" | |
3539 : echo "Cheers!" | |
3540 :endif | |
3541 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3542 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3543 is used for the default reply, as if the user typed this. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3544 Example: > |
531 | 3545 :let color = input("Color? ", "white") |
3546 | |
3547 < The optional {completion} argument specifies the type of | |
3548 completion supported for the input. Without it completion is | |
1621 | 3549 not performed. The supported completion types are the same as |
531 | 3550 that can be supplied to a user-defined command using the |
1621 | 3551 "-complete=" argument. Refer to |:command-completion| for |
531 | 3552 more information. Example: > |
3553 let fname = input("File: ", "", "file") | |
3554 < | |
3555 NOTE: This function must not be used in a startup file, for | |
3556 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 3557 Note: When input() is called from within a mapping it will |
3558 consume remaining characters from that mapping, because a | |
3559 mapping is handled like the characters were typed. | |
3560 Use |inputsave()| before input() and |inputrestore()| | |
3561 after input() to avoid that. Another solution is to avoid | |
3562 that further characters follow in the mapping, e.g., by using | |
3563 |:execute| or |:normal|. | |
3564 | |
531 | 3565 Example with a mapping: > |
7 | 3566 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
3567 :function GetFoo() | |
3568 : call inputsave() | |
3569 : let g:Foo = input("enter search pattern: ") | |
3570 : call inputrestore() | |
3571 :endfunction | |
3572 | |
3573 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3574 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3575 are supported, a dialog window pops up to input the text. |
7 | 3576 Example: > |
3577 :let n = inputdialog("value for shiftwidth", &sw) | |
3578 :if n != "" | |
3579 : let &sw = n | |
3580 :endif | |
3581 < When the dialog is cancelled {cancelreturn} is returned. When | |
3582 omitted an empty string is returned. | |
3583 Hitting <Enter> works like pressing the OK button. Hitting | |
3584 <Esc> works like pressing the Cancel button. | |
531 | 3585 NOTE: Command-line completion is not supported. |
7 | 3586 |
519 | 3587 inputlist({textlist}) *inputlist()* |
819 | 3588 {textlist} must be a |List| of strings. This |List| is |
3589 displayed, one string per line. The user will be prompted to | |
3590 enter a number, which is returned. | |
519 | 3591 The user can also select an item by clicking on it with the |
1621 | 3592 mouse. For the first string 0 is returned. When clicking |
519 | 3593 above the first item a negative number is returned. When |
3594 clicking on the prompt one more than the length of {textlist} | |
3595 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3596 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 3597 it won't work. It's a good idea to put the entry number at |
1156 | 3598 the start of the string. And put a prompt in the first item. |
3599 Example: > | |
519 | 3600 let color = inputlist(['Select color:', '1. red', |
3601 \ '2. green', '3. blue']) | |
3602 | |
7 | 3603 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3604 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 3605 Should be called the same number of times inputsave() is |
3606 called. Calling it more often is harmless though. | |
3607 Returns 1 when there is nothing to restore, 0 otherwise. | |
3608 | |
3609 inputsave() *inputsave()* | |
3610 Preserve typeahead (also from mappings) and clear it, so that | |
3611 a following prompt gets input from the user. Should be | |
3612 followed by a matching inputrestore() after the prompt. Can | |
3613 be used several times, in which case there must be just as | |
3614 many inputrestore() calls. | |
3615 Returns 1 when out of memory, 0 otherwise. | |
3616 | |
3617 inputsecret({prompt} [, {text}]) *inputsecret()* | |
3618 This function acts much like the |input()| function with but | |
3619 two exceptions: | |
3620 a) the user's response will be displayed as a sequence of | |
3621 asterisks ("*") thereby keeping the entry secret, and | |
3622 b) the user's response will not be recorded on the input | |
3623 |history| stack. | |
3624 The result is a String, which is whatever the user actually | |
3625 typed on the command-line in response to the issued prompt. | |
531 | 3626 NOTE: Command-line completion is not supported. |
7 | 3627 |
55 | 3628 insert({list}, {item} [, {idx}]) *insert()* |
685 | 3629 Insert {item} at the start of |List| {list}. |
55 | 3630 If {idx} is specified insert {item} before the item with index |
1621 | 3631 {idx}. If {idx} is zero it goes before the first item, just |
55 | 3632 like omitting {idx}. A negative {idx} is also possible, see |
3633 |list-index|. -1 inserts just before the last item. | |
685 | 3634 Returns the resulting |List|. Examples: > |
55 | 3635 :let mylist = insert([2, 3, 5], 1) |
3636 :call insert(mylist, 4, -1) | |
3637 :call insert(mylist, 6, len(mylist)) | |
82 | 3638 < The last example can be done simpler with |add()|. |
685 | 3639 Note that when {item} is a |List| it is inserted as a single |
692 | 3640 item. Use |extend()| to concatenate |Lists|. |
55 | 3641 |
7 | 3642 isdirectory({directory}) *isdirectory()* |
3643 The result is a Number, which is non-zero when a directory | |
3644 with the name {directory} exists. If {directory} doesn't | |
3645 exist, or isn't a directory, the result is FALSE. {directory} | |
3646 is any expression, which is used as a String. | |
3647 | |
819 | 3648 islocked({expr}) *islocked()* *E786* |
148 | 3649 The result is a Number, which is non-zero when {expr} is the |
3650 name of a locked variable. | |
685 | 3651 {expr} must be the name of a variable, |List| item or |
3652 |Dictionary| entry, not the variable itself! Example: > | |
148 | 3653 :let alist = [0, ['a', 'b'], 2, 3] |
3654 :lockvar 1 alist | |
3655 :echo islocked('alist') " 1 | |
3656 :echo islocked('alist[1]') " 0 | |
3657 | |
3658 < When {expr} is a variable that does not exist you get an error | |
843 | 3659 message. Use |exists()| to check for existence. |
148 | 3660 |
140 | 3661 items({dict}) *items()* |
685 | 3662 Return a |List| with all the key-value pairs of {dict}. Each |
3663 |List| item is a list with two items: the key of a {dict} | |
3664 entry and the value of this entry. The |List| is in arbitrary | |
3665 order. | |
140 | 3666 |
95 | 3667 |
3668 join({list} [, {sep}]) *join()* | |
3669 Join the items in {list} together into one String. | |
3670 When {sep} is specified it is put in between the items. If | |
3671 {sep} is omitted a single space is used. | |
3672 Note that {sep} is not added at the end. You might want to | |
3673 add it there too: > | |
3674 let lines = join(mylist, "\n") . "\n" | |
692 | 3675 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 3676 converted into a string like with |string()|. |
3677 The opposite function is |split()|. | |
3678 | |
99 | 3679 keys({dict}) *keys()* |
685 | 3680 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 3681 arbitrary order. |
3682 | |
85 | 3683 *len()* *E701* |
55 | 3684 len({expr}) The result is a Number, which is the length of the argument. |
3685 When {expr} is a String or a Number the length in bytes is | |
3686 used, as with |strlen()|. | |
685 | 3687 When {expr} is a |List| the number of items in the |List| is |
55 | 3688 returned. |
685 | 3689 When {expr} is a |Dictionary| the number of entries in the |
3690 |Dictionary| is returned. | |
55 | 3691 Otherwise an error is given. |
3692 | |
7 | 3693 *libcall()* *E364* *E368* |
3694 libcall({libname}, {funcname}, {argument}) | |
3695 Call function {funcname} in the run-time library {libname} | |
3696 with single argument {argument}. | |
3697 This is useful to call functions in a library that you | |
3698 especially made to be used with Vim. Since only one argument | |
3699 is possible, calling standard library functions is rather | |
3700 limited. | |
3701 The result is the String returned by the function. If the | |
3702 function returns NULL, this will appear as an empty string "" | |
3703 to Vim. | |
3704 If the function returns a number, use libcallnr()! | |
3705 If {argument} is a number, it is passed to the function as an | |
3706 int; if {argument} is a string, it is passed as a | |
3707 null-terminated string. | |
3708 This function will fail in |restricted-mode|. | |
3709 | |
3710 libcall() allows you to write your own 'plug-in' extensions to | |
3711 Vim without having to recompile the program. It is NOT a | |
3712 means to call system functions! If you try to do so Vim will | |
3713 very probably crash. | |
3714 | |
3715 For Win32, the functions you write must be placed in a DLL | |
3716 and use the normal C calling convention (NOT Pascal which is | |
3717 used in Windows System DLLs). The function must take exactly | |
3718 one parameter, either a character pointer or a long integer, | |
3719 and must return a character pointer or NULL. The character | |
3720 pointer returned must point to memory that will remain valid | |
3721 after the function has returned (e.g. in static data in the | |
3722 DLL). If it points to allocated memory, that memory will | |
3723 leak away. Using a static buffer in the function should work, | |
3724 it's then freed when the DLL is unloaded. | |
3725 | |
3726 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 3727 crash! This also happens if the function returns a number, |
7 | 3728 because Vim thinks it's a pointer. |
3729 For Win32 systems, {libname} should be the filename of the DLL | |
3730 without the ".DLL" suffix. A full path is only required if | |
3731 the DLL is not in the usual places. | |
3732 For Unix: When compiling your own plugins, remember that the | |
3733 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3734 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 3735 feature is present} |
3736 Examples: > | |
3737 :echo libcall("libc.so", "getenv", "HOME") | |
3738 < | |
3739 *libcallnr()* | |
3740 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3741 Just like |libcall()|, but used for a function that returns an |
7 | 3742 int instead of a string. |
3743 {only in Win32 on some Unix versions, when the |+libcall| | |
3744 feature is present} | |
1621 | 3745 Examples: > |
3746 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 3747 :call libcallnr("libc.so", "printf", "Hello World!\n") |
3748 :call libcallnr("libc.so", "sleep", 10) | |
3749 < | |
3750 *line()* | |
3751 line({expr}) The result is a Number, which is the line number of the file | |
3752 position given with {expr}. The accepted positions are: | |
3753 . the cursor position | |
3754 $ the last line in the current buffer | |
3755 'x position of mark x (if the mark is not set, 0 is | |
3756 returned) | |
665 | 3757 w0 first line visible in current window |
3758 w$ last line visible in current window | |
1609 | 3759 v In Visual mode: the start of the Visual area (the |
3760 cursor is the end). When not in Visual mode | |
3761 returns the cursor position. Differs from |'<| in | |
3762 that it's updated right away. | |
1156 | 3763 Note that a mark in another file can be used. The line number |
3764 then applies to another buffer. | |
703 | 3765 To get the column number use |col()|. To get both use |
3766 |getpos()|. | |
7 | 3767 Examples: > |
3768 line(".") line number of the cursor | |
3769 line("'t") line number of mark t | |
3770 line("'" . marker) line number of mark marker | |
3771 < *last-position-jump* | |
3772 This autocommand jumps to the last known position in a file | |
3773 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3774 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 3775 |
7 | 3776 line2byte({lnum}) *line2byte()* |
3777 Return the byte count from the start of the buffer for line | |
3778 {lnum}. This includes the end-of-line character, depending on | |
3779 the 'fileformat' option for the current buffer. The first | |
3780 line returns 1. | |
3781 This can also be used to get the byte count for the line just | |
3782 below the last line: > | |
3783 line2byte(line("$") + 1) | |
3784 < This is the file size plus one. | |
3785 When {lnum} is invalid, or the |+byte_offset| feature has been | |
3786 disabled at compile time, -1 is returned. | |
3787 Also see |byte2line()|, |go| and |:goto|. | |
3788 | |
3789 lispindent({lnum}) *lispindent()* | |
3790 Get the amount of indent for line {lnum} according the lisp | |
3791 indenting rules, as with 'lisp'. | |
3792 The indent is counted in spaces, the value of 'tabstop' is | |
3793 relevant. {lnum} is used just like in |getline()|. | |
3794 When {lnum} is invalid or Vim was not compiled the | |
3795 |+lispindent| feature, -1 is returned. | |
3796 | |
3797 localtime() *localtime()* | |
3798 Return the current time, measured as seconds since 1st Jan | |
3799 1970. See also |strftime()| and |getftime()|. | |
3800 | |
95 | 3801 |
1621 | 3802 log10({expr}) *log10()* |
3803 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
3804 {expr} must evaluate to a |Float| or a |Number|. | |
3805 Examples: > | |
3806 :echo log10(1000) | |
3807 < 3.0 > | |
3808 :echo log10(0.01) | |
3809 < -2.0 | |
3810 {only available when compiled with the |+float| feature} | |
3811 | |
102 | 3812 map({expr}, {string}) *map()* |
685 | 3813 {expr} must be a |List| or a |Dictionary|. |
102 | 3814 Replace each item in {expr} with the result of evaluating |
3815 {string}. | |
3816 Inside {string} |v:val| has the value of the current item. | |
1998 | 3817 For a |Dictionary| |v:key| has the key of the current item |
3818 and for a |List| |v:key| has the index of the current item. | |
102 | 3819 Example: > |
3820 :call map(mylist, '"> " . v:val . " <"') | |
95 | 3821 < This puts "> " before and " <" after each item in "mylist". |
102 | 3822 |
158 | 3823 Note that {string} is the result of an expression and is then |
102 | 3824 used as an expression again. Often it is good to use a |
158 | 3825 |literal-string| to avoid having to double backslashes. You |
3826 still have to double ' quotes | |
102 | 3827 |
685 | 3828 The operation is done in-place. If you want a |List| or |
3829 |Dictionary| to remain unmodified make a copy first: > | |
99 | 3830 :let tlist = map(copy(mylist), ' & . "\t"') |
102 | 3831 |
685 | 3832 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3833 When an error is encountered while evaluating {string} no |
3834 further items in {expr} are processed. | |
95 | 3835 |
3836 | |
782 | 3837 maparg({name}[, {mode} [, {abbr}]]) *maparg()* |
7 | 3838 Return the rhs of mapping {name} in mode {mode}. When there |
3839 is no mapping for {name}, an empty String is returned. | |
644 | 3840 {mode} can be one of these strings: |
7 | 3841 "n" Normal |
3842 "v" Visual | |
3843 "o" Operator-pending | |
3844 "i" Insert | |
3845 "c" Cmd-line | |
3846 "l" langmap |language-mapping| | |
3847 "" Normal, Visual and Operator-pending | |
644 | 3848 When {mode} is omitted, the modes for "" are used. |
782 | 3849 When {abbr} is there and it is non-zero use abbreviations |
3850 instead of mappings. | |
7 | 3851 The {name} can have special key names, like in the ":map" |
3852 command. The returned String has special characters | |
3853 translated like in the output of the ":map" command listing. | |
3854 The mappings local to the current buffer are checked first, | |
3855 then the global mappings. | |
626 | 3856 This function can be used to map a key even when it's already |
3857 mapped, and have it do the original mapping too. Sketch: > | |
3858 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
3859 | |
7 | 3860 |
782 | 3861 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 3862 Check if there is a mapping that matches with {name} in mode |
3863 {mode}. See |maparg()| for {mode} and special names in | |
3864 {name}. | |
782 | 3865 When {abbr} is there and it is non-zero use abbreviations |
3866 instead of mappings. | |
7 | 3867 A match happens with a mapping that starts with {name} and |
3868 with a mapping which is equal to the start of {name}. | |
3869 | |
1621 | 3870 matches mapping "a" "ab" "abc" ~ |
7 | 3871 mapcheck("a") yes yes yes |
3872 mapcheck("abc") yes yes yes | |
3873 mapcheck("ax") yes no no | |
3874 mapcheck("b") no no no | |
3875 | |
3876 The difference with maparg() is that mapcheck() finds a | |
3877 mapping that matches with {name}, while maparg() only finds a | |
3878 mapping for {name} exactly. | |
3879 When there is no mapping that starts with {name}, an empty | |
3880 String is returned. If there is one, the rhs of that mapping | |
3881 is returned. If there are several mappings that start with | |
3882 {name}, the rhs of one of them is returned. | |
3883 The mappings local to the current buffer are checked first, | |
3884 then the global mappings. | |
3885 This function can be used to check if a mapping can be added | |
3886 without being ambiguous. Example: > | |
3887 :if mapcheck("_vv") == "" | |
3888 : map _vv :set guifont=7x13<CR> | |
3889 :endif | |
3890 < This avoids adding the "_vv" mapping when there already is a | |
3891 mapping for "_v" or for "_vvv". | |
3892 | |
19 | 3893 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 3894 When {expr} is a |List| then this returns the index of the |
3895 first item where {pat} matches. Each item is used as a | |
692 | 3896 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 3897 Otherwise, {expr} is used as a String. The result is a |
95 | 3898 Number, which gives the index (byte offset) in {expr} where |
3899 {pat} matches. | |
685 | 3900 A match at the first character or |List| item returns zero. |
19 | 3901 If there is no match -1 is returned. |
3902 Example: > | |
95 | 3903 :echo match("testing", "ing") " results in 4 |
714 | 3904 :echo match([1, 'x'], '\a') " results in 1 |
95 | 3905 < See |string-match| for how {pat} is used. |
170 | 3906 *strpbrk()* |
1621 | 3907 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 3908 :let sepidx = match(line, '[.,;: \t]') |
3909 < *strcasestr()* | |
3910 Vim doesn't have a strcasestr() function. But you can add | |
3911 "\c" to the pattern to ignore case: > | |
3912 :let idx = match(haystack, '\cneedle') | |
3913 < | |
95 | 3914 If {start} is given, the search starts from byte index |
685 | 3915 {start} in a String or item {start} in a |List|. |
7 | 3916 The result, however, is still the index counted from the |
236 | 3917 first character/item. Example: > |
7 | 3918 :echo match("testing", "ing", 2) |
3919 < result is again "4". > | |
3920 :echo match("testing", "ing", 4) | |
3921 < result is again "4". > | |
3922 :echo match("testing", "t", 2) | |
3923 < result is "3". | |
694 | 3924 For a String, if {start} > 0 then it is like the string starts |
703 | 3925 {start} bytes later, thus "^" will match at {start}. Except |
3926 when {count} is given, then it's like matches before the | |
3927 {start} byte are ignored (this is a bit complicated to keep it | |
3928 backwards compatible). | |
95 | 3929 For a String, if {start} < 0, it will be set to 0. For a list |
3930 the index is counted from the end. | |
697 | 3931 If {start} is out of range ({start} > strlen({expr}) for a |
3932 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 3933 |
694 | 3934 When {count} is given use the {count}'th match. When a match |
697 | 3935 is found in a String the search for the next one starts one |
694 | 3936 character further. Thus this example results in 1: > |
3937 echo match("testing", "..", 0, 2) | |
3938 < In a |List| the search continues in the next item. | |
703 | 3939 Note that when {count} is added the way {start} works changes, |
3940 see above. | |
694 | 3941 |
7 | 3942 See |pattern| for the patterns that are accepted. |
3943 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 3944 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 3945 done like 'magic' is set and 'cpoptions' is empty. |
3946 | |
1326 | 3947 *matchadd()* *E798* *E799* *E801* |
3948 matchadd({group}, {pattern}[, {priority}[, {id}]]) | |
3949 Defines a pattern to be highlighted in the current window (a | |
3950 "match"). It will be highlighted with {group}. Returns an | |
3951 identification number (ID), which can be used to delete the | |
3952 match using |matchdelete()|. | |
3953 | |
3954 The optional {priority} argument assigns a priority to the | |
1621 | 3955 match. A match with a high priority will have its |
1326 | 3956 highlighting overrule that of a match with a lower priority. |
3957 A priority is specified as an integer (negative numbers are no | |
3958 exception). If the {priority} argument is not specified, the | |
3959 default priority is 10. The priority of 'hlsearch' is zero, | |
3960 hence all matches with a priority greater than zero will | |
3961 overrule it. Syntax highlighting (see 'syntax') is a separate | |
3962 mechanism, and regardless of the chosen priority a match will | |
3963 always overrule syntax highlighting. | |
3964 | |
3965 The optional {id} argument allows the request for a specific | |
3966 match ID. If a specified ID is already taken, an error | |
3967 message will appear and the match will not be added. An ID | |
3968 is specified as a positive integer (zero excluded). IDs 1, 2 | |
3969 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
3970 respectively. If the {id} argument is not specified, | |
3971 |matchadd()| automatically chooses a free ID. | |
3972 | |
3973 The number of matches is not limited, as it is the case with | |
3974 the |:match| commands. | |
3975 | |
3976 Example: > | |
3977 :highlight MyGroup ctermbg=green guibg=green | |
3978 :let m = matchadd("MyGroup", "TODO") | |
3979 < Deletion of the pattern: > | |
3980 :call matchdelete(m) | |
3981 | |
3982 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 3983 available from |getmatches()|. All matches can be deleted in |
1326 | 3984 one operation by |clearmatches()|. |
819 | 3985 |
3986 matcharg({nr}) *matcharg()* | |
856 | 3987 Selects the {nr} match item, as set with a |:match|, |
819 | 3988 |:2match| or |:3match| command. |
3989 Return a |List| with two elements: | |
3990 The name of the highlight group used | |
3991 The pattern used. | |
3992 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
3993 When there is no match item set returns ['', '']. | |
1326 | 3994 This is useful to save and restore a |:match|. |
3995 Highlighting matches using the |:match| commands are limited | |
3996 to three matches. |matchadd()| does not have this limitation. | |
3997 | |
3998 matchdelete({id}) *matchdelete()* *E802* *E803* | |
3999 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 4000 or one of the |:match| commands. Returns 0 if successful, |
1326 | 4001 otherwise -1. See example for |matchadd()|. All matches can |
4002 be deleted in one operation by |clearmatches()|. | |
819 | 4003 |
19 | 4004 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4005 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4006 after the match. Example: > |
7 | 4007 :echo matchend("testing", "ing") |
4008 < results in "7". | |
170 | 4009 *strspn()* *strcspn()* |
4010 Vim doesn't have a strspn() or strcspn() function, but you can | |
4011 do it with matchend(): > | |
4012 :let span = matchend(line, '[a-zA-Z]') | |
4013 :let span = matchend(line, '[^a-zA-Z]') | |
4014 < Except that -1 is returned when there are no matches. | |
4015 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4016 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4017 :echo matchend("testing", "ing", 2) |
4018 < results in "7". > | |
4019 :echo matchend("testing", "ing", 5) | |
4020 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4021 When {expr} is a |List| the result is equal to |match()|. |
7 | 4022 |
158 | 4023 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4024 Same as |match()|, but return a |List|. The first item in the |
158 | 4025 list is the matched string, same as what matchstr() would |
4026 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 4027 in |:substitute|. When an optional submatch didn't match an |
4028 empty string is used. Example: > | |
4029 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
4030 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 4031 When there is no match an empty list is returned. |
4032 | |
19 | 4033 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 4034 Same as |match()|, but return the matched string. Example: > |
7 | 4035 :echo matchstr("testing", "ing") |
4036 < results in "ing". | |
4037 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4038 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4039 :echo matchstr("testing", "ing", 2) |
4040 < results in "ing". > | |
4041 :echo matchstr("testing", "ing", 5) | |
4042 < result is "". | |
685 | 4043 When {expr} is a |List| then the matching item is returned. |
95 | 4044 The type isn't changed, it's not necessarily a String. |
7 | 4045 |
87 | 4046 *max()* |
4047 max({list}) Return the maximum value of all items in {list}. | |
4048 If {list} is not a list or one of the items in {list} cannot | |
4049 be used as a Number this results in an error. | |
685 | 4050 An empty |List| results in zero. |
87 | 4051 |
4052 *min()* | |
1215 | 4053 min({list}) Return the minimum value of all items in {list}. |
87 | 4054 If {list} is not a list or one of the items in {list} cannot |
4055 be used as a Number this results in an error. | |
685 | 4056 An empty |List| results in zero. |
87 | 4057 |
843 | 4058 *mkdir()* *E739* |
168 | 4059 mkdir({name} [, {path} [, {prot}]]) |
4060 Create directory {name}. | |
4061 If {path} is "p" then intermediate directories are created as | |
4062 necessary. Otherwise it must be "". | |
4063 If {prot} is given it is used to set the protection bits of | |
4064 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 4065 the user readable for others). Use 0700 to make it unreadable |
1702 | 4066 for others. This is only used for the last part of {name}. |
4067 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
4068 with 0755. | |
4069 Example: > | |
4070 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
4071 < This function is not available in the |sandbox|. | |
168 | 4072 Not available on all systems. To check use: > |
4073 :if exists("*mkdir") | |
4074 < | |
7 | 4075 *mode()* |
1621 | 4076 mode([expr]) Return a string that indicates the current mode. |
1661 | 4077 If [expr] is supplied and it evaluates to a non-zero Number or |
4078 a non-empty String (|non-zero-arg|), then the full mode is | |
4079 returned, otherwise only the first letter is returned. Note | |
4080 that " " and "0" are also non-empty strings. | |
1621 | 4081 |
7 | 4082 n Normal |
1621 | 4083 no Operator-pending |
7 | 4084 v Visual by character |
4085 V Visual by line | |
4086 CTRL-V Visual blockwise | |
4087 s Select by character | |
4088 S Select by line | |
4089 CTRL-S Select blockwise | |
4090 i Insert | |
1621 | 4091 R Replace |R| |
4092 Rv Virtual Replace |gR| | |
7 | 4093 c Command-line |
1621 | 4094 cv Vim Ex mode |gQ| |
4095 ce Normal Ex mode |Q| | |
7 | 4096 r Hit-enter prompt |
1621 | 4097 rm The -- more -- prompt |
4098 r? A |:confirm| query of some sort | |
4099 ! Shell or external command is executing | |
4100 This is useful in the 'statusline' option or when used | |
4101 with |remote_expr()| In most other places it always returns | |
4102 "c" or "n". | |
4103 Also see |visualmode()|. | |
7 | 4104 |
4105 nextnonblank({lnum}) *nextnonblank()* | |
4106 Return the line number of the first line at or below {lnum} | |
4107 that is not blank. Example: > | |
4108 if getline(nextnonblank(1)) =~ "Java" | |
4109 < When {lnum} is invalid or there is no non-blank line at or | |
4110 below it, zero is returned. | |
4111 See also |prevnonblank()|. | |
4112 | |
4113 nr2char({expr}) *nr2char()* | |
4114 Return a string with a single character, which has the number | |
4115 value {expr}. Examples: > | |
4116 nr2char(64) returns "@" | |
4117 nr2char(32) returns " " | |
4118 < The current 'encoding' is used. Example for "utf-8": > | |
4119 nr2char(300) returns I with bow character | |
4120 < Note that a NUL character in the file is specified with | |
4121 nr2char(10), because NULs are represented with newline | |
4122 characters. nr2char(0) is a real NUL and terminates the | |
119 | 4123 string, thus results in an empty string. |
7 | 4124 |
1548 | 4125 *getpid()* |
4126 getpid() Return a Number which is the process ID of the Vim process. | |
1621 | 4127 On Unix and MS-Windows this is a unique number, until Vim |
4128 exits. On MS-DOS it's always zero. | |
1548 | 4129 |
703 | 4130 *getpos()* |
707 | 4131 getpos({expr}) Get the position for {expr}. For possible values of {expr} |
4132 see |line()|. | |
4133 The result is a |List| with four numbers: | |
4134 [bufnum, lnum, col, off] | |
4135 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
4136 is the buffer number of the mark. | |
4137 "lnum" and "col" are the position in the buffer. The first | |
4138 column is 1. | |
703 | 4139 The "off" number is zero, unless 'virtualedit' is used. Then |
4140 it is the offset in screen columns from the start of the | |
1266 | 4141 character. E.g., a position within a <Tab> or after the last |
703 | 4142 character. |
4143 This can be used to save and restore the cursor position: > | |
4144 let save_cursor = getpos(".") | |
4145 MoveTheCursorAround | |
798 | 4146 call setpos('.', save_cursor) |
707 | 4147 < Also see |setpos()|. |
703 | 4148 |
819 | 4149 pathshorten({expr}) *pathshorten()* |
4150 Shorten directory names in the path {expr} and return the | |
4151 result. The tail, the file name, is kept as-is. The other | |
4152 components in the path are reduced to single letters. Leading | |
4153 '~' and '.' characters are kept. Example: > | |
4154 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
4155 < ~/.v/a/myfile.vim ~ | |
4156 It doesn't matter if the path exists or not. | |
4157 | |
1621 | 4158 pow({x}, {y}) *pow()* |
4159 Return the power of {x} to the exponent {y} as a |Float|. | |
4160 {x} and {y} must evaluate to a |Float| or a |Number|. | |
4161 Examples: > | |
4162 :echo pow(3, 3) | |
4163 < 27.0 > | |
4164 :echo pow(2, 16) | |
4165 < 65536.0 > | |
4166 :echo pow(32, 0.20) | |
4167 < 2.0 | |
4168 {only available when compiled with the |+float| feature} | |
4169 | |
667 | 4170 prevnonblank({lnum}) *prevnonblank()* |
4171 Return the line number of the first line at or above {lnum} | |
4172 that is not blank. Example: > | |
4173 let ind = indent(prevnonblank(v:lnum - 1)) | |
4174 < When {lnum} is invalid or there is no non-blank line at or | |
4175 above it, zero is returned. | |
4176 Also see |nextnonblank()|. | |
4177 | |
4178 | |
449 | 4179 printf({fmt}, {expr1} ...) *printf()* |
4180 Return a String with {fmt}, where "%" items are replaced by | |
4181 the formatted form of their respective arguments. Example: > | |
452 | 4182 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 4183 < May result in: |
452 | 4184 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 4185 |
4186 Often used items are: | |
856 | 4187 %s string |
653 | 4188 %6s string right-aligned in 6 bytes |
1621 | 4189 %.9s string truncated to 9 bytes |
4190 %c single byte | |
4191 %d decimal number | |
4192 %5d decimal number padded with spaces to 5 characters | |
4193 %x hex number | |
4194 %04x hex number padded with zeros to at least 4 characters | |
4195 %X hex number using upper case letters | |
4196 %o octal number | |
4197 %f floating point number in the form 123.456 | |
4198 %e floating point number in the form 1.234e3 | |
4199 %E floating point number in the form 1.234E3 | |
4200 %g floating point number, as %f or %e depending on value | |
4201 %G floating point number, as %f or %E depending on value | |
4202 %% the % character itself | |
449 | 4203 |
4204 Conversion specifications start with '%' and end with the | |
4205 conversion type. All other characters are copied unchanged to | |
4206 the result. | |
4207 | |
4208 The "%" starts a conversion specification. The following | |
452 | 4209 arguments appear in sequence: |
4210 | |
4211 % [flags] [field-width] [.precision] type | |
4212 | |
856 | 4213 flags |
452 | 4214 Zero or more of the following flags: |
4215 | |
449 | 4216 # The value should be converted to an "alternate |
4217 form". For c, d, and s conversions, this option | |
4218 has no effect. For o conversions, the precision | |
4219 of the number is increased to force the first | |
4220 character of the output string to a zero (except | |
4221 if a zero value is printed with an explicit | |
4222 precision of zero). | |
4223 For x and X conversions, a non-zero result has | |
4224 the string "0x" (or "0X" for X conversions) | |
4225 prepended to it. | |
452 | 4226 |
449 | 4227 0 (zero) Zero padding. For all conversions the converted |
4228 value is padded on the left with zeros rather | |
4229 than blanks. If a precision is given with a | |
4230 numeric conversion (d, o, x, and X), the 0 flag | |
4231 is ignored. | |
452 | 4232 |
449 | 4233 - A negative field width flag; the converted value |
4234 is to be left adjusted on the field boundary. | |
4235 The converted value is padded on the right with | |
4236 blanks, rather than on the left with blanks or | |
4237 zeros. A - overrides a 0 if both are given. | |
452 | 4238 |
449 | 4239 ' ' (space) A blank should be left before a positive |
4240 number produced by a signed conversion (d). | |
452 | 4241 |
449 | 4242 + A sign must always be placed before a number |
1621 | 4243 produced by a signed conversion. A + overrides |
449 | 4244 a space if both are used. |
452 | 4245 |
4246 field-width | |
4247 An optional decimal digit string specifying a minimum | |
653 | 4248 field width. If the converted value has fewer bytes |
4249 than the field width, it will be padded with spaces on | |
4250 the left (or right, if the left-adjustment flag has | |
4251 been given) to fill out the field width. | |
452 | 4252 |
4253 .precision | |
4254 An optional precision, in the form of a period '.' | |
4255 followed by an optional digit string. If the digit | |
4256 string is omitted, the precision is taken as zero. | |
4257 This gives the minimum number of digits to appear for | |
4258 d, o, x, and X conversions, or the maximum number of | |
653 | 4259 bytes to be printed from a string for s conversions. |
1621 | 4260 For floating point it is the number of digits after |
4261 the decimal point. | |
452 | 4262 |
4263 type | |
4264 A character that specifies the type of conversion to | |
4265 be applied, see below. | |
4266 | |
449 | 4267 A field width or precision, or both, may be indicated by an |
4268 asterisk '*' instead of a digit string. In this case, a | |
1621 | 4269 Number argument supplies the field width or precision. A |
449 | 4270 negative field width is treated as a left adjustment flag |
4271 followed by a positive field width; a negative precision is | |
4272 treated as though it were missing. Example: > | |
452 | 4273 :echo printf("%d: %.*s", nr, width, line) |
449 | 4274 < This limits the length of the text used from "line" to |
452 | 4275 "width" bytes. |
449 | 4276 |
856 | 4277 The conversion specifiers and their meanings are: |
452 | 4278 |
1621 | 4279 *printf-d* *printf-o* *printf-x* *printf-X* |
4280 doxX The Number argument is converted to signed decimal | |
449 | 4281 (d), unsigned octal (o), or unsigned hexadecimal (x |
4282 and X) notation. The letters "abcdef" are used for | |
4283 x conversions; the letters "ABCDEF" are used for X | |
452 | 4284 conversions. |
4285 The precision, if any, gives the minimum number of | |
4286 digits that must appear; if the converted value | |
4287 requires fewer digits, it is padded on the left with | |
4288 zeros. | |
4289 In no case does a non-existent or small field width | |
4290 cause truncation of a numeric field; if the result of | |
4291 a conversion is wider than the field width, the field | |
4292 is expanded to contain the conversion result. | |
4293 | |
1621 | 4294 *printf-c* |
452 | 4295 c The Number argument is converted to a byte, and the |
4296 resulting character is written. | |
4297 | |
1621 | 4298 *printf-s* |
452 | 4299 s The text of the String argument is used. If a |
4300 precision is specified, no more bytes than the number | |
4301 specified are used. | |
4302 | |
1621 | 4303 *printf-f* *E807* |
4304 f The Float argument is converted into a string of the | |
4305 form 123.456. The precision specifies the number of | |
4306 digits after the decimal point. When the precision is | |
4307 zero the decimal point is omitted. When the precision | |
4308 is not specified 6 is used. A really big number | |
4309 (out of range or dividing by zero) results in "inf". | |
4310 "0.0 / 0.0" results in "nan". | |
4311 Example: > | |
4312 echo printf("%.2f", 12.115) | |
4313 < 12.12 | |
4314 Note that roundoff depends on the system libraries. | |
4315 Use |round()| when in doubt. | |
4316 | |
4317 *printf-e* *printf-E* | |
4318 e E The Float argument is converted into a string of the | |
4319 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
4320 precision specifies the number of digits after the | |
4321 decimal point, like with 'f'. | |
4322 | |
4323 *printf-g* *printf-G* | |
4324 g G The Float argument is converted like with 'f' if the | |
4325 value is between 0.001 (inclusive) and 10000000.0 | |
4326 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
4327 for 'G'. When no precision is specified superfluous | |
4328 zeroes and '+' signs are removed, except for the zero | |
4329 immediately after the decimal point. Thus 10000000.0 | |
4330 results in 1.0e7. | |
4331 | |
4332 *printf-%* | |
449 | 4333 % A '%' is written. No argument is converted. The |
4334 complete conversion specification is "%%". | |
452 | 4335 |
1668 | 4336 When a Number argument is expected a String argument is also |
4337 accepted and automatically converted. | |
4338 When a Float or String argument is expected a Number argument | |
4339 is also accepted and automatically converted. | |
4340 Any other argument type results in an error message. | |
449 | 4341 |
459 | 4342 *E766* *E767* |
449 | 4343 The number of {exprN} arguments must exactly match the number |
4344 of "%" items. If there are not sufficient or too many | |
452 | 4345 arguments an error is given. Up to 18 arguments can be used. |
449 | 4346 |
4347 | |
667 | 4348 pumvisible() *pumvisible()* |
4349 Returns non-zero when the popup menu is visible, zero | |
4350 otherwise. See |ins-completion-menu|. | |
712 | 4351 This can be used to avoid some things that would remove the |
4352 popup menu. | |
7 | 4353 |
114 | 4354 *E726* *E727* |
99 | 4355 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 4356 Returns a |List| with Numbers: |
99 | 4357 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
4358 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
4359 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
4360 {max}] (increasing {expr} with {stride} each time, not | |
4361 producing a value past {max}). | |
336 | 4362 When the maximum is one before the start the result is an |
4363 empty list. When the maximum is more than one before the | |
4364 start this is an error. | |
99 | 4365 Examples: > |
856 | 4366 range(4) " [0, 1, 2, 3] |
99 | 4367 range(2, 4) " [2, 3, 4] |
4368 range(2, 9, 3) " [2, 5, 8] | |
856 | 4369 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 4370 range(0) " [] |
4371 range(2, 0) " error! | |
99 | 4372 < |
158 | 4373 *readfile()* |
168 | 4374 readfile({fname} [, {binary} [, {max}]]) |
685 | 4375 Read file {fname} and return a |List|, each line of the file |
4376 as an item. Lines broken at NL characters. Macintosh files | |
158 | 4377 separated with CR will result in a single long line (unless a |
4378 NL appears somewhere). | |
4379 When {binary} is equal to "b" binary mode is used: | |
4380 - When the last line ends in a NL an extra empty list item is | |
4381 added. | |
4382 - No CR characters are removed. | |
4383 Otherwise: | |
4384 - CR characters that appear before a NL are removed. | |
4385 - Whether the last line ends in a NL or not does not matter. | |
4386 All NUL characters are replaced with a NL character. | |
168 | 4387 When {max} is given this specifies the maximum number of lines |
4388 to be read. Useful if you only want to check the first ten | |
4389 lines of a file: > | |
4390 :for line in readfile(fname, '', 10) | |
4391 : if line =~ 'Date' | echo line | endif | |
4392 :endfor | |
233 | 4393 < When {max} is negative -{max} lines from the end of the file |
4394 are returned, or as many as there are. | |
4395 When {max} is zero the result is an empty list. | |
168 | 4396 Note that without {max} the whole file is read into memory. |
4397 Also note that there is no recognition of encoding. Read a | |
4398 file into a buffer if you need to. | |
158 | 4399 When the file can't be opened an error message is given and |
4400 the result is an empty list. | |
4401 Also see |writefile()|. | |
4402 | |
794 | 4403 reltime([{start} [, {end}]]) *reltime()* |
4404 Return an item that represents a time value. The format of | |
4405 the item depends on the system. It can be passed to | |
4406 |reltimestr()| to convert it to a string. | |
4407 Without an argument it returns the current time. | |
4408 With one argument is returns the time passed since the time | |
4409 specified in the argument. | |
843 | 4410 With two arguments it returns the time passed between {start} |
794 | 4411 and {end}. |
4412 The {start} and {end} arguments must be values returned by | |
4413 reltime(). | |
4414 {only available when compiled with the +reltime feature} | |
4415 | |
4416 reltimestr({time}) *reltimestr()* | |
4417 Return a String that represents the time value of {time}. | |
4418 This is the number of seconds, a dot and the number of | |
4419 microseconds. Example: > | |
4420 let start = reltime() | |
4421 call MyFunction() | |
4422 echo reltimestr(reltime(start)) | |
4423 < Note that overhead for the commands will be added to the time. | |
4424 The accuracy depends on the system. | |
1156 | 4425 Leading spaces are used to make the string align nicely. You |
4426 can use split() to remove it. > | |
4427 echo split(reltimestr(reltime(start)))[0] | |
4428 < Also see |profiling|. | |
794 | 4429 {only available when compiled with the +reltime feature} |
4430 | |
7 | 4431 *remote_expr()* *E449* |
4432 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 4433 Send the {string} to {server}. The string is sent as an |
7 | 4434 expression and the result is returned after evaluation. |
714 | 4435 The result must be a String or a |List|. A |List| is turned |
4436 into a String by joining the items with a line break in | |
4437 between (not at the end), like with join(expr, "\n"). | |
7 | 4438 If {idvar} is present, it is taken as the name of a |
4439 variable and a {serverid} for later use with | |
4440 remote_read() is stored there. | |
4441 See also |clientserver| |RemoteReply|. | |
4442 This function is not available in the |sandbox|. | |
4443 {only available when compiled with the |+clientserver| feature} | |
4444 Note: Any errors will cause a local error message to be issued | |
4445 and the result will be the empty string. | |
4446 Examples: > | |
4447 :echo remote_expr("gvim", "2+2") | |
4448 :echo remote_expr("gvim1", "b:current_syntax") | |
4449 < | |
4450 | |
4451 remote_foreground({server}) *remote_foreground()* | |
4452 Move the Vim server with the name {server} to the foreground. | |
4453 This works like: > | |
4454 remote_expr({server}, "foreground()") | |
4455 < Except that on Win32 systems the client does the work, to work | |
4456 around the problem that the OS doesn't always allow the server | |
4457 to bring itself to the foreground. | |
574 | 4458 Note: This does not restore the window if it was minimized, |
4459 like foreground() does. | |
7 | 4460 This function is not available in the |sandbox|. |
4461 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
4462 Win32 console version} | |
4463 | |
4464 | |
4465 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
4466 Returns a positive number if there are available strings | |
4467 from {serverid}. Copies any reply string into the variable | |
1621 | 4468 {retvar} if specified. {retvar} must be a string with the |
7 | 4469 name of a variable. |
4470 Returns zero if none are available. | |
4471 Returns -1 if something is wrong. | |
4472 See also |clientserver|. | |
4473 This function is not available in the |sandbox|. | |
4474 {only available when compiled with the |+clientserver| feature} | |
4475 Examples: > | |
4476 :let repl = "" | |
4477 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
4478 | |
4479 remote_read({serverid}) *remote_read()* | |
4480 Return the oldest available reply from {serverid} and consume | |
4481 it. It blocks until a reply is available. | |
4482 See also |clientserver|. | |
4483 This function is not available in the |sandbox|. | |
4484 {only available when compiled with the |+clientserver| feature} | |
4485 Example: > | |
4486 :echo remote_read(id) | |
4487 < | |
4488 *remote_send()* *E241* | |
4489 remote_send({server}, {string} [, {idvar}]) | |
1621 | 4490 Send the {string} to {server}. The string is sent as input |
22 | 4491 keys and the function returns immediately. At the Vim server |
4492 the keys are not mapped |:map|. | |
667 | 4493 If {idvar} is present, it is taken as the name of a variable |
4494 and a {serverid} for later use with remote_read() is stored | |
4495 there. | |
7 | 4496 See also |clientserver| |RemoteReply|. |
4497 This function is not available in the |sandbox|. | |
4498 {only available when compiled with the |+clientserver| feature} | |
4499 Note: Any errors will be reported in the server and may mess | |
4500 up the display. | |
4501 Examples: > | |
4502 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
4503 \ remote_read(serverid) | |
4504 | |
4505 :autocmd NONE RemoteReply * | |
4506 \ echo remote_read(expand("<amatch>")) | |
4507 :echo remote_send("gvim", ":sleep 10 | echo ". | |
4508 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 4509 < |
79 | 4510 remove({list}, {idx} [, {end}]) *remove()* |
685 | 4511 Without {end}: Remove the item at {idx} from |List| {list} and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4512 return the item. |
79 | 4513 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4514 return a List with these items. When {idx} points to the same |
79 | 4515 item as {end} a list with one item is returned. When {end} |
4516 points to an item before {idx} this is an error. | |
4517 See |list-index| for possible values of {idx} and {end}. | |
55 | 4518 Example: > |
4519 :echo "last item: " . remove(mylist, -1) | |
79 | 4520 :call remove(mylist, 0, 9) |
99 | 4521 remove({dict}, {key}) |
4522 Remove the entry from {dict} with key {key}. Example: > | |
4523 :echo "removed " . remove(dict, "one") | |
4524 < If there is no {key} in {dict} this is an error. | |
4525 | |
4526 Use |delete()| to remove a file. | |
55 | 4527 |
7 | 4528 rename({from}, {to}) *rename()* |
4529 Rename the file by the name {from} to the name {to}. This | |
4530 should also work to move files across file systems. The | |
4531 result is a Number, which is 0 if the file was renamed | |
4532 successfully, and non-zero when the renaming failed. | |
1851 | 4533 NOTE: If {to} exists it is overwritten without warning. |
7 | 4534 This function is not available in the |sandbox|. |
4535 | |
18 | 4536 repeat({expr}, {count}) *repeat()* |
4537 Repeat {expr} {count} times and return the concatenated | |
4538 result. Example: > | |
843 | 4539 :let separator = repeat('-', 80) |
18 | 4540 < When {count} is zero or negative the result is empty. |
685 | 4541 When {expr} is a |List| the result is {expr} concatenated |
1621 | 4542 {count} times. Example: > |
79 | 4543 :let longlist = repeat(['a', 'b'], 3) |
4544 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 4545 |
82 | 4546 |
7 | 4547 resolve({filename}) *resolve()* *E655* |
4548 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
4549 returns the path the shortcut points to in a simplified form. | |
4550 On Unix, repeat resolving symbolic links in all path | |
4551 components of {filename} and return the simplified result. | |
4552 To cope with link cycles, resolving of symbolic links is | |
4553 stopped after 100 iterations. | |
4554 On other systems, return the simplified {filename}. | |
4555 The simplification step is done as by |simplify()|. | |
4556 resolve() keeps a leading path component specifying the | |
4557 current directory (provided the result is still a relative | |
4558 path name) and also keeps a trailing path separator. | |
4559 | |
82 | 4560 *reverse()* |
1621 | 4561 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 4562 {list}. |
4563 If you want a list to remain unmodified make a copy first: > | |
4564 :let revlist = reverse(copy(mylist)) | |
4565 | |
1621 | 4566 round({expr}) *round()* |
1668 | 4567 Round off {expr} to the nearest integral value and return it |
1621 | 4568 as a |Float|. If {expr} lies halfway between two integral |
4569 values, then use the larger one (away from zero). | |
4570 {expr} must evaluate to a |Float| or a |Number|. | |
4571 Examples: > | |
4572 echo round(0.456) | |
4573 < 0.0 > | |
4574 echo round(4.5) | |
4575 < 5.0 > | |
4576 echo round(-4.5) | |
4577 < -5.0 | |
4578 {only available when compiled with the |+float| feature} | |
4579 | |
4580 | |
1496 | 4581 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 4582 Search for regexp pattern {pattern}. The search starts at the |
119 | 4583 cursor position (you can use |cursor()| to set it). |
707 | 4584 |
7 | 4585 {flags} is a String, which can contain these character flags: |
4586 'b' search backward instead of forward | |
1621 | 4587 'c' accept a match at the cursor position |
712 | 4588 'e' move to the End of the match |
20 | 4589 'n' do Not move the cursor |
712 | 4590 'p' return number of matching sub-pattern (see below) |
4591 's' set the ' mark at the previous location of the cursor | |
7 | 4592 'w' wrap around the end of the file |
4593 'W' don't wrap around the end of the file | |
4594 If neither 'w' or 'W' is given, the 'wrapscan' option applies. | |
4595 | |
444 | 4596 If the 's' flag is supplied, the ' mark is set, only if the |
4597 cursor is moved. The 's' flag cannot be combined with the 'n' | |
4598 flag. | |
4599 | |
1156 | 4600 'ignorecase', 'smartcase' and 'magic' are used. |
4601 | |
692 | 4602 When the {stopline} argument is given then the search stops |
4603 after searching this line. This is useful to restrict the | |
4604 search to a range of lines. Examples: > | |
4605 let match = search('(', 'b', line("w0")) | |
4606 let end = search('END', '', line("w$")) | |
4607 < When {stopline} is used and it is not zero this also implies | |
4608 that the search does not wrap around the end of the file. | |
1496 | 4609 A zero value is equal to not giving the argument. |
4610 | |
4611 When the {timeout} argument is given the search stops when | |
1621 | 4612 more than this many milli seconds have passed. Thus when |
1496 | 4613 {timeout} is 500 the search stops after half a second. |
4614 The value must not be negative. A zero value is like not | |
4615 giving the argument. | |
4616 {only available when compiled with the +reltime feature} | |
692 | 4617 |
712 | 4618 If there is no match a 0 is returned and the cursor doesn't |
4619 move. No error message is given. | |
714 | 4620 When a match has been found its line number is returned. |
4621 *search()-sub-match* | |
4622 With the 'p' flag the returned value is one more than the | |
4623 first sub-match in \(\). One if none of them matched but the | |
4624 whole pattern did match. | |
712 | 4625 To get the column number too use |searchpos()|. |
4626 | |
20 | 4627 The cursor will be positioned at the match, unless the 'n' |
707 | 4628 flag is used. |
7 | 4629 |
4630 Example (goes over all files in the argument list): > | |
4631 :let n = 1 | |
4632 :while n <= argc() " loop over all files in arglist | |
4633 : exe "argument " . n | |
4634 : " start at the last char in the file and wrap for the | |
4635 : " first search to find match at start of file | |
4636 : normal G$ | |
4637 : let flags = "w" | |
4638 : while search("foo", flags) > 0 | |
1621 | 4639 : s/foo/bar/g |
7 | 4640 : let flags = "W" |
4641 : endwhile | |
4642 : update " write the file if modified | |
4643 : let n = n + 1 | |
4644 :endwhile | |
4645 < | |
712 | 4646 Example for using some flags: > |
4647 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
4648 < This will search for the keywords "if", "else", and "endif" | |
4649 under or after the cursor. Because of the 'p' flag, it | |
4650 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
4651 if the search fails. With the cursor on the first word of the | |
4652 line: | |
4653 if (foo == 0) | let foo = foo + 1 | endif ~ | |
4654 the function returns 1. Without the 'c' flag, the function | |
4655 finds the "endif" and returns 3. The same thing happens | |
4656 without the 'e' flag if the cursor is on the "f" of "if". | |
4657 The 'n' flag tells the function not to move the cursor. | |
4658 | |
504 | 4659 |
523 | 4660 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
4661 Search for the declaration of {name}. | |
856 | 4662 |
523 | 4663 With a non-zero {global} argument it works like |gD|, find |
4664 first match in the file. Otherwise it works like |gd|, find | |
4665 first match in the function. | |
4666 | |
4667 With a non-zero {thisblock} argument matches in a {} block | |
4668 that ends before the cursor position are ignored. Avoids | |
4669 finding variable declarations only valid in another scope. | |
4670 | |
504 | 4671 Moves the cursor to the found match. |
4672 Returns zero for success, non-zero for failure. | |
4673 Example: > | |
4674 if searchdecl('myvar') == 0 | |
4675 echo getline('.') | |
4676 endif | |
4677 < | |
7 | 4678 *searchpair()* |
1496 | 4679 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
4680 [, {stopline} [, {timeout}]]]]) | |
7 | 4681 Search for the match of a nested start-end pair. This can be |
4682 used to find the "endif" that matches an "if", while other | |
4683 if/endif pairs in between are ignored. | |
677 | 4684 The search starts at the cursor. The default is to search |
4685 forward, include 'b' in {flags} to search backward. | |
4686 If a match is found, the cursor is positioned at it and the | |
4687 line number is returned. If no match is found 0 or -1 is | |
4688 returned and the cursor doesn't move. No error message is | |
4689 given. | |
7 | 4690 |
4691 {start}, {middle} and {end} are patterns, see |pattern|. They | |
4692 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
4693 {middle} is not empty, it is found when searching from either | |
4694 direction, but only when not in a nested start-end pair. A | |
4695 typical use is: > | |
4696 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
4697 < By leaving {middle} empty the "else" is skipped. | |
4698 | |
712 | 4699 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
4700 |search()|. Additionally: | |
7 | 4701 'r' Repeat until no more matches found; will find the |
1621 | 4702 outer pair. Implies the 'W' flag. |
4703 'm' Return number of matches instead of line number with | |
712 | 4704 the match; will be > 1 when 'r' is used. |
1621 | 4705 Note: it's nearly always a good idea to use the 'W' flag, to |
4706 avoid wrapping around the end of the file. | |
7 | 4707 |
4708 When a match for {start}, {middle} or {end} is found, the | |
4709 {skip} expression is evaluated with the cursor positioned on | |
4710 the start of the match. It should return non-zero if this | |
4711 match is to be skipped. E.g., because it is inside a comment | |
4712 or a string. | |
4713 When {skip} is omitted or empty, every match is accepted. | |
4714 When evaluating {skip} causes an error the search is aborted | |
4715 and -1 returned. | |
4716 | |
1496 | 4717 For {stopline} and {timeout} see |search()|. |
692 | 4718 |
7 | 4719 The value of 'ignorecase' is used. 'magic' is ignored, the |
4720 patterns are used like it's on. | |
4721 | |
4722 The search starts exactly at the cursor. A match with | |
4723 {start}, {middle} or {end} at the next character, in the | |
4724 direction of searching, is the first one found. Example: > | |
4725 if 1 | |
4726 if 2 | |
4727 endif 2 | |
4728 endif 1 | |
4729 < When starting at the "if 2", with the cursor on the "i", and | |
4730 searching forwards, the "endif 2" is found. When starting on | |
4731 the character just before the "if 2", the "endif 1" will be | |
1621 | 4732 found. That's because the "if 2" will be found first, and |
7 | 4733 then this is considered to be a nested if/endif from "if 2" to |
4734 "endif 2". | |
4735 When searching backwards and {end} is more than one character, | |
4736 it may be useful to put "\zs" at the end of the pattern, so | |
4737 that when the cursor is inside a match with the end it finds | |
4738 the matching start. | |
4739 | |
4740 Example, to find the "endif" command in a Vim script: > | |
4741 | |
4742 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
4743 \ 'getline(".") =~ "^\\s*\""') | |
4744 | |
4745 < The cursor must be at or after the "if" for which a match is | |
4746 to be found. Note that single-quote strings are used to avoid | |
4747 having to double the backslashes. The skip expression only | |
4748 catches comments at the start of a line, not after a command. | |
4749 Also, a word "en" or "if" halfway a line is considered a | |
4750 match. | |
4751 Another example, to search for the matching "{" of a "}": > | |
4752 | |
4753 :echo searchpair('{', '', '}', 'bW') | |
4754 | |
4755 < This works when the cursor is at or before the "}" for which a | |
4756 match is to be found. To reject matches that syntax | |
4757 highlighting recognized as strings: > | |
4758 | |
4759 :echo searchpair('{', '', '}', 'bW', | |
4760 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
4761 < | |
667 | 4762 *searchpairpos()* |
1496 | 4763 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
4764 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4765 Same as |searchpair()|, but returns a |List| with the line and |
685 | 4766 column position of the match. The first element of the |List| |
4767 is the line number and the second element is the byte index of | |
667 | 4768 the column position of the match. If no match is found, |
4769 returns [0, 0]. | |
4770 > | |
4771 :let [lnum,col] = searchpairpos('{', '', '}', 'n') | |
4772 < | |
4773 See |match-parens| for a bigger and more useful example. | |
4774 | |
1496 | 4775 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 4776 Same as |search()|, but returns a |List| with the line and |
685 | 4777 column position of the match. The first element of the |List| |
4778 is the line number and the second element is the byte index of | |
4779 the column position of the match. If no match is found, | |
4780 returns [0, 0]. | |
714 | 4781 Example: > |
4782 :let [lnum, col] = searchpos('mypattern', 'n') | |
4783 | |
4784 < When the 'p' flag is given then there is an extra item with | |
4785 the sub-pattern match number |search()-sub-match|. Example: > | |
4786 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
4787 < In this example "submatch" is 2 when a lowercase letter is | |
4788 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
4789 | |
7 | 4790 server2client( {clientid}, {string}) *server2client()* |
4791 Send a reply string to {clientid}. The most recent {clientid} | |
4792 that sent a string can be retrieved with expand("<client>"). | |
4793 {only available when compiled with the |+clientserver| feature} | |
4794 Note: | |
4795 This id has to be stored before the next command can be | |
236 | 4796 received. I.e. before returning from the received command and |
7 | 4797 before calling any commands that waits for input. |
4798 See also |clientserver|. | |
4799 Example: > | |
4800 :echo server2client(expand("<client>"), "HELLO") | |
4801 < | |
4802 serverlist() *serverlist()* | |
4803 Return a list of available server names, one per line. | |
4804 When there are no servers or the information is not available | |
4805 an empty string is returned. See also |clientserver|. | |
4806 {only available when compiled with the |+clientserver| feature} | |
4807 Example: > | |
4808 :echo serverlist() | |
4809 < | |
4810 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
4811 Set option or local variable {varname} in buffer {expr} to | |
4812 {val}. | |
4813 This also works for a global or local window option, but it | |
4814 doesn't work for a global or local window variable. | |
4815 For a local window option the global value is unchanged. | |
4816 For the use of {expr}, see |bufname()| above. | |
4817 Note that the variable name without "b:" must be used. | |
4818 Examples: > | |
4819 :call setbufvar(1, "&mod", 1) | |
4820 :call setbufvar("todo", "myvar", "foobar") | |
4821 < This function is not available in the |sandbox|. | |
4822 | |
4823 setcmdpos({pos}) *setcmdpos()* | |
4824 Set the cursor position in the command line to byte position | |
1621 | 4825 {pos}. The first position is 1. |
7 | 4826 Use |getcmdpos()| to obtain the current position. |
4827 Only works while editing the command line, thus you must use | |
99 | 4828 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
4829 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
4830 set after the command line is set to the expression. For | |
4831 |c_CTRL-R_=| it is set after evaluating the expression but | |
4832 before inserting the resulting text. | |
7 | 4833 When the number is too big the cursor is put at the end of the |
4834 line. A number smaller than one has undefined results. | |
4835 Returns 0 when successful, 1 when not editing the command | |
4836 line. | |
4837 | |
1621 | 4838 setline({lnum}, {text}) *setline()* |
4839 Set line {lnum} of the current buffer to {text}. | |
236 | 4840 {lnum} is used like with |getline()|. |
1621 | 4841 When {lnum} is just below the last line the {text} will be |
282 | 4842 added as a new line. |
236 | 4843 If this succeeds, 0 is returned. If this fails (most likely |
4844 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 4845 :call setline(5, strftime("%c")) |
1621 | 4846 < When {text} is a |List| then line {lnum} and following lines |
282 | 4847 will be set to the items in the list. Example: > |
4848 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
4849 < This is equivalent to: > | |
4850 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']] | |
4851 : call setline(n, l) | |
4852 :endfor | |
7 | 4853 < Note: The '[ and '] marks are not set. |
4854 | |
647 | 4855 setloclist({nr}, {list} [, {action}]) *setloclist()* |
4856 Create or replace or add to the location list for window {nr}. | |
4857 When {nr} is zero the current window is used. For a location | |
648 | 4858 list window, the displayed location list is modified. For an |
4859 invalid window number {nr}, -1 is returned. | |
1326 | 4860 Otherwise, same as |setqflist()|. |
4861 Also see |location-list|. | |
4862 | |
4863 setmatches({list}) *setmatches()* | |
4864 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 4865 if successful, otherwise -1. All current matches are cleared |
1326 | 4866 before the list is restored. See example for |getmatches()|. |
230 | 4867 |
707 | 4868 *setpos()* |
4869 setpos({expr}, {list}) | |
4870 Set the position for {expr}. Possible values: | |
4871 . the cursor | |
4872 'x mark x | |
4873 | |
4874 {list} must be a |List| with four numbers: | |
4875 [bufnum, lnum, col, off] | |
4876 | |
1621 | 4877 "bufnum" is the buffer number. Zero can be used for the |
856 | 4878 current buffer. Setting the cursor is only possible for |
707 | 4879 the current buffer. To set a mark in another buffer you can |
4880 use the |bufnr()| function to turn a file name into a buffer | |
4881 number. | |
798 | 4882 Does not change the jumplist. |
707 | 4883 |
4884 "lnum" and "col" are the position in the buffer. The first | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4885 column is 1. Use a zero "lnum" to delete a mark. If "col" is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4886 smaller than 1 then 1 is used. |
707 | 4887 |
4888 The "off" number is only used when 'virtualedit' is set. Then | |
4889 it is the offset in screen columns from the start of the | |
1266 | 4890 character. E.g., a position within a <Tab> or after the last |
707 | 4891 character. |
4892 | |
1533 | 4893 Returns 0 when the position could be set, -1 otherwise. |
4894 An error message is given if {expr} is invalid. | |
4895 | |
707 | 4896 Also see |getpos()| |
4897 | |
1156 | 4898 This does not restore the preferred column for moving |
4899 vertically. See |winrestview()| for that. | |
4900 | |
707 | 4901 |
277 | 4902 setqflist({list} [, {action}]) *setqflist()* |
647 | 4903 Create or replace or add to the quickfix list using the items |
4904 in {list}. Each item in {list} is a dictionary. | |
4905 Non-dictionary items in {list} are ignored. Each dictionary | |
4906 item can contain the following entries: | |
230 | 4907 |
1065 | 4908 bufnr buffer number; must be the number of a valid |
1621 | 4909 buffer |
1065 | 4910 filename name of a file; only used when "bufnr" is not |
1621 | 4911 present or it is invalid. |
230 | 4912 lnum line number in the file |
233 | 4913 pattern search pattern used to locate the error |
230 | 4914 col column number |
233 | 4915 vcol when non-zero: "col" is visual column |
856 | 4916 when zero: "col" is byte index |
233 | 4917 nr error number |
230 | 4918 text description of the error |
233 | 4919 type single-character error type, 'E', 'W', etc. |
4920 | |
4921 The "col", "vcol", "nr", "type" and "text" entries are | |
4922 optional. Either "lnum" or "pattern" entry can be used to | |
4923 locate a matching error line. | |
1065 | 4924 If the "filename" and "bufnr" entries are not present or |
4925 neither the "lnum" or "pattern" entries are present, then the | |
4926 item will not be handled as an error line. | |
230 | 4927 If both "pattern" and "lnum" are present then "pattern" will |
4928 be used. | |
1065 | 4929 Note that the list is not exactly the same as what |
4930 |getqflist()| returns. | |
230 | 4931 |
277 | 4932 If {action} is set to 'a', then the items from {list} are |
4933 added to the existing quickfix list. If there is no existing | |
4934 list, then a new list is created. If {action} is set to 'r', | |
4935 then the items from the current quickfix list are replaced | |
4936 with the items from {list}. If {action} is not present or is | |
4937 set to ' ', then a new list is created. | |
4938 | |
230 | 4939 Returns zero for success, -1 for failure. |
4940 | |
4941 This function can be used to create a quickfix list | |
4942 independent of the 'errorformat' setting. Use a command like | |
4943 ":cc 1" to jump to the first position. | |
4944 | |
4945 | |
7 | 4946 *setreg()* |
4947 setreg({regname}, {value} [,{options}]) | |
4948 Set the register {regname} to {value}. | |
4949 If {options} contains "a" or {regname} is upper case, | |
4950 then the value is appended. | |
4951 {options} can also contains a register type specification: | |
4952 "c" or "v" |characterwise| mode | |
4953 "l" or "V" |linewise| mode | |
4954 "b" or "<CTRL-V>" |blockwise-visual| mode | |
4955 If a number immediately follows "b" or "<CTRL-V>" then this is | |
4956 used as the width of the selection - if it is not specified | |
4957 then the width of the block is set to the number of characters | |
1266 | 4958 in the longest line (counting a <Tab> as 1 character). |
7 | 4959 |
4960 If {options} contains no register settings, then the default | |
4961 is to use character mode unless {value} ends in a <NL>. | |
4962 Setting the '=' register is not possible. | |
4963 Returns zero for success, non-zero for failure. | |
4964 | |
4965 Examples: > | |
4966 :call setreg(v:register, @*) | |
4967 :call setreg('*', @%, 'ac') | |
4968 :call setreg('a', "1\n2\n3", 'b5') | |
4969 | |
4970 < This example shows using the functions to save and restore a | |
4971 register. > | |
282 | 4972 :let var_a = getreg('a', 1) |
7 | 4973 :let var_amode = getregtype('a') |
4974 .... | |
4975 :call setreg('a', var_a, var_amode) | |
4976 | |
4977 < You can also change the type of a register by appending | |
4978 nothing: > | |
4979 :call setreg('a', '', 'al') | |
4980 | |
831 | 4981 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
4982 Set option or local variable {varname} in window {winnr} to | |
4983 {val}. | |
4984 Tabs are numbered starting with one. For the current tabpage | |
4985 use |setwinvar()|. | |
4986 When {winnr} is zero the current window is used. | |
7 | 4987 This also works for a global or local buffer option, but it |
4988 doesn't work for a global or local buffer variable. | |
4989 For a local buffer option the global value is unchanged. | |
4990 Note that the variable name without "w:" must be used. | |
831 | 4991 Vim briefly goes to the tab page {tabnr}, this may trigger |
4992 TabLeave and TabEnter autocommands. | |
4993 Examples: > | |
4994 :call settabwinvar(1, 1, "&list", 0) | |
4995 :call settabwinvar(3, 2, "myvar", "foobar") | |
4996 < This function is not available in the |sandbox|. | |
4997 | |
4998 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
4999 Like |settabwinvar()| for the current tab page. | |
7 | 5000 Examples: > |
5001 :call setwinvar(1, "&list", 0) | |
5002 :call setwinvar(2, "myvar", "foobar") | |
5003 | |
1661 | 5004 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5005 Escape {string} for use as a shell command argument. |
985 | 5006 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 5007 will enclose {string} in double quotes and double all double |
985 | 5008 quotes within {string}. |
5009 For other systems, it will enclose {string} in single quotes | |
5010 and replace all "'" with "'\''". | |
1661 | 5011 When the {special} argument is present and it's a non-zero |
5012 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 5013 items such as "!", "%", "#" and "<cword>" will be preceded by |
5014 a backslash. This backslash will be removed again by the |:!| | |
1661 | 5015 command. |
1698 | 5016 The "!" character will be escaped (again with a |non-zero-arg| |
5017 {special}) when 'shell' contains "csh" in the tail. That is | |
5018 because for csh and tcsh "!" is used for history replacement | |
5019 even when inside single quotes. | |
5020 The <NL> character is also escaped. With a |non-zero-arg| | |
5021 {special} and 'shell' containing "csh" in the tail it's | |
5022 escaped a second time. | |
1661 | 5023 Example of use with a |:!| command: > |
5024 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
5025 < This results in a directory listing for the file under the | |
5026 cursor. Example of use with |system()|: > | |
5027 :call system("chmod +w -- " . shellescape(expand("%"))) | |
985 | 5028 |
5029 | |
7 | 5030 simplify({filename}) *simplify()* |
5031 Simplify the file name as much as possible without changing | |
5032 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
5033 Unix) are not resolved. If the first path component in | |
5034 {filename} designates the current directory, this will be | |
5035 valid for the result as well. A trailing path separator is | |
5036 not removed either. | |
5037 Example: > | |
5038 simplify("./dir/.././/file/") == "./file/" | |
5039 < Note: The combination "dir/.." is only removed if "dir" is | |
5040 a searchable directory or does not exist. On Unix, it is also | |
5041 removed when "dir" is a symbolic link within the same | |
5042 directory. In order to resolve all the involved symbolic | |
5043 links before simplifying the path name, use |resolve()|. | |
5044 | |
82 | 5045 |
1621 | 5046 sin({expr}) *sin()* |
5047 Return the sine of {expr}, measured in radians, as a |Float|. | |
5048 {expr} must evaluate to a |Float| or a |Number|. | |
5049 Examples: > | |
5050 :echo sin(100) | |
5051 < -0.506366 > | |
5052 :echo sin(-4.01) | |
5053 < 0.763301 | |
5054 {only available when compiled with the |+float| feature} | |
5055 | |
5056 | |
85 | 5057 sort({list} [, {func}]) *sort()* *E702* |
82 | 5058 Sort the items in {list} in-place. Returns {list}. If you |
5059 want a list to remain unmodified make a copy first: > | |
5060 :let sortedlist = sort(copy(mylist)) | |
5061 < Uses the string representation of each item to sort on. | |
692 | 5062 Numbers sort after Strings, |Lists| after Numbers. |
282 | 5063 For sorting text in the current buffer use |:sort|. |
82 | 5064 When {func} is given and it is one then case is ignored. |
685 | 5065 When {func} is a |Funcref| or a function name, this function |
5066 is called to compare items. The function is invoked with two | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5067 items as argument and must return zero if they are equal, 1 or |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5068 bigger if the first one sorts after the second one, -1 or |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5069 smaller if the first one sorts before the second one. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5070 Example: > |
82 | 5071 func MyCompare(i1, i2) |
5072 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
5073 endfunc | |
5074 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5075 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5076 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5077 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5078 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5079 endfunc |
344 | 5080 < |
374 | 5081 *soundfold()* |
5082 soundfold({word}) | |
5083 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 5084 language in 'spelllang' for the current window that supports |
375 | 5085 soundfolding. 'spell' must be set. When no sound folding is |
5086 possible the {word} is returned unmodified. | |
374 | 5087 This can be used for making spelling suggestions. Note that |
5088 the method can be quite slow. | |
5089 | |
344 | 5090 *spellbadword()* |
532 | 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. | |
5096 | |
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. | |
5100 | |
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: | |
856 | 5104 "bad" spelling mistake |
532 | 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'] ~ | |
5111 | |
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. | |
344 | 5115 |
5116 *spellsuggest()* | |
537 | 5117 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 5118 Return a |List| with spelling suggestions to replace {word}. |
344 | 5119 When {max} is given up to this number of suggestions are |
5120 returned. Otherwise up to 25 suggestions are returned. | |
5121 | |
537 | 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'. | |
5125 | |
344 | 5126 {word} can be a badly spelled word followed by other text. |
5127 This allows for joining two words that were split. The | |
359 | 5128 suggestions also include the following text, thus you can |
5129 replace a line. | |
5130 | |
5131 {word} may also be a good word. Similar words will then be | |
537 | 5132 returned. {word} itself is not included in the suggestions, |
5133 although it may appear capitalized. | |
344 | 5134 |
5135 The spelling information for the current window is used. The | |
375 | 5136 'spell' option must be set and the values of 'spelllang' and |
5137 'spellsuggest' are used. | |
344 | 5138 |
82 | 5139 |
282 | 5140 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 5141 Make a |List| out of {expr}. When {pattern} is omitted or |
5142 empty each white-separated sequence of characters becomes an | |
5143 item. | |
82 | 5144 Otherwise the string is split where {pattern} matches, |
282 | 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. | |
293 | 5148 Other empty items are kept when {pattern} matches at least one |
5149 character or when {keepempty} is non-zero. | |
82 | 5150 Example: > |
95 | 5151 :let words = split(getline('.'), '\W\+') |
282 | 5152 < To split a string in individual characters: > |
236 | 5153 :for c in split(mystring, '\zs') |
258 | 5154 < If you want to keep the separator you can also use '\zs': > |
5155 :echo split('abc:def:ghi', ':\zs') | |
5156 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 5157 Splitting a table where the first element can be empty: > |
5158 :let items = split(line, ':', 1) | |
5159 < The opposite function is |join()|. | |
82 | 5160 |
5161 | |
1621 | 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 | |
1668 | 5172 "nan" may be different, it depends on system libraries. |
1621 | 5173 {only available when compiled with the |+float| feature} |
5174 | |
5175 | |
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} | |
5189 | |
5190 | |
782 | 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. | |
856 | 5200 |
782 | 5201 |
7 | 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. | |
82 | 5218 < Not available on all systems. To check use: > |
5219 :if exists("*strftime") | |
5220 | |
133 | 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}. | |
140 | 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. | |
205 | 5229 For pattern searches use |match()|. |
133 | 5230 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 5231 See also |strridx()|. |
5232 Examples: > | |
7 | 5233 :echo stridx("An Example", "Example") 3 |
5234 :echo stridx("Starting point", "Start") 0 | |
5235 :echo stridx("Starting point", "start") -1 | |
856 | 5236 < *strstr()* *strchr()* |
170 | 5237 stridx() works similar to the C function strstr(). When used |
5238 with a single character it works similar to strchr(). | |
5239 | |
55 | 5240 *string()* |
95 | 5241 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 5242 Float, String or a composition of them, then the result can be |
5243 parsed back with |eval()|. | |
55 | 5244 {expr} type result ~ |
99 | 5245 String 'string' |
95 | 5246 Number 123 |
1621 | 5247 Float 123.123456 or 1.123456e8 |
99 | 5248 Funcref function('name') |
95 | 5249 List [item, item] |
323 | 5250 Dictionary {key: value, key: value} |
99 | 5251 Note that in String values the ' character is doubled. |
1156 | 5252 Also see |strtrans()|. |
55 | 5253 |
7 | 5254 *strlen()* |
5255 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 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: > | |
7 | 5259 |
5260 :let len = strlen(substitute(str, ".", "x", "g")) | |
502 | 5261 < |
55 | 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()|. | |
7 | 5265 |
5266 strpart({src}, {start}[, {len}]) *strpart()* | |
5267 The result is a String, which is part of {src}, starting from | |
574 | 5268 byte {start}, with the byte length {len}. |
7 | 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" | |
1621 | 5276 strpart("abcdefg", 3) == "defg" |
7 | 5277 < Note: To get the first character, {start} must be 0. For |
5278 example, to get three bytes under and after the cursor: > | |
823 | 5279 strpart(getline("."), col(".") - 1, 3) |
7 | 5280 < |
140 | 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. | |
133 | 5290 For pattern searches use |match()|. |
5291 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 5292 If the {needle} is empty the length of {haystack} is returned. |
236 | 5293 See also |stridx()|. Examples: > |
7 | 5294 :echo strridx("an angry armadillo", "an") 3 |
856 | 5295 < *strrchr()* |
170 | 5296 When used with a single character it works similar to the C |
5297 function strrchr(). | |
5298 | |
7 | 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. | |
5306 | |
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. | |
5315 | |
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). | |
1156 | 5322 'ignorecase' is still relevant. 'smartcase' is not used. |
7 | 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 | |
1621 | 5326 |sub-replace-special|. For example, to replace something with |
7 | 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". | |
5337 | |
32 | 5338 synID({lnum}, {col}, {trans}) *synID()* |
7 | 5339 The result is a Number, which is the syntax ID at the position |
32 | 5340 {lnum} and {col} in the current window. |
7 | 5341 The syntax ID can be used with |synIDattr()| and |
5342 |synIDtrans()| to obtain syntax information about text. | |
419 | 5343 |
32 | 5344 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 5345 line. 'synmaxcol' applies, in a longer line zero is returned. |
5346 | |
7 | 5347 When {trans} is non-zero, transparent items are reduced to the |
1621 | 5348 item that they reveal. This is useful when wanting to know |
7 | 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. | |
5354 | |
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 | |
1621 | 5363 for that mode. When {mode} is omitted, or an invalid value is |
7 | 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) | |
1755 | 5372 "bg" background color (as with "fg") |
5373 "sp" special color (as with "fg") |highlight-guisp| | |
7 | 5374 "fg#" like "fg", but for the GUI and the GUI is |
5375 running the name in "#RRGGBB" form | |
5376 "bg#" like "fg#" for "bg" | |
1755 | 5377 "sp#" like "fg#" for "sp" |
7 | 5378 "bold" "1" if bold |
5379 "italic" "1" if italic | |
5380 "reverse" "1" if reverse | |
5381 "inverse" "1" if inverse (= reverse) | |
5382 "underline" "1" if underlined | |
205 | 5383 "undercurl" "1" if undercurled |
7 | 5384 |
5385 Example (echoes the color of the syntax item under the | |
5386 cursor): > | |
5387 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
5388 < | |
5389 synIDtrans({synID}) *synIDtrans()* | |
5390 The result is a Number, which is the translated syntax ID of | |
5391 {synID}. This is the syntax group ID of what is being used to | |
5392 highlight the character. Highlight links given with | |
5393 ":highlight link" are followed. | |
5394 | |
1500 | 5395 synstack({lnum}, {col}) *synstack()* |
5396 Return a |List|, which is the stack of syntax items at the | |
5397 position {lnum} and {col} in the current window. Each item in | |
5398 the List is an ID like what |synID()| returns. | |
5399 The first item in the List is the outer region, following are | |
5400 items contained in that one. The last one is what |synID()| | |
5401 returns, unless not the whole item is highlighted or it is a | |
5402 transparent item. | |
5403 This function is useful for debugging a syntax file. | |
5404 Example that shows the syntax stack under the cursor: > | |
5405 for id in synstack(line("."), col(".")) | |
5406 echo synIDattr(id, "name") | |
5407 endfor | |
5408 | |
24 | 5409 system({expr} [, {input}]) *system()* *E677* |
5410 Get the output of the shell command {expr}. | |
5411 When {input} is given, this string is written to a file and | |
5412 passed as stdin to the command. The string is written as-is, | |
5413 you need to take care of using the correct line separators | |
170 | 5414 yourself. Pipes are not used. |
1661 | 5415 Note: Use |shellescape()| to escape special characters in a |
5416 command argument. Newlines in {expr} may cause the command to | |
5417 fail. The characters in 'shellquote' and 'shellxquote' may | |
5418 also cause trouble. | |
7 | 5419 This is not to be used for interactive commands. |
1661 | 5420 |
7 | 5421 The result is a String. Example: > |
1661 | 5422 :let files = system("ls " . shellescape(expand('%:h'))) |
7 | 5423 |
5424 < To make the result more system-independent, the shell output | |
5425 is filtered to replace <CR> with <NL> for Macintosh, and | |
5426 <CR><NL> with <NL> for DOS-like systems. | |
5427 The command executed is constructed using several options: | |
5428 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
5429 ({tmp} is an automatically generated file name). | |
5430 For Unix and OS/2 braces are put around {expr} to allow for | |
5431 concatenated commands. | |
5432 | |
794 | 5433 The command will be executed in "cooked" mode, so that a |
5434 CTRL-C will interrupt the command (on Unix at least). | |
5435 | |
7 | 5436 The resulting error code can be found in |v:shell_error|. |
5437 This function will fail in |restricted-mode|. | |
625 | 5438 |
5439 Note that any wrong value in the options mentioned above may | |
5440 make the function fail. It has also been reported to fail | |
5441 when using a security agent application. | |
7 | 5442 Unlike ":!cmd" there is no automatic check for changed files. |
5443 Use |:checktime| to force a check. | |
5444 | |
205 | 5445 |
677 | 5446 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 5447 The result is a |List|, where each item is the number of the |
677 | 5448 buffer associated with each window in the current tab page. |
5449 {arg} specifies the number of tab page to be used. When | |
5450 omitted the current tab page is used. | |
5451 When {arg} is invalid the number zero is returned. | |
5452 To get a list of all buffers in all tabs use this: > | |
5453 tablist = [] | |
5454 for i in range(tabpagenr('$')) | |
5455 call extend(tablist, tabpagebuflist(i + 1)) | |
5456 endfor | |
5457 < Note that a buffer may appear in more than one window. | |
5458 | |
5459 | |
5460 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 5461 The result is a Number, which is the number of the current |
5462 tab page. The first tab page has number 1. | |
5463 When the optional argument is "$", the number of the last tab | |
5464 page is returned (the tab page count). | |
5465 The number can be used with the |:tab| command. | |
5466 | |
5467 | |
677 | 5468 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()* |
5469 Like |winnr()| but for tab page {arg}. | |
5470 {tabarg} specifies the number of tab page to be used. | |
5471 {arg} is used like with |winnr()|: | |
5472 - When omitted the current window number is returned. This is | |
5473 the window which will be used when going to this tab page. | |
5474 - When "$" the number of windows is returned. | |
5475 - When "#" the previous window nr is returned. | |
5476 Useful examples: > | |
5477 tabpagewinnr(1) " current window of tab page 1 | |
5478 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
5479 < When {tabarg} is invalid zero is returned. | |
5480 | |
805 | 5481 *tagfiles()* |
5482 tagfiles() Returns a |List| with the file names used to search for tags | |
5483 for the current buffer. This is the 'tags' option expanded. | |
5484 | |
5485 | |
205 | 5486 taglist({expr}) *taglist()* |
5487 Returns a list of tags matching the regular expression {expr}. | |
438 | 5488 Each list item is a dictionary with at least the following |
5489 entries: | |
648 | 5490 name Name of the tag. |
5491 filename Name of the file where the tag is | |
1156 | 5492 defined. It is either relative to the |
5493 current directory or a full path. | |
205 | 5494 cmd Ex command used to locate the tag in |
5495 the file. | |
648 | 5496 kind Type of the tag. The value for this |
205 | 5497 entry depends on the language specific |
1156 | 5498 kind values. Only available when |
5499 using a tags file generated by | |
5500 Exuberant ctags or hdrtag. | |
648 | 5501 static A file specific tag. Refer to |
205 | 5502 |static-tag| for more information. |
1156 | 5503 More entries may be present, depending on the content of the |
5504 tags file: access, implementation, inherits and signature. | |
5505 Refer to the ctags documentation for information about these | |
5506 fields. For C code the fields "struct", "class" and "enum" | |
5507 may appear, they give the name of the entity the tag is | |
5508 contained in. | |
452 | 5509 |
216 | 5510 The ex-command 'cmd' can be either an ex search pattern, a |
5511 line number or a line number followed by a byte number. | |
205 | 5512 |
5513 If there are no matching tags, then an empty list is returned. | |
5514 | |
5515 To get an exact tag match, the anchors '^' and '$' should be | |
5516 used in {expr}. Refer to |tag-regexp| for more information | |
5517 about the tag search regular expression pattern. | |
5518 | |
5519 Refer to |'tags'| for information about how the tags file is | |
5520 located by Vim. Refer to |tags-file-format| for the format of | |
5521 the tags file generated by the different ctags tools. | |
5522 | |
7 | 5523 tempname() *tempname()* *temp-file-name* |
5524 The result is a String, which is the name of a file that | |
1621 | 5525 doesn't exist. It can be used for a temporary file. The name |
7 | 5526 is different for at least 26 consecutive calls. Example: > |
5527 :let tmpfile = tempname() | |
5528 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5529 < For Unix, the file will be in a private directory |tempfile|. |
7 | 5530 For MS-Windows forward slashes are used when the 'shellslash' |
5531 option is set or when 'shellcmdflag' starts with '-'. | |
5532 | |
5533 tolower({expr}) *tolower()* | |
5534 The result is a copy of the String given, with all uppercase | |
5535 characters turned into lowercase (just like applying |gu| to | |
5536 the string). | |
5537 | |
5538 toupper({expr}) *toupper()* | |
5539 The result is a copy of the String given, with all lowercase | |
5540 characters turned into uppercase (just like applying |gU| to | |
5541 the string). | |
5542 | |
15 | 5543 tr({src}, {fromstr}, {tostr}) *tr()* |
5544 The result is a copy of the {src} string with all characters | |
5545 which appear in {fromstr} replaced by the character in that | |
5546 position in the {tostr} string. Thus the first character in | |
5547 {fromstr} is translated into the first character in {tostr} | |
5548 and so on. Exactly like the unix "tr" command. | |
5549 This code also deals with multibyte characters properly. | |
5550 | |
5551 Examples: > | |
5552 echo tr("hello there", "ht", "HT") | |
5553 < returns "Hello THere" > | |
5554 echo tr("<blob>", "<>", "{}") | |
5555 < returns "{blob}" | |
5556 | |
1621 | 5557 trunc({expr}) *trunc()* |
1668 | 5558 Return the largest integral value with magnitude less than or |
1621 | 5559 equal to {expr} as a |Float| (truncate towards zero). |
5560 {expr} must evaluate to a |Float| or a |Number|. | |
5561 Examples: > | |
5562 echo trunc(1.456) | |
5563 < 1.0 > | |
5564 echo trunc(-5.456) | |
5565 < -5.0 > | |
5566 echo trunc(4.0) | |
5567 < 4.0 | |
5568 {only available when compiled with the |+float| feature} | |
5569 | |
87 | 5570 *type()* |
5571 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 5572 Number: 0 |
5573 String: 1 | |
5574 Funcref: 2 | |
5575 List: 3 | |
5576 Dictionary: 4 | |
1621 | 5577 Float: 5 |
153 | 5578 To avoid the magic numbers it should be used this way: > |
87 | 5579 :if type(myvar) == type(0) |
5580 :if type(myvar) == type("") | |
5581 :if type(myvar) == type(function("tr")) | |
5582 :if type(myvar) == type([]) | |
153 | 5583 :if type(myvar) == type({}) |
1621 | 5584 :if type(myvar) == type(0.0) |
7 | 5585 |
140 | 5586 values({dict}) *values()* |
1621 | 5587 Return a |List| with all the values of {dict}. The |List| is |
685 | 5588 in arbitrary order. |
140 | 5589 |
5590 | |
7 | 5591 virtcol({expr}) *virtcol()* |
5592 The result is a Number, which is the screen column of the file | |
5593 position given with {expr}. That is, the last screen position | |
5594 occupied by the character at that position, when the screen | |
5595 would be of unlimited width. When there is a <Tab> at the | |
5596 position, the returned Number will be the column at the end of | |
5597 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
5598 set to 8, it returns 8. | |
1317 | 5599 For the byte position use |col()|. |
5600 For the use of {expr} see |col()|. | |
5601 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 5602 "off" is the offset in screen columns from the start of the |
1266 | 5603 character. E.g., a position within a <Tab> or after the last |
703 | 5604 character. |
7 | 5605 When Virtual editing is active in the current mode, a position |
5606 beyond the end of the line can be returned. |'virtualedit'| | |
5607 The accepted positions are: | |
5608 . the cursor position | |
5609 $ the end of the cursor line (the result is the | |
5610 number of displayed characters in the cursor line | |
5611 plus one) | |
5612 'x position of mark x (if the mark is not set, 0 is | |
5613 returned) | |
5614 Note that only marks in the current file can be used. | |
5615 Examples: > | |
5616 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
5617 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 5618 virtcol("'t") with text " there", with 't at 'h', returns 6 |
5619 < The first column is 1. 0 is returned for an error. | |
1156 | 5620 A more advanced example that echoes the maximum length of |
5621 all lines: > | |
5622 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
5623 | |
7 | 5624 |
5625 visualmode([expr]) *visualmode()* | |
5626 The result is a String, which describes the last Visual mode | |
856 | 5627 used in the current buffer. Initially it returns an empty |
5628 string, but once Visual mode has been used, it returns "v", | |
5629 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
5630 character-wise, line-wise, or block-wise Visual mode | |
5631 respectively. | |
7 | 5632 Example: > |
5633 :exe "normal " . visualmode() | |
5634 < This enters the same Visual mode as before. It is also useful | |
5635 in scripts if you wish to act differently depending on the | |
5636 Visual mode that was used. | |
1621 | 5637 If Visual mode is active, use |mode()| to get the Visual mode |
5638 (e.g., in a |:vmap|). | |
1661 | 5639 *non-zero-arg* |
5640 If [expr] is supplied and it evaluates to a non-zero Number or | |
5641 a non-empty String, then the Visual mode will be cleared and | |
1621 | 5642 the old value is returned. Note that " " and "0" are also |
1661 | 5643 non-empty strings, thus cause the mode to be cleared. A List, |
5644 Dictionary or Float is not a Number or String, thus does not | |
5645 cause the mode to be cleared. | |
7 | 5646 |
5647 *winbufnr()* | |
5648 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 5649 associated with window {nr}. When {nr} is zero, the number of |
7 | 5650 the buffer in the current window is returned. When window |
5651 {nr} doesn't exist, -1 is returned. | |
5652 Example: > | |
5653 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
5654 < | |
5655 *wincol()* | |
5656 wincol() The result is a Number, which is the virtual column of the | |
5657 cursor in the window. This is counting screen cells from the | |
5658 left side of the window. The leftmost column is one. | |
5659 | |
5660 winheight({nr}) *winheight()* | |
5661 The result is a Number, which is the height of window {nr}. | |
5662 When {nr} is zero, the height of the current window is | |
5663 returned. When window {nr} doesn't exist, -1 is returned. | |
5664 An existing window always has a height of zero or more. | |
5665 Examples: > | |
5666 :echo "The current window has " . winheight(0) . " lines." | |
5667 < | |
5668 *winline()* | |
5669 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 5670 in the window. This is counting screen lines from the top of |
7 | 5671 the window. The first line is one. |
531 | 5672 If the cursor was moved the view on the file will be updated |
5673 first, this may cause a scroll. | |
7 | 5674 |
5675 *winnr()* | |
20 | 5676 winnr([{arg}]) The result is a Number, which is the number of the current |
5677 window. The top window has number 1. | |
5678 When the optional argument is "$", the number of the | |
674 | 5679 last window is returned (the window count). |
20 | 5680 When the optional argument is "#", the number of the last |
5681 accessed window is returned (where |CTRL-W_p| goes to). | |
1156 | 5682 If there is no previous window or it is in another tab page 0 |
5683 is returned. | |
20 | 5684 The number can be used with |CTRL-W_w| and ":wincmd w" |
5685 |:wincmd|. | |
1156 | 5686 Also see |tabpagewinnr()|. |
7 | 5687 |
5688 *winrestcmd()* | |
5689 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
5690 the current window sizes. Only works properly when no windows | |
712 | 5691 are opened or closed and the current window and tab page is |
5692 unchanged. | |
7 | 5693 Example: > |
5694 :let cmd = winrestcmd() | |
5695 :call MessWithWindowSizes() | |
5696 :exe cmd | |
712 | 5697 < |
5698 *winrestview()* | |
5699 winrestview({dict}) | |
5700 Uses the |Dictionary| returned by |winsaveview()| to restore | |
5701 the view of the current window. | |
5702 If you have changed the values the result is unpredictable. | |
5703 If the window size changed the result won't be the same. | |
5704 | |
5705 *winsaveview()* | |
5706 winsaveview() Returns a |Dictionary| that contains information to restore | |
5707 the view of the current window. Use |winrestview()| to | |
5708 restore the view. | |
5709 This is useful if you have a mapping that jumps around in the | |
5710 buffer and you want to go back to the original view. | |
5711 This does not save fold information. Use the 'foldenable' | |
798 | 5712 option to temporarily switch off folding, so that folds are |
5713 not opened when moving around. | |
712 | 5714 The return value includes: |
5715 lnum cursor line number | |
5716 col cursor column | |
5717 coladd cursor column offset for 'virtualedit' | |
5718 curswant column for vertical movement | |
5719 topline first line in the window | |
5720 topfill filler lines, only in diff mode | |
5721 leftcol first column displayed | |
5722 skipcol columns skipped | |
5723 Note that no option values are saved. | |
5724 | |
7 | 5725 |
5726 winwidth({nr}) *winwidth()* | |
5727 The result is a Number, which is the width of window {nr}. | |
5728 When {nr} is zero, the width of the current window is | |
5729 returned. When window {nr} doesn't exist, -1 is returned. | |
5730 An existing window always has a width of zero or more. | |
5731 Examples: > | |
5732 :echo "The current window has " . winwidth(0) . " columns." | |
5733 :if winwidth(0) <= 50 | |
5734 : exe "normal 50\<C-W>|" | |
5735 :endif | |
5736 < | |
158 | 5737 *writefile()* |
5738 writefile({list}, {fname} [, {binary}]) | |
685 | 5739 Write |List| {list} to file {fname}. Each list item is |
158 | 5740 separated with a NL. Each list item must be a String or |
5741 Number. | |
5742 When {binary} is equal to "b" binary mode is used: There will | |
5743 not be a NL after the last list item. An empty item at the | |
5744 end does cause the last line in the file to end in a NL. | |
5745 All NL characters are replaced with a NUL character. | |
5746 Inserting CR characters needs to be done before passing {list} | |
5747 to writefile(). | |
5748 An existing file is overwritten, if possible. | |
5749 When the write fails -1 is returned, otherwise 0. There is an | |
5750 error message if the file can't be created or when writing | |
5751 fails. | |
5752 Also see |readfile()|. | |
5753 To copy a file byte for byte: > | |
5754 :let fl = readfile("foo", "b") | |
5755 :call writefile(fl, "foocopy", "b") | |
5756 < | |
7 | 5757 |
5758 *feature-list* | |
5759 There are three types of features: | |
5760 1. Features that are only supported when they have been enabled when Vim | |
5761 was compiled |+feature-list|. Example: > | |
5762 :if has("cindent") | |
5763 2. Features that are only supported when certain conditions have been met. | |
5764 Example: > | |
5765 :if has("gui_running") | |
5766 < *has-patch* | |
5767 3. Included patches. First check |v:version| for the version of Vim. | |
5768 Then the "patch123" feature means that patch 123 has been included for | |
5769 this version. Example (checking version 6.2.148 or later): > | |
5770 :if v:version > 602 || v:version == 602 && has("patch148") | |
1156 | 5771 < Note that it's possible for patch 147 to be omitted even though 148 is |
5772 included. | |
7 | 5773 |
5774 all_builtin_terms Compiled with all builtin terminals enabled. | |
5775 amiga Amiga version of Vim. | |
5776 arabic Compiled with Arabic support |Arabic|. | |
5777 arp Compiled with ARP support (Amiga). | |
613 | 5778 autocmd Compiled with autocommand support. |autocommand| |
7 | 5779 balloon_eval Compiled with |balloon-eval| support. |
435 | 5780 balloon_multiline GUI supports multiline balloons. |
7 | 5781 beos BeOS version of Vim. |
5782 browse Compiled with |:browse| support, and browse() will | |
5783 work. | |
5784 builtin_terms Compiled with some builtin terminals. | |
5785 byte_offset Compiled with support for 'o' in 'statusline' | |
5786 cindent Compiled with 'cindent' support. | |
5787 clientserver Compiled with remote invocation support |clientserver|. | |
5788 clipboard Compiled with 'clipboard' support. | |
5789 cmdline_compl Compiled with |cmdline-completion| support. | |
5790 cmdline_hist Compiled with |cmdline-history| support. | |
5791 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
5792 comments Compiled with |'comments'| support. | |
5793 cryptv Compiled with encryption support |encryption|. | |
5794 cscope Compiled with |cscope| support. | |
5795 compatible Compiled to be very Vi compatible. | |
5796 debug Compiled with "DEBUG" defined. | |
5797 dialog_con Compiled with console dialog support. | |
5798 dialog_gui Compiled with GUI dialog support. | |
5799 diff Compiled with |vimdiff| and 'diff' support. | |
5800 digraphs Compiled with support for digraphs. | |
5801 dnd Compiled with support for the "~ register |quote_~|. | |
5802 dos32 32 bits DOS (DJGPP) version of Vim. | |
5803 dos16 16 bits DOS version of Vim. | |
5804 ebcdic Compiled on a machine with ebcdic character set. | |
5805 emacs_tags Compiled with support for Emacs tags. | |
5806 eval Compiled with expression evaluation support. Always | |
5807 true, of course! | |
5808 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
5809 extra_search Compiled with support for |'incsearch'| and | |
5810 |'hlsearch'| | |
5811 farsi Compiled with Farsi support |farsi|. | |
5812 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 5813 filterpipe When 'shelltemp' is off pipes are used for shell |
5814 read/write/filter commands | |
7 | 5815 find_in_path Compiled with support for include file searches |
5816 |+find_in_path|. | |
1621 | 5817 float Compiled with support for |Float|. |
7 | 5818 fname_case Case in file names matters (for Amiga, MS-DOS, and |
5819 Windows this is not present). | |
5820 folding Compiled with |folding| support. | |
5821 footer Compiled with GUI footer support. |gui-footer| | |
5822 fork Compiled to use fork()/exec() instead of system(). | |
5823 gettext Compiled with message translation |multi-lang| | |
5824 gui Compiled with GUI enabled. | |
5825 gui_athena Compiled with Athena GUI. | |
5826 gui_gtk Compiled with GTK+ GUI (any version). | |
5827 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
1621 | 5828 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 5829 gui_mac Compiled with Macintosh GUI. |
5830 gui_motif Compiled with Motif GUI. | |
5831 gui_photon Compiled with Photon GUI. | |
5832 gui_win32 Compiled with MS Windows Win32 GUI. | |
5833 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
5834 gui_running Vim is running in the GUI, or it will start soon. | |
5835 hangul_input Compiled with Hangul input support. |hangul| | |
5836 iconv Can use iconv() for conversion. | |
5837 insert_expand Compiled with support for CTRL-X expansion commands in | |
5838 Insert mode. | |
5839 jumplist Compiled with |jumplist| support. | |
5840 keymap Compiled with 'keymap' support. | |
5841 langmap Compiled with 'langmap' support. | |
5842 libcall Compiled with |libcall()| support. | |
5843 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak' | |
5844 support. | |
5845 lispindent Compiled with support for lisp indenting. | |
5846 listcmds Compiled with commands for the buffer list |:files| | |
5847 and the argument list |arglist|. | |
5848 localmap Compiled with local mappings and abbr. |:map-local| | |
5849 mac Macintosh version of Vim. | |
5850 macunix Macintosh version of Vim, using Unix files (OS-X). | |
5851 menu Compiled with support for |:menu|. | |
5852 mksession Compiled with support for |:mksession|. | |
5853 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
5854 mouse Compiled with support mouse. | |
5855 mouseshape Compiled with support for 'mouseshape'. | |
5856 mouse_dec Compiled with support for Dec terminal mouse. | |
5857 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
5858 mouse_netterm Compiled with support for netterm mouse. | |
5859 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 5860 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
7 | 5861 mouse_xterm Compiled with support for xterm mouse. |
1768 | 5862 multi_byte Compiled with support for 'encoding' |
5863 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 5864 multi_byte_ime Compiled with support for IME input method. |
5865 multi_lang Compiled with support for multiple languages. | |
14 | 5866 mzscheme Compiled with MzScheme interface |mzscheme|. |
7 | 5867 netbeans_intg Compiled with support for |netbeans|. |
33 | 5868 netbeans_enabled Compiled with support for |netbeans| and it's used. |
7 | 5869 ole Compiled with OLE automation support for Win32. |
5870 os2 OS/2 version of Vim. | |
5871 osfiletype Compiled with support for osfiletypes |+osfiletype| | |
5872 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
5873 perl Compiled with Perl interface. | |
5874 postscript Compiled with PostScript file printing. | |
5875 printer Compiled with |:hardcopy| support. | |
170 | 5876 profile Compiled with |:profile| support. |
7 | 5877 python Compiled with Python interface. |
5878 qnx QNX version of Vim. | |
5879 quickfix Compiled with |quickfix| support. | |
857 | 5880 reltime Compiled with |reltime()| support. |
7 | 5881 rightleft Compiled with 'rightleft' support. |
5882 ruby Compiled with Ruby interface |ruby|. | |
5883 scrollbind Compiled with 'scrollbind' support. | |
5884 showcmd Compiled with 'showcmd' support. | |
5885 signs Compiled with |:sign| support. | |
5886 smartindent Compiled with 'smartindent' support. | |
9 | 5887 sniff Compiled with SNiFF interface support. |
1989 | 5888 startuptime Compiled with |--startuptime| support. |
7 | 5889 statusline Compiled with support for 'statusline', 'rulerformat' |
5890 and special formats of 'titlestring' and 'iconstring'. | |
5891 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 5892 spell Compiled with spell checking support |spell|. |
5893 syntax Compiled with syntax highlighting support |syntax|. | |
7 | 5894 syntax_items There are active syntax highlighting items for the |
5895 current buffer. | |
5896 system Compiled to use system() instead of fork()/exec(). | |
5897 tag_binary Compiled with binary searching in tags files | |
5898 |tag-binary-search|. | |
5899 tag_old_static Compiled with support for old static tags | |
5900 |tag-old-static|. | |
5901 tag_any_white Compiled with support for any white characters in tags | |
5902 files |tag-any-white|. | |
5903 tcl Compiled with Tcl interface. | |
5904 terminfo Compiled with terminfo instead of termcap. | |
5905 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
5906 textobjects Compiled with support for |text-objects|. | |
5907 tgetent Compiled with tgetent support, able to use a termcap | |
5908 or terminfo file. | |
5909 title Compiled with window title support |'title'|. | |
5910 toolbar Compiled with support for |gui-toolbar|. | |
5911 unix Unix version of Vim. | |
5912 user_commands User-defined commands. | |
5913 viminfo Compiled with viminfo support. | |
5914 vim_starting True while initial source'ing takes place. | |
5915 vertsplit Compiled with vertically split windows |:vsplit|. | |
5916 virtualedit Compiled with 'virtualedit' option. | |
5917 visual Compiled with Visual mode. | |
5918 visualextra Compiled with extra Visual mode commands. | |
5919 |blockwise-operators|. | |
5920 vms VMS version of Vim. | |
5921 vreplace Compiled with |gR| and |gr| commands. | |
5922 wildignore Compiled with 'wildignore' option. | |
5923 wildmenu Compiled with 'wildmenu' option. | |
5924 windows Compiled with support for more than one window. | |
5925 winaltkeys Compiled with 'winaltkeys' option. | |
5926 win16 Win16 version of Vim (MS-Windows 3.1). | |
5927 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP). | |
5928 win64 Win64 version of Vim (MS-Windows 64 bit). | |
5929 win32unix Win32 version of Vim, using Unix files (Cygwin) | |
5930 win95 Win32 version for MS-Windows 95/98/ME. | |
5931 writebackup Compiled with 'writebackup' default on. | |
5932 xfontset Compiled with X fontset support |xfontset|. | |
5933 xim Compiled with X input method support |xim|. | |
5934 xsmp Compiled with X session management support. | |
5935 xsmp_interact Compiled with interactive X session management support. | |
5936 xterm_clipboard Compiled with support for xterm clipboard. | |
5937 xterm_save Compiled with support for saving and restoring the | |
5938 xterm screen. | |
5939 x11 Compiled with X11 support. | |
5940 | |
5941 *string-match* | |
5942 Matching a pattern in a String | |
5943 | |
5944 A regexp pattern as explained at |pattern| is normally used to find a match in | |
5945 the buffer lines. When a pattern is used to find a match in a String, almost | |
5946 everything works in the same way. The difference is that a String is handled | |
5947 like it is one line. When it contains a "\n" character, this is not seen as a | |
5948 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
5949 with ".". Example: > | |
5950 :let a = "aaaa\nxxxx" | |
5951 :echo matchstr(a, "..\n..") | |
5952 aa | |
5953 xx | |
5954 :echo matchstr(a, "a.x") | |
5955 a | |
5956 x | |
5957 | |
5958 Don't forget that "^" will only match at the first character of the String and | |
5959 "$" at the last character of the string. They don't match after or before a | |
5960 "\n". | |
5961 | |
5962 ============================================================================== | |
5963 5. Defining functions *user-functions* | |
5964 | |
5965 New functions can be defined. These can be called just like builtin | |
5966 functions. The function executes a sequence of Ex commands. Normal mode | |
5967 commands can be executed with the |:normal| command. | |
5968 | |
5969 The function name must start with an uppercase letter, to avoid confusion with | |
5970 builtin functions. To prevent from using the same name in different scripts | |
5971 avoid obvious, short names. A good habit is to start the function name with | |
5972 the name of the script, e.g., "HTMLcolor()". | |
5973 | |
504 | 5974 It's also possible to use curly braces, see |curly-braces-names|. And the |
5975 |autoload| facility is useful to define a function only when it's called. | |
7 | 5976 |
5977 *local-function* | |
5978 A function local to a script must start with "s:". A local script function | |
5979 can only be called from within the script and from functions, user commands | |
5980 and autocommands defined in the script. It is also possible to call the | |
1698 | 5981 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 5982 instead of "s:" when the mapping is expanded outside of the script. |
5983 | |
5984 *:fu* *:function* *E128* *E129* *E123* | |
5985 :fu[nction] List all functions and their arguments. | |
5986 | |
5987 :fu[nction] {name} List function {name}. | |
685 | 5988 {name} can also be a |Dictionary| entry that is a |
5989 |Funcref|: > | |
114 | 5990 :function dict.init |
504 | 5991 |
5992 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
5993 Example that lists all functions ending with "File": > | |
5994 :function /File$ | |
482 | 5995 < |
5996 *:function-verbose* | |
5997 When 'verbose' is non-zero, listing a function will also display where it was | |
5998 last defined. Example: > | |
5999 | |
6000 :verbose function SetFileTypeSH | |
6001 function SetFileTypeSH(name) | |
6002 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
6003 < | |
484 | 6004 See |:verbose-cmd| for more information. |
482 | 6005 |
856 | 6006 *E124* *E125* |
102 | 6007 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 6008 Define a new function by the name {name}. The name |
6009 must be made of alphanumeric characters and '_', and | |
6010 must start with a capital or "s:" (see above). | |
114 | 6011 |
685 | 6012 {name} can also be a |Dictionary| entry that is a |
6013 |Funcref|: > | |
114 | 6014 :function dict.init(arg) |
1621 | 6015 < "dict" must be an existing dictionary. The entry |
114 | 6016 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 6017 is required to overwrite an existing function. The |
114 | 6018 result is a |Funcref| to a numbered function. The |
6019 function can only be used with a |Funcref| and will be | |
6020 deleted if there are no more references to it. | |
7 | 6021 *E127* *E122* |
6022 When a function by this name already exists and [!] is | |
6023 not used an error message is given. When [!] is used, | |
6024 an existing function is silently replaced. Unless it | |
6025 is currently being executed, that is an error. | |
133 | 6026 |
6027 For the {arguments} see |function-argument|. | |
6028 | |
7 | 6029 *a:firstline* *a:lastline* |
6030 When the [range] argument is added, the function is | |
6031 expected to take care of a range itself. The range is | |
6032 passed as "a:firstline" and "a:lastline". If [range] | |
6033 is excluded, ":{range}call" will call the function for | |
6034 each line in the range, with the cursor on the start | |
6035 of each line. See |function-range-example|. | |
114 | 6036 |
7 | 6037 When the [abort] argument is added, the function will |
6038 abort as soon as an error is detected. | |
114 | 6039 |
102 | 6040 When the [dict] argument is added, the function must |
1621 | 6041 be invoked through an entry in a |Dictionary|. The |
102 | 6042 local variable "self" will then be set to the |
6043 dictionary. See |Dictionary-function|. | |
7 | 6044 |
1621 | 6045 *function-search-undo* |
653 | 6046 The last used search pattern and the redo command "." |
1621 | 6047 will not be changed by the function. This also |
6048 implies that the effect of |:nohlsearch| is undone | |
6049 when the function returns. | |
653 | 6050 |
7 | 6051 *:endf* *:endfunction* *E126* *E193* |
6052 :endf[unction] The end of a function definition. Must be on a line | |
6053 by its own, without other commands. | |
6054 | |
6055 *:delf* *:delfunction* *E130* *E131* | |
6056 :delf[unction] {name} Delete function {name}. | |
685 | 6057 {name} can also be a |Dictionary| entry that is a |
6058 |Funcref|: > | |
114 | 6059 :delfunc dict.init |
1621 | 6060 < This will remove the "init" entry from "dict". The |
114 | 6061 function is deleted if there are no more references to |
6062 it. | |
7 | 6063 *:retu* *:return* *E133* |
6064 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
6065 evaluated and returned as the result of the function. | |
6066 If "[expr]" is not given, the number 0 is returned. | |
6067 When a function ends without an explicit ":return", | |
6068 the number 0 is returned. | |
6069 Note that there is no check for unreachable lines, | |
6070 thus there is no warning if commands follow ":return". | |
6071 | |
6072 If the ":return" is used after a |:try| but before the | |
6073 matching |:finally| (if present), the commands | |
6074 following the ":finally" up to the matching |:endtry| | |
6075 are executed first. This process applies to all | |
6076 nested ":try"s inside the function. The function | |
6077 returns at the outermost ":endtry". | |
6078 | |
133 | 6079 *function-argument* *a:var* |
1621 | 6080 An argument can be defined by giving its name. In the function this can then |
133 | 6081 be used as "a:name" ("a:" for argument). |
1156 | 6082 *a:0* *a:1* *a:000* *E740* *...* |
133 | 6083 Up to 20 arguments can be given, separated by commas. After the named |
6084 arguments an argument "..." can be specified, which means that more arguments | |
6085 may optionally be following. In the function the extra arguments can be used | |
6086 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 6087 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
6088 that "a:1" is the same as "a:000[0]". | |
148 | 6089 *E742* |
6090 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 6091 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 6092 Thus you can pass a |List| to a function and have the function add an item to |
6093 it. If you want to make sure the function cannot change a |List| or | |
6094 |Dictionary| use |:lockvar|. | |
133 | 6095 |
6096 When not using "...", the number of arguments in a function call must be equal | |
6097 to the number of named arguments. When using "...", the number of arguments | |
6098 may be larger. | |
6099 | |
6100 It is also possible to define a function without any arguments. You must | |
6101 still supply the () then. The body of the function follows in the next lines, | |
6102 until the matching |:endfunction|. It is allowed to define another function | |
6103 inside a function body. | |
6104 | |
6105 *local-variables* | |
7 | 6106 Inside a function variables can be used. These are local variables, which |
6107 will disappear when the function returns. Global variables need to be | |
6108 accessed with "g:". | |
6109 | |
6110 Example: > | |
6111 :function Table(title, ...) | |
6112 : echohl Title | |
6113 : echo a:title | |
6114 : echohl None | |
140 | 6115 : echo a:0 . " items:" |
6116 : for s in a:000 | |
6117 : echon ' ' . s | |
6118 : endfor | |
7 | 6119 :endfunction |
6120 | |
6121 This function can then be called with: > | |
140 | 6122 call Table("Table", "line1", "line2") |
6123 call Table("Empty Table") | |
7 | 6124 |
1156 | 6125 To return more than one value, return a |List|: > |
6126 :function Compute(n1, n2) | |
7 | 6127 : if a:n2 == 0 |
1156 | 6128 : return ["fail", 0] |
7 | 6129 : endif |
1156 | 6130 : return ["ok", a:n1 / a:n2] |
7 | 6131 :endfunction |
6132 | |
6133 This function can then be called with: > | |
1156 | 6134 :let [success, div] = Compute(102, 6) |
7 | 6135 :if success == "ok" |
6136 : echo div | |
6137 :endif | |
1156 | 6138 < |
786 | 6139 *:cal* *:call* *E107* *E117* |
7 | 6140 :[range]cal[l] {name}([arguments]) |
6141 Call a function. The name of the function and its arguments | |
6142 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 6143 used. The returned value is discarded. |
7 | 6144 Without a range and for functions that accept a range, the |
6145 function is called once. When a range is given the cursor is | |
6146 positioned at the start of the first line before executing the | |
6147 function. | |
6148 When a range is given and the function doesn't handle it | |
6149 itself, the function is executed for each line in the range, | |
6150 with the cursor in the first column of that line. The cursor | |
6151 is left at the last line (possibly moved by the last function | |
1621 | 6152 call). The arguments are re-evaluated for each line. Thus |
7 | 6153 this works: |
6154 *function-range-example* > | |
6155 :function Mynumber(arg) | |
6156 : echo line(".") . " " . a:arg | |
6157 :endfunction | |
6158 :1,5call Mynumber(getline(".")) | |
6159 < | |
6160 The "a:firstline" and "a:lastline" are defined anyway, they | |
6161 can be used to do something different at the start or end of | |
6162 the range. | |
6163 | |
6164 Example of a function that handles the range itself: > | |
6165 | |
6166 :function Cont() range | |
6167 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
6168 :endfunction | |
6169 :4,8call Cont() | |
6170 < | |
6171 This function inserts the continuation character "\" in front | |
6172 of all the lines in the range, except the first one. | |
6173 | |
1156 | 6174 When the function returns a composite value it can be further |
6175 dereferenced, but the range will not be used then. Example: > | |
6176 :4,8call GetDict().method() | |
6177 < Here GetDict() gets the range but method() does not. | |
6178 | |
7 | 6179 *E132* |
6180 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
6181 option. | |
6182 | |
161 | 6183 |
6184 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 6185 *autoload-functions* |
6186 When using many or large functions, it's possible to automatically define them | |
161 | 6187 only when they are used. There are two methods: with an autocommand and with |
6188 the "autoload" directory in 'runtimepath'. | |
6189 | |
6190 | |
6191 Using an autocommand ~ | |
6192 | |
170 | 6193 This is introduced in the user manual, section |41.14|. |
6194 | |
161 | 6195 The autocommand is useful if you have a plugin that is a long Vim script file. |
6196 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 6197 That makes Vim startup faster. The autocommand should then load the same file |
161 | 6198 again, setting a variable to skip the |:finish| command. |
6199 | |
6200 Use the FuncUndefined autocommand event with a pattern that matches the | |
6201 function(s) to be defined. Example: > | |
7 | 6202 |
6203 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
6204 | |
6205 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
6206 "BufNet". Also see |FuncUndefined|. | |
6207 | |
161 | 6208 |
6209 Using an autoload script ~ | |
168 | 6210 *autoload* *E746* |
170 | 6211 This is introduced in the user manual, section |41.15|. |
6212 | |
161 | 6213 Using a script in the "autoload" directory is simpler, but requires using |
6214 exactly the right file name. A function that can be autoloaded has a name | |
6215 like this: > | |
6216 | |
270 | 6217 :call filename#funcname() |
161 | 6218 |
6219 When such a function is called, and it is not defined yet, Vim will search the | |
6220 "autoload" directories in 'runtimepath' for a script file called | |
6221 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
6222 then define the function like this: > | |
6223 | |
270 | 6224 function filename#funcname() |
161 | 6225 echo "Done!" |
6226 endfunction | |
6227 | |
530 | 6228 The file name and the name used before the # in the function must match |
161 | 6229 exactly, and the defined function must have the name exactly as it will be |
6230 called. | |
6231 | |
270 | 6232 It is possible to use subdirectories. Every # in the function name works like |
6233 a path separator. Thus when calling a function: > | |
6234 | |
6235 :call foo#bar#func() | |
161 | 6236 |
6237 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
6238 | |
168 | 6239 This also works when reading a variable that has not been set yet: > |
6240 | |
270 | 6241 :let l = foo#bar#lvar |
168 | 6242 |
557 | 6243 However, when the autoload script was already loaded it won't be loaded again |
6244 for an unknown variable. | |
6245 | |
168 | 6246 When assigning a value to such a variable nothing special happens. This can |
6247 be used to pass settings to the autoload script before it's loaded: > | |
6248 | |
270 | 6249 :let foo#bar#toggle = 1 |
6250 :call foo#bar#func() | |
168 | 6251 |
164 | 6252 Note that when you make a mistake and call a function that is supposed to be |
6253 defined in an autoload script, but the script doesn't actually define the | |
6254 function, the script will be sourced every time you try to call the function. | |
168 | 6255 And you will get an error message every time. |
6256 | |
6257 Also note that if you have two script files, and one calls a function in the | |
1621 | 6258 other and vice versa, before the used function is defined, it won't work. |
168 | 6259 Avoid using the autoload functionality at the toplevel. |
161 | 6260 |
794 | 6261 Hint: If you distribute a bunch of scripts you can pack them together with the |
6262 |vimball| utility. Also read the user manual |distribute-script|. | |
6263 | |
7 | 6264 ============================================================================== |
6265 6. Curly braces names *curly-braces-names* | |
6266 | |
6267 Wherever you can use a variable, you can use a "curly braces name" variable. | |
6268 This is a regular variable name with one or more expressions wrapped in braces | |
6269 {} like this: > | |
6270 my_{adjective}_variable | |
6271 | |
6272 When Vim encounters this, it evaluates the expression inside the braces, puts | |
6273 that in place of the expression, and re-interprets the whole as a variable | |
6274 name. So in the above example, if the variable "adjective" was set to | |
6275 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
6276 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
6277 | |
6278 One application for this is to create a set of variables governed by an option | |
1621 | 6279 value. For example, the statement > |
7 | 6280 echo my_{&background}_message |
6281 | |
6282 would output the contents of "my_dark_message" or "my_light_message" depending | |
6283 on the current value of 'background'. | |
6284 | |
6285 You can use multiple brace pairs: > | |
6286 echo my_{adverb}_{adjective}_message | |
6287 ..or even nest them: > | |
6288 echo my_{ad{end_of_word}}_message | |
6289 where "end_of_word" is either "verb" or "jective". | |
6290 | |
6291 However, the expression inside the braces must evaluate to a valid single | |
236 | 6292 variable name, e.g. this is invalid: > |
7 | 6293 :let foo='a + b' |
6294 :echo c{foo}d | |
6295 .. since the result of expansion is "ca + bd", which is not a variable name. | |
6296 | |
6297 *curly-braces-function-names* | |
6298 You can call and define functions by an evaluated name in a similar way. | |
6299 Example: > | |
6300 :let func_end='whizz' | |
6301 :call my_func_{func_end}(parameter) | |
6302 | |
6303 This would call the function "my_func_whizz(parameter)". | |
6304 | |
6305 ============================================================================== | |
6306 7. Commands *expression-commands* | |
6307 | |
6308 :let {var-name} = {expr1} *:let* *E18* | |
6309 Set internal variable {var-name} to the result of the | |
6310 expression {expr1}. The variable will get the type | |
6311 from the {expr}. If {var-name} didn't exist yet, it | |
6312 is created. | |
6313 | |
85 | 6314 :let {var-name}[{idx}] = {expr1} *E689* |
6315 Set a list item to the result of the expression | |
6316 {expr1}. {var-name} must refer to a list and {idx} | |
6317 must be a valid index in that list. For nested list | |
6318 the index can be repeated. | |
1621 | 6319 This cannot be used to add an item to a |List|. |
6320 This cannot be used to set a byte in a String. You | |
6321 can do that like this: > | |
6322 :let var = var[0:2] . 'X' . var[4:] | |
6323 < | |
114 | 6324 *E711* *E719* |
6325 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 6326 Set a sequence of items in a |List| to the result of |
6327 the expression {expr1}, which must be a list with the | |
87 | 6328 correct number of items. |
6329 {idx1} can be omitted, zero is used instead. | |
6330 {idx2} can be omitted, meaning the end of the list. | |
6331 When the selected range of items is partly past the | |
6332 end of the list, items will be added. | |
6333 | |
153 | 6334 *:let+=* *:let-=* *:let.=* *E734* |
114 | 6335 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
6336 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
6337 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
6338 These fail if {var} was not set yet and when the type | |
6339 of {var} and {expr1} don't fit the operator. | |
6340 | |
6341 | |
7 | 6342 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
6343 Set environment variable {env-name} to the result of | |
6344 the expression {expr1}. The type is always String. | |
114 | 6345 :let ${env-name} .= {expr1} |
6346 Append {expr1} to the environment variable {env-name}. | |
6347 If the environment variable didn't exist yet this | |
6348 works like "=". | |
7 | 6349 |
6350 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
6351 Write the result of the expression {expr1} in register | |
6352 {reg-name}. {reg-name} must be a single letter, and | |
6353 must be the name of a writable register (see | |
6354 |registers|). "@@" can be used for the unnamed | |
6355 register, "@/" for the search pattern. | |
6356 If the result of {expr1} ends in a <CR> or <NL>, the | |
6357 register will be linewise, otherwise it will be set to | |
6358 characterwise. | |
6359 This can be used to clear the last search pattern: > | |
6360 :let @/ = "" | |
6361 < This is different from searching for an empty string, | |
6362 that would match everywhere. | |
6363 | |
114 | 6364 :let @{reg-name} .= {expr1} |
1621 | 6365 Append {expr1} to register {reg-name}. If the |
114 | 6366 register was empty it's like setting it to {expr1}. |
6367 | |
1156 | 6368 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 6369 Set option {option-name} to the result of the |
68 | 6370 expression {expr1}. A String or Number value is |
6371 always converted to the type of the option. | |
7 | 6372 For an option local to a window or buffer the effect |
6373 is just like using the |:set| command: both the local | |
555 | 6374 value and the global value are changed. |
68 | 6375 Example: > |
6376 :let &path = &path . ',/usr/local/include' | |
7 | 6377 |
114 | 6378 :let &{option-name} .= {expr1} |
6379 For a string option: Append {expr1} to the value. | |
6380 Does not insert a comma like |:set+=|. | |
6381 | |
6382 :let &{option-name} += {expr1} | |
6383 :let &{option-name} -= {expr1} | |
6384 For a number or boolean option: Add or subtract | |
6385 {expr1}. | |
6386 | |
7 | 6387 :let &l:{option-name} = {expr1} |
114 | 6388 :let &l:{option-name} .= {expr1} |
6389 :let &l:{option-name} += {expr1} | |
6390 :let &l:{option-name} -= {expr1} | |
7 | 6391 Like above, but only set the local value of an option |
6392 (if there is one). Works like |:setlocal|. | |
6393 | |
6394 :let &g:{option-name} = {expr1} | |
114 | 6395 :let &g:{option-name} .= {expr1} |
6396 :let &g:{option-name} += {expr1} | |
6397 :let &g:{option-name} -= {expr1} | |
7 | 6398 Like above, but only set the global value of an option |
6399 (if there is one). Works like |:setglobal|. | |
6400 | |
85 | 6401 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 6402 {expr1} must evaluate to a |List|. The first item in |
68 | 6403 the list is assigned to {name1}, the second item to |
6404 {name2}, etc. | |
6405 The number of names must match the number of items in | |
685 | 6406 the |List|. |
68 | 6407 Each name can be one of the items of the ":let" |
6408 command as mentioned above. | |
6409 Example: > | |
6410 :let [s, item] = GetItem(s) | |
114 | 6411 < Detail: {expr1} is evaluated first, then the |
6412 assignments are done in sequence. This matters if | |
6413 {name2} depends on {name1}. Example: > | |
6414 :let x = [0, 1] | |
6415 :let i = 0 | |
6416 :let [i, x[i]] = [1, 2] | |
6417 :echo x | |
6418 < The result is [0, 2]. | |
6419 | |
6420 :let [{name1}, {name2}, ...] .= {expr1} | |
6421 :let [{name1}, {name2}, ...] += {expr1} | |
6422 :let [{name1}, {name2}, ...] -= {expr1} | |
6423 Like above, but append/add/subtract the value for each | |
685 | 6424 |List| item. |
68 | 6425 |
6426 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 6427 Like |:let-unpack| above, but the |List| may have more |
114 | 6428 items than there are names. A list of the remaining |
6429 items is assigned to {lastname}. If there are no | |
6430 remaining items {lastname} is set to an empty list. | |
68 | 6431 Example: > |
6432 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
6433 < | |
114 | 6434 :let [{name}, ..., ; {lastname}] .= {expr1} |
6435 :let [{name}, ..., ; {lastname}] += {expr1} | |
6436 :let [{name}, ..., ; {lastname}] -= {expr1} | |
6437 Like above, but append/add/subtract the value for each | |
685 | 6438 |List| item. |
7 | 6439 *E106* |
1621 | 6440 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 6441 variable names may be given. Special names recognized |
6442 here: *E738* | |
777 | 6443 g: global variables |
6444 b: local buffer variables | |
6445 w: local window variables | |
819 | 6446 t: local tab page variables |
777 | 6447 s: script-local variables |
6448 l: local function variables | |
123 | 6449 v: Vim variables. |
7 | 6450 |
55 | 6451 :let List the values of all variables. The type of the |
6452 variable is indicated before the value: | |
6453 <nothing> String | |
6454 # Number | |
856 | 6455 * Funcref |
7 | 6456 |
148 | 6457 |
1156 | 6458 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 6459 Remove the internal variable {name}. Several variable |
6460 names can be given, they are all removed. The name | |
685 | 6461 may also be a |List| or |Dictionary| item. |
7 | 6462 With [!] no error message is given for non-existing |
6463 variables. | |
685 | 6464 One or more items from a |List| can be removed: > |
108 | 6465 :unlet list[3] " remove fourth item |
6466 :unlet list[3:] " remove fourth item to last | |
685 | 6467 < One item from a |Dictionary| can be removed at a time: > |
108 | 6468 :unlet dict['two'] |
6469 :unlet dict.two | |
1668 | 6470 < This is especially useful to clean up used global |
6471 variables and script-local variables (these are not | |
6472 deleted when the script ends). Function-local | |
6473 variables are automatically deleted when the function | |
6474 ends. | |
7 | 6475 |
148 | 6476 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
6477 Lock the internal variable {name}. Locking means that | |
6478 it can no longer be changed (until it is unlocked). | |
6479 A locked variable can be deleted: > | |
6480 :lockvar v | |
6481 :let v = 'asdf' " fails! | |
6482 :unlet v | |
6483 < *E741* | |
6484 If you try to change a locked variable you get an | |
6485 error message: "E741: Value of {name} is locked" | |
6486 | |
685 | 6487 [depth] is relevant when locking a |List| or |
6488 |Dictionary|. It specifies how deep the locking goes: | |
6489 1 Lock the |List| or |Dictionary| itself, | |
148 | 6490 cannot add or remove items, but can |
6491 still change their values. | |
6492 2 Also lock the values, cannot change | |
685 | 6493 the items. If an item is a |List| or |
6494 |Dictionary|, cannot add or remove | |
148 | 6495 items, but can still change the |
6496 values. | |
685 | 6497 3 Like 2 but for the |List| / |
6498 |Dictionary| in the |List| / | |
6499 |Dictionary|, one level deeper. | |
6500 The default [depth] is 2, thus when {name} is a |List| | |
6501 or |Dictionary| the values cannot be changed. | |
148 | 6502 *E743* |
6503 For unlimited depth use [!] and omit [depth]. | |
6504 However, there is a maximum depth of 100 to catch | |
6505 loops. | |
6506 | |
685 | 6507 Note that when two variables refer to the same |List| |
6508 and you lock one of them, the |List| will also be | |
819 | 6509 locked when used through the other variable. |
6510 Example: > | |
148 | 6511 :let l = [0, 1, 2, 3] |
6512 :let cl = l | |
6513 :lockvar l | |
6514 :let cl[1] = 99 " won't work! | |
6515 < You may want to make a copy of a list to avoid this. | |
6516 See |deepcopy()|. | |
6517 | |
6518 | |
6519 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
6520 Unlock the internal variable {name}. Does the | |
6521 opposite of |:lockvar|. | |
6522 | |
6523 | |
7 | 6524 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
6525 :en[dif] Execute the commands until the next matching ":else" | |
6526 or ":endif" if {expr1} evaluates to non-zero. | |
6527 | |
6528 From Vim version 4.5 until 5.0, every Ex command in | |
6529 between the ":if" and ":endif" is ignored. These two | |
6530 commands were just to allow for future expansions in a | |
6531 backwards compatible way. Nesting was allowed. Note | |
6532 that any ":else" or ":elseif" was ignored, the "else" | |
6533 part was not executed either. | |
6534 | |
6535 You can use this to remain compatible with older | |
6536 versions: > | |
6537 :if version >= 500 | |
6538 : version-5-specific-commands | |
6539 :endif | |
6540 < The commands still need to be parsed to find the | |
6541 "endif". Sometimes an older Vim has a problem with a | |
6542 new command. For example, ":silent" is recognized as | |
6543 a ":substitute" command. In that case ":execute" can | |
6544 avoid problems: > | |
6545 :if version >= 600 | |
6546 : execute "silent 1,$delete" | |
6547 :endif | |
6548 < | |
6549 NOTE: The ":append" and ":insert" commands don't work | |
6550 properly in between ":if" and ":endif". | |
6551 | |
6552 *:else* *:el* *E581* *E583* | |
6553 :el[se] Execute the commands until the next matching ":else" | |
6554 or ":endif" if they previously were not being | |
6555 executed. | |
6556 | |
6557 *:elseif* *:elsei* *E582* *E584* | |
6558 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
6559 is no extra ":endif". | |
6560 | |
6561 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 6562 *E170* *E585* *E588* *E733* |
7 | 6563 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
6564 as long as {expr1} evaluates to non-zero. | |
6565 When an error is detected from a command inside the | |
6566 loop, execution continues after the "endwhile". | |
75 | 6567 Example: > |
6568 :let lnum = 1 | |
6569 :while lnum <= line("$") | |
6570 :call FixLine(lnum) | |
6571 :let lnum = lnum + 1 | |
6572 :endwhile | |
6573 < | |
7 | 6574 NOTE: The ":append" and ":insert" commands don't work |
99 | 6575 properly inside a ":while" and ":for" loop. |
75 | 6576 |
114 | 6577 :for {var} in {list} *:for* *E690* *E732* |
75 | 6578 :endfo[r] *:endfo* *:endfor* |
6579 Repeat the commands between ":for" and ":endfor" for | |
158 | 6580 each item in {list}. Variable {var} is set to the |
79 | 6581 value of each item. |
6582 When an error is detected for a command inside the | |
75 | 6583 loop, execution continues after the "endfor". |
464 | 6584 Changing {list} inside the loop affects what items are |
6585 used. Make a copy if this is unwanted: > | |
79 | 6586 :for item in copy(mylist) |
6587 < When not making a copy, Vim stores a reference to the | |
6588 next item in the list, before executing the commands | |
1621 | 6589 with the current item. Thus the current item can be |
79 | 6590 removed without effect. Removing any later item means |
6591 it will not be found. Thus the following example | |
6592 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6593 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6594 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6595 endfor |
87 | 6596 < Note that reordering the list (e.g., with sort() or |
6597 reverse()) may have unexpected effects. | |
6598 Note that the type of each list item should be | |
75 | 6599 identical to avoid errors for the type of {var} |
6600 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6601 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6602 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6603 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6604 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6605 endfor |
75 | 6606 |
6607 :for [{var1}, {var2}, ...] in {listlist} | |
6608 :endfo[r] | |
6609 Like ":for" above, but each item in {listlist} must be | |
6610 a list, of which each item is assigned to {var1}, | |
6611 {var2}, etc. Example: > | |
6612 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
6613 :echo getline(lnum)[col] | |
6614 :endfor | |
6615 < | |
7 | 6616 *:continue* *:con* *E586* |
75 | 6617 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
6618 to the start of the loop. | |
6619 If it is used after a |:try| inside the loop but | |
6620 before the matching |:finally| (if present), the | |
6621 commands following the ":finally" up to the matching | |
6622 |:endtry| are executed first. This process applies to | |
6623 all nested ":try"s inside the loop. The outermost | |
6624 ":endtry" then jumps back to the start of the loop. | |
7 | 6625 |
6626 *:break* *:brea* *E587* | |
75 | 6627 :brea[k] When used inside a ":while" or ":for" loop, skips to |
6628 the command after the matching ":endwhile" or | |
6629 ":endfor". | |
6630 If it is used after a |:try| inside the loop but | |
6631 before the matching |:finally| (if present), the | |
6632 commands following the ":finally" up to the matching | |
6633 |:endtry| are executed first. This process applies to | |
6634 all nested ":try"s inside the loop. The outermost | |
6635 ":endtry" then jumps to the command after the loop. | |
7 | 6636 |
6637 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
6638 :endt[ry] Change the error handling for the commands between | |
6639 ":try" and ":endtry" including everything being | |
6640 executed across ":source" commands, function calls, | |
6641 or autocommand invocations. | |
6642 | |
6643 When an error or interrupt is detected and there is | |
6644 a |:finally| command following, execution continues | |
6645 after the ":finally". Otherwise, or when the | |
6646 ":endtry" is reached thereafter, the next | |
6647 (dynamically) surrounding ":try" is checked for | |
6648 a corresponding ":finally" etc. Then the script | |
6649 processing is terminated. (Whether a function | |
6650 definition has an "abort" argument does not matter.) | |
6651 Example: > | |
6652 :try | edit too much | finally | echo "cleanup" | endtry | |
6653 :echo "impossible" " not reached, script terminated above | |
6654 < | |
6655 Moreover, an error or interrupt (dynamically) inside | |
6656 ":try" and ":endtry" is converted to an exception. It | |
6657 can be caught as if it were thrown by a |:throw| | |
6658 command (see |:catch|). In this case, the script | |
6659 processing is not terminated. | |
6660 | |
6661 The value "Vim:Interrupt" is used for an interrupt | |
6662 exception. An error in a Vim command is converted | |
6663 to a value of the form "Vim({command}):{errmsg}", | |
6664 other errors are converted to a value of the form | |
6665 "Vim:{errmsg}". {command} is the full command name, | |
6666 and {errmsg} is the message that is displayed if the | |
6667 error exception is not caught, always beginning with | |
6668 the error number. | |
6669 Examples: > | |
6670 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
6671 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
6672 < | |
6673 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6674 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 6675 |:finally|, or |:endtry| that belongs to the same |
6676 |:try| as the ":catch" are executed when an exception | |
6677 matching {pattern} is being thrown and has not yet | |
6678 been caught by a previous ":catch". Otherwise, these | |
6679 commands are skipped. | |
6680 When {pattern} is omitted all errors are caught. | |
6681 Examples: > | |
6682 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
6683 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
6684 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
6685 :catch /^Vim(write):/ " catch all errors in :write | |
6686 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
6687 :catch /my-exception/ " catch user exception | |
6688 :catch /.*/ " catch everything | |
6689 :catch " same as /.*/ | |
6690 < | |
6691 Another character can be used instead of / around the | |
6692 {pattern}, so long as it does not have a special | |
6693 meaning (e.g., '|' or '"') and doesn't occur inside | |
6694 {pattern}. | |
6695 NOTE: It is not reliable to ":catch" the TEXT of | |
6696 an error message because it may vary in different | |
6697 locales. | |
6698 | |
6699 *:fina* *:finally* *E606* *E607* | |
6700 :fina[lly] The following commands until the matching |:endtry| | |
6701 are executed whenever the part between the matching | |
6702 |:try| and the ":finally" is left: either by falling | |
6703 through to the ":finally" or by a |:continue|, | |
6704 |:break|, |:finish|, or |:return|, or by an error or | |
6705 interrupt or exception (see |:throw|). | |
6706 | |
6707 *:th* *:throw* *E608* | |
6708 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
6709 If the ":throw" is used after a |:try| but before the | |
6710 first corresponding |:catch|, commands are skipped | |
6711 until the first ":catch" matching {expr1} is reached. | |
6712 If there is no such ":catch" or if the ":throw" is | |
6713 used after a ":catch" but before the |:finally|, the | |
6714 commands following the ":finally" (if present) up to | |
6715 the matching |:endtry| are executed. If the ":throw" | |
6716 is after the ":finally", commands up to the ":endtry" | |
6717 are skipped. At the ":endtry", this process applies | |
6718 again for the next dynamically surrounding ":try" | |
6719 (which may be found in a calling function or sourcing | |
6720 script), until a matching ":catch" has been found. | |
6721 If the exception is not caught, the command processing | |
6722 is terminated. | |
6723 Example: > | |
6724 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
6725 < | |
6726 | |
6727 *:ec* *:echo* | |
6728 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
6729 first {expr1} starts on a new line. | |
6730 Also see |:comment|. | |
6731 Use "\n" to start a new line. Use "\r" to move the | |
6732 cursor to the first column. | |
6733 Uses the highlighting set by the |:echohl| command. | |
6734 Cannot be followed by a comment. | |
6735 Example: > | |
6736 :echo "the value of 'shell' is" &shell | |
1156 | 6737 < *:echo-redraw* |
6738 A later redraw may make the message disappear again. | |
6739 And since Vim mostly postpones redrawing until it's | |
6740 finished with a sequence of commands this happens | |
6741 quite often. To avoid that a command from before the | |
6742 ":echo" causes a redraw afterwards (redraws are often | |
6743 postponed until you type something), force a redraw | |
6744 with the |:redraw| command. Example: > | |
7 | 6745 :new | redraw | echo "there is a new window" |
6746 < | |
6747 *:echon* | |
6748 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
6749 |:comment|. | |
6750 Uses the highlighting set by the |:echohl| command. | |
6751 Cannot be followed by a comment. | |
6752 Example: > | |
6753 :echon "the value of 'shell' is " &shell | |
6754 < | |
6755 Note the difference between using ":echo", which is a | |
6756 Vim command, and ":!echo", which is an external shell | |
6757 command: > | |
6758 :!echo % --> filename | |
6759 < The arguments of ":!" are expanded, see |:_%|. > | |
6760 :!echo "%" --> filename or "filename" | |
6761 < Like the previous example. Whether you see the double | |
6762 quotes or not depends on your 'shell'. > | |
6763 :echo % --> nothing | |
6764 < The '%' is an illegal character in an expression. > | |
6765 :echo "%" --> % | |
6766 < This just echoes the '%' character. > | |
6767 :echo expand("%") --> filename | |
6768 < This calls the expand() function to expand the '%'. | |
6769 | |
6770 *:echoh* *:echohl* | |
6771 :echoh[l] {name} Use the highlight group {name} for the following | |
6772 |:echo|, |:echon| and |:echomsg| commands. Also used | |
6773 for the |input()| prompt. Example: > | |
6774 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
6775 < Don't forget to set the group back to "None", | |
6776 otherwise all following echo's will be highlighted. | |
6777 | |
6778 *:echom* *:echomsg* | |
6779 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
6780 message in the |message-history|. | |
6781 Spaces are placed between the arguments as with the | |
6782 |:echo| command. But unprintable characters are | |
6783 displayed, not interpreted. | |
1156 | 6784 The parsing works slightly different from |:echo|, |
6785 more like |:execute|. All the expressions are first | |
6786 evaluated and concatenated before echoing anything. | |
6787 The expressions must evaluate to a Number or String, a | |
6788 Dictionary or List causes an error. | |
7 | 6789 Uses the highlighting set by the |:echohl| command. |
6790 Example: > | |
6791 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 6792 < See |:echo-redraw| to avoid the message disappearing |
6793 when the screen is redrawn. | |
7 | 6794 *:echoe* *:echoerr* |
6795 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
6796 message in the |message-history|. When used in a | |
6797 script or function the line number will be added. | |
6798 Spaces are placed between the arguments as with the | |
1621 | 6799 :echo command. When used inside a try conditional, |
7 | 6800 the message is raised as an error exception instead |
6801 (see |try-echoerr|). | |
6802 Example: > | |
6803 :echoerr "This script just failed!" | |
6804 < If you just want a highlighted message use |:echohl|. | |
6805 And to get a beep: > | |
6806 :exe "normal \<Esc>" | |
6807 < | |
6808 *:exe* *:execute* | |
6809 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
6810 of {expr1} as an Ex command. Multiple arguments are | |
1621 | 6811 concatenated, with a space in between. {expr1} is |
7 | 6812 used as the processed command, command line editing |
6813 keys are not recognized. | |
6814 Cannot be followed by a comment. | |
6815 Examples: > | |
6816 :execute "buffer " nextbuf | |
6817 :execute "normal " count . "w" | |
6818 < | |
6819 ":execute" can be used to append a command to commands | |
6820 that don't accept a '|'. Example: > | |
6821 :execute '!ls' | echo "theend" | |
6822 | |
6823 < ":execute" is also a nice way to avoid having to type | |
6824 control characters in a Vim script for a ":normal" | |
6825 command: > | |
6826 :execute "normal ixxx\<Esc>" | |
6827 < This has an <Esc> character, see |expr-string|. | |
6828 | |
1621 | 6829 Be careful to correctly escape special characters in |
6830 file names. The |fnameescape()| function can be used | |
1661 | 6831 for Vim commands, |shellescape()| for |:!| commands. |
6832 Examples: > | |
1621 | 6833 :execute "e " . fnameescape(filename) |
1661 | 6834 :execute "!ls " . shellescape(expand('%:h'), 1) |
1621 | 6835 < |
7 | 6836 Note: The executed string may be any command-line, but |
99 | 6837 you cannot start or end a "while", "for" or "if" |
6838 command. Thus this is illegal: > | |
7 | 6839 :execute 'while i > 5' |
6840 :execute 'echo "test" | break' | |
6841 < | |
6842 It is allowed to have a "while" or "if" command | |
6843 completely in the executed string: > | |
6844 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
6845 < | |
6846 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6847 *:exe-comment* |
7 | 6848 ":execute", ":echo" and ":echon" cannot be followed by |
6849 a comment directly, because they see the '"' as the | |
6850 start of a string. But, you can use '|' followed by a | |
6851 comment. Example: > | |
6852 :echo "foo" | "this is a comment | |
6853 | |
6854 ============================================================================== | |
6855 8. Exception handling *exception-handling* | |
6856 | |
6857 The Vim script language comprises an exception handling feature. This section | |
6858 explains how it can be used in a Vim script. | |
6859 | |
6860 Exceptions may be raised by Vim on an error or on interrupt, see | |
6861 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
6862 exception by using the ":throw" command, see |throw-catch|. | |
6863 | |
6864 | |
6865 TRY CONDITIONALS *try-conditionals* | |
6866 | |
6867 Exceptions can be caught or can cause cleanup code to be executed. You can | |
6868 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
6869 a finally clause (to be executed for cleanup). | |
6870 A try conditional begins with a |:try| command and ends at the matching | |
6871 |:endtry| command. In between, you can use a |:catch| command to start | |
6872 a catch clause, or a |:finally| command to start a finally clause. There may | |
6873 be none or multiple catch clauses, but there is at most one finally clause, | |
6874 which must not be followed by any catch clauses. The lines before the catch | |
6875 clauses and the finally clause is called a try block. > | |
6876 | |
6877 :try | |
1621 | 6878 : ... |
6879 : ... TRY BLOCK | |
6880 : ... | |
7 | 6881 :catch /{pattern}/ |
1621 | 6882 : ... |
6883 : ... CATCH CLAUSE | |
6884 : ... | |
7 | 6885 :catch /{pattern}/ |
1621 | 6886 : ... |
6887 : ... CATCH CLAUSE | |
6888 : ... | |
7 | 6889 :finally |
1621 | 6890 : ... |
6891 : ... FINALLY CLAUSE | |
6892 : ... | |
7 | 6893 :endtry |
6894 | |
6895 The try conditional allows to watch code for exceptions and to take the | |
6896 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
6897 from the try block and also the catch clauses may cause cleanup actions. | |
6898 When no exception is thrown during execution of the try block, the control | |
6899 is transferred to the finally clause, if present. After its execution, the | |
6900 script continues with the line following the ":endtry". | |
6901 When an exception occurs during execution of the try block, the remaining | |
6902 lines in the try block are skipped. The exception is matched against the | |
6903 patterns specified as arguments to the ":catch" commands. The catch clause | |
6904 after the first matching ":catch" is taken, other catch clauses are not | |
6905 executed. The catch clause ends when the next ":catch", ":finally", or | |
6906 ":endtry" command is reached - whatever is first. Then, the finally clause | |
6907 (if present) is executed. When the ":endtry" is reached, the script execution | |
6908 continues in the following line as usual. | |
6909 When an exception that does not match any of the patterns specified by the | |
6910 ":catch" commands is thrown in the try block, the exception is not caught by | |
6911 that try conditional and none of the catch clauses is executed. Only the | |
6912 finally clause, if present, is taken. The exception pends during execution of | |
6913 the finally clause. It is resumed at the ":endtry", so that commands after | |
6914 the ":endtry" are not executed and the exception might be caught elsewhere, | |
6915 see |try-nesting|. | |
6916 When during execution of a catch clause another exception is thrown, the | |
1621 | 6917 remaining lines in that catch clause are not executed. The new exception is |
7 | 6918 not matched against the patterns in any of the ":catch" commands of the same |
6919 try conditional and none of its catch clauses is taken. If there is, however, | |
6920 a finally clause, it is executed, and the exception pends during its | |
6921 execution. The commands following the ":endtry" are not executed. The new | |
6922 exception might, however, be caught elsewhere, see |try-nesting|. | |
6923 When during execution of the finally clause (if present) an exception is | |
1621 | 6924 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 6925 clause has been taken because of an exception from the try block or one of the |
6926 catch clauses, the original (pending) exception is discarded. The commands | |
6927 following the ":endtry" are not executed, and the exception from the finally | |
6928 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
6929 | |
6930 The finally clause is also executed, when a ":break" or ":continue" for | |
6931 a ":while" loop enclosing the complete try conditional is executed from the | |
6932 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
6933 from the try block or a catch clause of a try conditional in a function or | |
6934 sourced script, respectively. The ":break", ":continue", ":return", or | |
6935 ":finish" pends during execution of the finally clause and is resumed when the | |
6936 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
6937 from the finally clause. | |
6938 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
6939 try conditional or when a ":return" or ":finish" is encountered in the finally | |
6940 clause, the rest of the finally clause is skipped, and the ":break", | |
6941 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
6942 clause has been taken because of an exception or an earlier ":break", | |
6943 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
6944 this pending exception or command is discarded. | |
6945 | |
6946 For examples see |throw-catch| and |try-finally|. | |
6947 | |
6948 | |
6949 NESTING OF TRY CONDITIONALS *try-nesting* | |
6950 | |
6951 Try conditionals can be nested arbitrarily. That is, a complete try | |
6952 conditional can be put into the try block, a catch clause, or the finally | |
6953 clause of another try conditional. If the inner try conditional does not | |
6954 catch an exception thrown in its try block or throws a new exception from one | |
6955 of its catch clauses or its finally clause, the outer try conditional is | |
6956 checked according to the rules above. If the inner try conditional is in the | |
6957 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 6958 otherwise only the finally clause is executed. It does not matter for |
7 | 6959 nesting, whether the inner try conditional is directly contained in the outer |
6960 one, or whether the outer one sources a script or calls a function containing | |
6961 the inner try conditional. | |
6962 | |
6963 When none of the active try conditionals catches an exception, just their | |
6964 finally clauses are executed. Thereafter, the script processing terminates. | |
6965 An error message is displayed in case of an uncaught exception explicitly | |
6966 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
6967 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
6968 as usual. | |
6969 | |
6970 For examples see |throw-catch|. | |
6971 | |
6972 | |
6973 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
6974 | |
6975 Exception handling code can get tricky. If you are in doubt what happens, set | |
6976 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
6977 script file. Then you see when an exception is thrown, discarded, caught, or | |
6978 finished. When using a verbosity level of at least 14, things pending in | |
6979 a finally clause are also shown. This information is also given in debug mode | |
6980 (see |debug-scripts|). | |
6981 | |
6982 | |
6983 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
6984 | |
6985 You can throw any number or string as an exception. Use the |:throw| command | |
6986 and pass the value to be thrown as argument: > | |
6987 :throw 4711 | |
6988 :throw "string" | |
6989 < *throw-expression* | |
6990 You can also specify an expression argument. The expression is then evaluated | |
6991 first, and the result is thrown: > | |
6992 :throw 4705 + strlen("string") | |
6993 :throw strpart("strings", 0, 6) | |
6994 | |
6995 An exception might be thrown during evaluation of the argument of the ":throw" | |
6996 command. Unless it is caught there, the expression evaluation is abandoned. | |
6997 The ":throw" command then does not throw a new exception. | |
6998 Example: > | |
6999 | |
7000 :function! Foo(arg) | |
7001 : try | |
7002 : throw a:arg | |
7003 : catch /foo/ | |
7004 : endtry | |
7005 : return 1 | |
7006 :endfunction | |
7007 : | |
7008 :function! Bar() | |
7009 : echo "in Bar" | |
7010 : return 4710 | |
7011 :endfunction | |
7012 : | |
7013 :throw Foo("arrgh") + Bar() | |
7014 | |
7015 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
7016 executed. > | |
7017 :throw Foo("foo") + Bar() | |
7018 however displays "in Bar" and throws 4711. | |
7019 | |
7020 Any other command that takes an expression as argument might also be | |
1621 | 7021 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 7022 exception is then propagated to the caller of the command. |
7023 Example: > | |
7024 | |
7025 :if Foo("arrgh") | |
7026 : echo "then" | |
7027 :else | |
7028 : echo "else" | |
7029 :endif | |
7030 | |
7031 Here neither of "then" or "else" is displayed. | |
7032 | |
7033 *catch-order* | |
7034 Exceptions can be caught by a try conditional with one or more |:catch| | |
7035 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
7036 command can be specified as a pattern argument. The subsequent catch clause | |
7037 gets executed when a matching exception is caught. | |
7038 Example: > | |
7039 | |
7040 :function! Foo(value) | |
7041 : try | |
7042 : throw a:value | |
7043 : catch /^\d\+$/ | |
7044 : echo "Number thrown" | |
7045 : catch /.*/ | |
7046 : echo "String thrown" | |
7047 : endtry | |
7048 :endfunction | |
7049 : | |
7050 :call Foo(0x1267) | |
7051 :call Foo('string') | |
7052 | |
7053 The first call to Foo() displays "Number thrown", the second "String thrown". | |
7054 An exception is matched against the ":catch" commands in the order they are | |
7055 specified. Only the first match counts. So you should place the more | |
7056 specific ":catch" first. The following order does not make sense: > | |
7057 | |
7058 : catch /.*/ | |
7059 : echo "String thrown" | |
7060 : catch /^\d\+$/ | |
7061 : echo "Number thrown" | |
7062 | |
7063 The first ":catch" here matches always, so that the second catch clause is | |
7064 never taken. | |
7065 | |
7066 *throw-variables* | |
7067 If you catch an exception by a general pattern, you may access the exact value | |
7068 in the variable |v:exception|: > | |
7069 | |
7070 : catch /^\d\+$/ | |
7071 : echo "Number thrown. Value is" v:exception | |
7072 | |
7073 You may also be interested where an exception was thrown. This is stored in | |
7074 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
7075 exception most recently caught as long it is not finished. | |
7076 Example: > | |
7077 | |
7078 :function! Caught() | |
7079 : if v:exception != "" | |
7080 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
7081 : else | |
7082 : echo 'Nothing caught' | |
7083 : endif | |
7084 :endfunction | |
7085 : | |
7086 :function! Foo() | |
7087 : try | |
7088 : try | |
7089 : try | |
7090 : throw 4711 | |
7091 : finally | |
7092 : call Caught() | |
7093 : endtry | |
7094 : catch /.*/ | |
7095 : call Caught() | |
7096 : throw "oops" | |
7097 : endtry | |
7098 : catch /.*/ | |
7099 : call Caught() | |
7100 : finally | |
7101 : call Caught() | |
7102 : endtry | |
7103 :endfunction | |
7104 : | |
7105 :call Foo() | |
7106 | |
7107 This displays > | |
7108 | |
7109 Nothing caught | |
7110 Caught "4711" in function Foo, line 4 | |
7111 Caught "oops" in function Foo, line 10 | |
7112 Nothing caught | |
7113 | |
7114 A practical example: The following command ":LineNumber" displays the line | |
7115 number in the script or function where it has been used: > | |
7116 | |
7117 :function! LineNumber() | |
7118 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
7119 :endfunction | |
7120 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
7121 < | |
7122 *try-nested* | |
7123 An exception that is not caught by a try conditional can be caught by | |
7124 a surrounding try conditional: > | |
7125 | |
7126 :try | |
7127 : try | |
7128 : throw "foo" | |
7129 : catch /foobar/ | |
7130 : echo "foobar" | |
7131 : finally | |
7132 : echo "inner finally" | |
7133 : endtry | |
7134 :catch /foo/ | |
7135 : echo "foo" | |
7136 :endtry | |
7137 | |
7138 The inner try conditional does not catch the exception, just its finally | |
7139 clause is executed. The exception is then caught by the outer try | |
7140 conditional. The example displays "inner finally" and then "foo". | |
7141 | |
7142 *throw-from-catch* | |
7143 You can catch an exception and throw a new one to be caught elsewhere from the | |
7144 catch clause: > | |
7145 | |
7146 :function! Foo() | |
7147 : throw "foo" | |
7148 :endfunction | |
7149 : | |
7150 :function! Bar() | |
7151 : try | |
7152 : call Foo() | |
7153 : catch /foo/ | |
7154 : echo "Caught foo, throw bar" | |
7155 : throw "bar" | |
7156 : endtry | |
7157 :endfunction | |
7158 : | |
7159 :try | |
7160 : call Bar() | |
7161 :catch /.*/ | |
7162 : echo "Caught" v:exception | |
7163 :endtry | |
7164 | |
7165 This displays "Caught foo, throw bar" and then "Caught bar". | |
7166 | |
7167 *rethrow* | |
7168 There is no real rethrow in the Vim script language, but you may throw | |
7169 "v:exception" instead: > | |
7170 | |
7171 :function! Bar() | |
7172 : try | |
7173 : call Foo() | |
7174 : catch /.*/ | |
7175 : echo "Rethrow" v:exception | |
7176 : throw v:exception | |
7177 : endtry | |
7178 :endfunction | |
7179 < *try-echoerr* | |
7180 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
7181 exceptions, because it is not possible to fake Vim internal exceptions. | |
7182 Trying so causes an error exception. You should throw your own exception | |
7183 denoting the situation. If you want to cause a Vim error exception containing | |
7184 the original error exception value, you can use the |:echoerr| command: > | |
7185 | |
7186 :try | |
7187 : try | |
7188 : asdf | |
7189 : catch /.*/ | |
7190 : echoerr v:exception | |
7191 : endtry | |
7192 :catch /.*/ | |
7193 : echo v:exception | |
7194 :endtry | |
7195 | |
7196 This code displays | |
7197 | |
1621 | 7198 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 7199 |
7200 | |
7201 CLEANUP CODE *try-finally* | |
7202 | |
7203 Scripts often change global settings and restore them at their end. If the | |
7204 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 7205 an inconsistent state. The same may happen to you in the development phase of |
7 | 7206 a script when an error occurs or you explicitly throw an exception without |
7207 catching it. You can solve these problems by using a try conditional with | |
7208 a finally clause for restoring the settings. Its execution is guaranteed on | |
7209 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
7210 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 7211 to exceptions. When not caught, they terminate the script after the finally |
7 | 7212 clause has been executed.) |
7213 Example: > | |
7214 | |
7215 :try | |
7216 : let s:saved_ts = &ts | |
7217 : set ts=17 | |
7218 : | |
7219 : " Do the hard work here. | |
7220 : | |
7221 :finally | |
7222 : let &ts = s:saved_ts | |
7223 : unlet s:saved_ts | |
7224 :endtry | |
7225 | |
7226 This method should be used locally whenever a function or part of a script | |
7227 changes global settings which need to be restored on failure or normal exit of | |
7228 that function or script part. | |
7229 | |
7230 *break-finally* | |
7231 Cleanup code works also when the try block or a catch clause is left by | |
7232 a ":continue", ":break", ":return", or ":finish". | |
7233 Example: > | |
7234 | |
7235 :let first = 1 | |
7236 :while 1 | |
7237 : try | |
7238 : if first | |
7239 : echo "first" | |
7240 : let first = 0 | |
7241 : continue | |
7242 : else | |
7243 : throw "second" | |
7244 : endif | |
7245 : catch /.*/ | |
7246 : echo v:exception | |
7247 : break | |
7248 : finally | |
7249 : echo "cleanup" | |
7250 : endtry | |
7251 : echo "still in while" | |
7252 :endwhile | |
7253 :echo "end" | |
7254 | |
7255 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
7256 | |
7257 :function! Foo() | |
7258 : try | |
7259 : return 4711 | |
7260 : finally | |
7261 : echo "cleanup\n" | |
7262 : endtry | |
7263 : echo "Foo still active" | |
7264 :endfunction | |
7265 : | |
7266 :echo Foo() "returned by Foo" | |
7267 | |
7268 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 7269 extra ":return" in the finally clause. (Above all, this would override the |
7 | 7270 return value.) |
7271 | |
7272 *except-from-finally* | |
7273 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
7274 a finally clause is possible, but not recommended since it abandons the | |
7275 cleanup actions for the try conditional. But, of course, interrupt and error | |
7276 exceptions might get raised from a finally clause. | |
7277 Example where an error in the finally clause stops an interrupt from | |
7278 working correctly: > | |
7279 | |
7280 :try | |
7281 : try | |
7282 : echo "Press CTRL-C for interrupt" | |
7283 : while 1 | |
7284 : endwhile | |
7285 : finally | |
7286 : unlet novar | |
7287 : endtry | |
7288 :catch /novar/ | |
7289 :endtry | |
7290 :echo "Script still running" | |
7291 :sleep 1 | |
7292 | |
7293 If you need to put commands that could fail into a finally clause, you should | |
7294 think about catching or ignoring the errors in these commands, see | |
7295 |catch-errors| and |ignore-errors|. | |
7296 | |
7297 | |
7298 CATCHING ERRORS *catch-errors* | |
7299 | |
7300 If you want to catch specific errors, you just have to put the code to be | |
7301 watched in a try block and add a catch clause for the error message. The | |
7302 presence of the try conditional causes all errors to be converted to an | |
7303 exception. No message is displayed and |v:errmsg| is not set then. To find | |
7304 the right pattern for the ":catch" command, you have to know how the format of | |
7305 the error exception is. | |
7306 Error exceptions have the following format: > | |
7307 | |
7308 Vim({cmdname}):{errmsg} | |
7309 or > | |
7310 Vim:{errmsg} | |
7311 | |
7312 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 7313 the command name is not known. {errmsg} is the error message usually produced |
7 | 7314 when the error occurs outside try conditionals. It always begins with |
7315 a capital "E", followed by a two or three-digit error number, a colon, and | |
7316 a space. | |
7317 | |
7318 Examples: | |
7319 | |
7320 The command > | |
7321 :unlet novar | |
7322 normally produces the error message > | |
7323 E108: No such variable: "novar" | |
7324 which is converted inside try conditionals to an exception > | |
7325 Vim(unlet):E108: No such variable: "novar" | |
7326 | |
7327 The command > | |
7328 :dwim | |
7329 normally produces the error message > | |
7330 E492: Not an editor command: dwim | |
7331 which is converted inside try conditionals to an exception > | |
7332 Vim:E492: Not an editor command: dwim | |
7333 | |
7334 You can catch all ":unlet" errors by a > | |
7335 :catch /^Vim(unlet):/ | |
7336 or all errors for misspelled command names by a > | |
7337 :catch /^Vim:E492:/ | |
7338 | |
7339 Some error messages may be produced by different commands: > | |
7340 :function nofunc | |
7341 and > | |
7342 :delfunction nofunc | |
7343 both produce the error message > | |
7344 E128: Function name must start with a capital: nofunc | |
7345 which is converted inside try conditionals to an exception > | |
7346 Vim(function):E128: Function name must start with a capital: nofunc | |
7347 or > | |
7348 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
7349 respectively. You can catch the error by its number independently on the | |
7350 command that caused it if you use the following pattern: > | |
7351 :catch /^Vim(\a\+):E128:/ | |
7352 | |
7353 Some commands like > | |
7354 :let x = novar | |
7355 produce multiple error messages, here: > | |
7356 E121: Undefined variable: novar | |
7357 E15: Invalid expression: novar | |
7358 Only the first is used for the exception value, since it is the most specific | |
7359 one (see |except-several-errors|). So you can catch it by > | |
7360 :catch /^Vim(\a\+):E121:/ | |
7361 | |
7362 You can catch all errors related to the name "nofunc" by > | |
7363 :catch /\<nofunc\>/ | |
7364 | |
7365 You can catch all Vim errors in the ":write" and ":read" commands by > | |
7366 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
7367 | |
7368 You can catch all Vim errors by the pattern > | |
7369 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
7370 < | |
7371 *catch-text* | |
7372 NOTE: You should never catch the error message text itself: > | |
7373 :catch /No such variable/ | |
7374 only works in the english locale, but not when the user has selected | |
7375 a different language by the |:language| command. It is however helpful to | |
7376 cite the message text in a comment: > | |
7377 :catch /^Vim(\a\+):E108:/ " No such variable | |
7378 | |
7379 | |
7380 IGNORING ERRORS *ignore-errors* | |
7381 | |
7382 You can ignore errors in a specific Vim command by catching them locally: > | |
7383 | |
7384 :try | |
7385 : write | |
7386 :catch | |
7387 :endtry | |
7388 | |
7389 But you are strongly recommended NOT to use this simple form, since it could | |
7390 catch more than you want. With the ":write" command, some autocommands could | |
7391 be executed and cause errors not related to writing, for instance: > | |
7392 | |
7393 :au BufWritePre * unlet novar | |
7394 | |
7395 There could even be such errors you are not responsible for as a script | |
7396 writer: a user of your script might have defined such autocommands. You would | |
7397 then hide the error from the user. | |
7398 It is much better to use > | |
7399 | |
7400 :try | |
7401 : write | |
7402 :catch /^Vim(write):/ | |
7403 :endtry | |
7404 | |
7405 which only catches real write errors. So catch only what you'd like to ignore | |
7406 intentionally. | |
7407 | |
7408 For a single command that does not cause execution of autocommands, you could | |
7409 even suppress the conversion of errors to exceptions by the ":silent!" | |
7410 command: > | |
7411 :silent! nunmap k | |
7412 This works also when a try conditional is active. | |
7413 | |
7414 | |
7415 CATCHING INTERRUPTS *catch-interrupt* | |
7416 | |
7417 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 7418 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 7419 script is not terminated, then. |
7420 Example: > | |
7421 | |
7422 :function! TASK1() | |
7423 : sleep 10 | |
7424 :endfunction | |
7425 | |
7426 :function! TASK2() | |
7427 : sleep 20 | |
7428 :endfunction | |
7429 | |
7430 :while 1 | |
7431 : let command = input("Type a command: ") | |
7432 : try | |
7433 : if command == "" | |
7434 : continue | |
7435 : elseif command == "END" | |
7436 : break | |
7437 : elseif command == "TASK1" | |
7438 : call TASK1() | |
7439 : elseif command == "TASK2" | |
7440 : call TASK2() | |
7441 : else | |
7442 : echo "\nIllegal command:" command | |
7443 : continue | |
7444 : endif | |
7445 : catch /^Vim:Interrupt$/ | |
7446 : echo "\nCommand interrupted" | |
7447 : " Caught the interrupt. Continue with next prompt. | |
7448 : endtry | |
7449 :endwhile | |
7450 | |
7451 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 7452 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 7453 |
7454 For testing what happens when CTRL-C would be pressed on a specific line in | |
7455 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
7456 command on that line. See |debug-scripts|. | |
7457 | |
7458 | |
7459 CATCHING ALL *catch-all* | |
7460 | |
7461 The commands > | |
7462 | |
7463 :catch /.*/ | |
7464 :catch // | |
7465 :catch | |
7466 | |
7467 catch everything, error exceptions, interrupt exceptions and exceptions | |
7468 explicitly thrown by the |:throw| command. This is useful at the top level of | |
7469 a script in order to catch unexpected things. | |
7470 Example: > | |
7471 | |
7472 :try | |
7473 : | |
7474 : " do the hard work here | |
7475 : | |
7476 :catch /MyException/ | |
7477 : | |
7478 : " handle known problem | |
7479 : | |
7480 :catch /^Vim:Interrupt$/ | |
7481 : echo "Script interrupted" | |
7482 :catch /.*/ | |
7483 : echo "Internal error (" . v:exception . ")" | |
7484 : echo " - occurred at " . v:throwpoint | |
7485 :endtry | |
7486 :" end of script | |
7487 | |
7488 Note: Catching all might catch more things than you want. Thus, you are | |
7489 strongly encouraged to catch only for problems that you can really handle by | |
7490 specifying a pattern argument to the ":catch". | |
7491 Example: Catching all could make it nearly impossible to interrupt a script | |
7492 by pressing CTRL-C: > | |
7493 | |
7494 :while 1 | |
7495 : try | |
7496 : sleep 1 | |
7497 : catch | |
7498 : endtry | |
7499 :endwhile | |
7500 | |
7501 | |
7502 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
7503 | |
7504 Exceptions may be used during execution of autocommands. Example: > | |
7505 | |
7506 :autocmd User x try | |
7507 :autocmd User x throw "Oops!" | |
7508 :autocmd User x catch | |
7509 :autocmd User x echo v:exception | |
7510 :autocmd User x endtry | |
7511 :autocmd User x throw "Arrgh!" | |
7512 :autocmd User x echo "Should not be displayed" | |
7513 : | |
7514 :try | |
7515 : doautocmd User x | |
7516 :catch | |
7517 : echo v:exception | |
7518 :endtry | |
7519 | |
7520 This displays "Oops!" and "Arrgh!". | |
7521 | |
7522 *except-autocmd-Pre* | |
7523 For some commands, autocommands get executed before the main action of the | |
7524 command takes place. If an exception is thrown and not caught in the sequence | |
7525 of autocommands, the sequence and the command that caused its execution are | |
7526 abandoned and the exception is propagated to the caller of the command. | |
7527 Example: > | |
7528 | |
7529 :autocmd BufWritePre * throw "FAIL" | |
7530 :autocmd BufWritePre * echo "Should not be displayed" | |
7531 : | |
7532 :try | |
7533 : write | |
7534 :catch | |
7535 : echo "Caught:" v:exception "from" v:throwpoint | |
7536 :endtry | |
7537 | |
7538 Here, the ":write" command does not write the file currently being edited (as | |
7539 you can see by checking 'modified'), since the exception from the BufWritePre | |
7540 autocommand abandons the ":write". The exception is then caught and the | |
7541 script displays: > | |
7542 | |
7543 Caught: FAIL from BufWrite Auto commands for "*" | |
7544 < | |
7545 *except-autocmd-Post* | |
7546 For some commands, autocommands get executed after the main action of the | |
7547 command has taken place. If this main action fails and the command is inside | |
7548 an active try conditional, the autocommands are skipped and an error exception | |
7549 is thrown that can be caught by the caller of the command. | |
7550 Example: > | |
7551 | |
7552 :autocmd BufWritePost * echo "File successfully written!" | |
7553 : | |
7554 :try | |
7555 : write /i/m/p/o/s/s/i/b/l/e | |
7556 :catch | |
7557 : echo v:exception | |
7558 :endtry | |
7559 | |
7560 This just displays: > | |
7561 | |
7562 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
7563 | |
7564 If you really need to execute the autocommands even when the main action | |
7565 fails, trigger the event from the catch clause. | |
7566 Example: > | |
7567 | |
7568 :autocmd BufWritePre * set noreadonly | |
7569 :autocmd BufWritePost * set readonly | |
7570 : | |
7571 :try | |
7572 : write /i/m/p/o/s/s/i/b/l/e | |
7573 :catch | |
7574 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
7575 :endtry | |
7576 < | |
7577 You can also use ":silent!": > | |
7578 | |
7579 :let x = "ok" | |
7580 :let v:errmsg = "" | |
7581 :autocmd BufWritePost * if v:errmsg != "" | |
7582 :autocmd BufWritePost * let x = "after fail" | |
7583 :autocmd BufWritePost * endif | |
7584 :try | |
7585 : silent! write /i/m/p/o/s/s/i/b/l/e | |
7586 :catch | |
7587 :endtry | |
7588 :echo x | |
7589 | |
7590 This displays "after fail". | |
7591 | |
7592 If the main action of the command does not fail, exceptions from the | |
7593 autocommands will be catchable by the caller of the command: > | |
7594 | |
7595 :autocmd BufWritePost * throw ":-(" | |
7596 :autocmd BufWritePost * echo "Should not be displayed" | |
7597 : | |
7598 :try | |
7599 : write | |
7600 :catch | |
7601 : echo v:exception | |
7602 :endtry | |
7603 < | |
7604 *except-autocmd-Cmd* | |
7605 For some commands, the normal action can be replaced by a sequence of | |
7606 autocommands. Exceptions from that sequence will be catchable by the caller | |
7607 of the command. | |
7608 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 7609 had actually been written when the exception occurred. You need to tell it in |
7 | 7610 some way. > |
7611 | |
7612 :if !exists("cnt") | |
7613 : let cnt = 0 | |
7614 : | |
7615 : autocmd BufWriteCmd * if &modified | |
7616 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
7617 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
7618 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
7619 : autocmd BufWriteCmd * endif | |
7620 : autocmd BufWriteCmd * write | set nomodified | |
7621 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
7622 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
7623 : autocmd BufWriteCmd * endif | |
7624 : autocmd BufWriteCmd * echo "File successfully written!" | |
7625 : autocmd BufWriteCmd * endif | |
7626 :endif | |
7627 : | |
7628 :try | |
7629 : write | |
7630 :catch /^BufWriteCmdError$/ | |
7631 : if &modified | |
7632 : echo "Error on writing (file contents not changed)" | |
7633 : else | |
7634 : echo "Error after writing" | |
7635 : endif | |
7636 :catch /^Vim(write):/ | |
7637 : echo "Error on writing" | |
7638 :endtry | |
7639 | |
7640 When this script is sourced several times after making changes, it displays | |
7641 first > | |
7642 File successfully written! | |
7643 then > | |
7644 Error on writing (file contents not changed) | |
7645 then > | |
7646 Error after writing | |
7647 etc. | |
7648 | |
7649 *except-autocmd-ill* | |
7650 You cannot spread a try conditional over autocommands for different events. | |
7651 The following code is ill-formed: > | |
7652 | |
7653 :autocmd BufWritePre * try | |
7654 : | |
7655 :autocmd BufWritePost * catch | |
7656 :autocmd BufWritePost * echo v:exception | |
7657 :autocmd BufWritePost * endtry | |
7658 : | |
7659 :write | |
7660 | |
7661 | |
7662 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
7663 | |
7664 Some programming languages allow to use hierarchies of exception classes or to | |
7665 pass additional information with the object of an exception class. You can do | |
7666 similar things in Vim. | |
7667 In order to throw an exception from a hierarchy, just throw the complete | |
7668 class name with the components separated by a colon, for instance throw the | |
7669 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
7670 When you want to pass additional information with your exception class, add | |
7671 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
7672 for an error when writing "myfile". | |
7673 With the appropriate patterns in the ":catch" command, you can catch for | |
7674 base classes or derived classes of your hierarchy. Additional information in | |
7675 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
7676 Example: > | |
7677 | |
7678 :function! CheckRange(a, func) | |
7679 : if a:a < 0 | |
7680 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
7681 : endif | |
7682 :endfunction | |
7683 : | |
7684 :function! Add(a, b) | |
7685 : call CheckRange(a:a, "Add") | |
7686 : call CheckRange(a:b, "Add") | |
7687 : let c = a:a + a:b | |
7688 : if c < 0 | |
7689 : throw "EXCEPT:MATHERR:OVERFLOW" | |
7690 : endif | |
7691 : return c | |
7692 :endfunction | |
7693 : | |
7694 :function! Div(a, b) | |
7695 : call CheckRange(a:a, "Div") | |
7696 : call CheckRange(a:b, "Div") | |
7697 : if (a:b == 0) | |
7698 : throw "EXCEPT:MATHERR:ZERODIV" | |
7699 : endif | |
7700 : return a:a / a:b | |
7701 :endfunction | |
7702 : | |
7703 :function! Write(file) | |
7704 : try | |
1621 | 7705 : execute "write" fnameescape(a:file) |
7 | 7706 : catch /^Vim(write):/ |
7707 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
7708 : endtry | |
7709 :endfunction | |
7710 : | |
7711 :try | |
7712 : | |
7713 : " something with arithmetics and I/O | |
7714 : | |
7715 :catch /^EXCEPT:MATHERR:RANGE/ | |
7716 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
7717 : echo "Range error in" function | |
7718 : | |
7719 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
7720 : echo "Math error" | |
7721 : | |
7722 :catch /^EXCEPT:IO/ | |
7723 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
7724 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
7725 : if file !~ '^/' | |
7726 : let file = dir . "/" . file | |
7727 : endif | |
7728 : echo 'I/O error for "' . file . '"' | |
7729 : | |
7730 :catch /^EXCEPT/ | |
7731 : echo "Unspecified error" | |
7732 : | |
7733 :endtry | |
7734 | |
7735 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
7736 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
7737 exceptions with the "Vim" prefix; they are reserved for Vim. | |
7738 Vim error exceptions are parameterized with the name of the command that | |
7739 failed, if known. See |catch-errors|. | |
7740 | |
7741 | |
7742 PECULIARITIES | |
7743 *except-compat* | |
7744 The exception handling concept requires that the command sequence causing the | |
7745 exception is aborted immediately and control is transferred to finally clauses | |
7746 and/or a catch clause. | |
7747 | |
7748 In the Vim script language there are cases where scripts and functions | |
7749 continue after an error: in functions without the "abort" flag or in a command | |
7750 after ":silent!", control flow goes to the following line, and outside | |
7751 functions, control flow goes to the line following the outermost ":endwhile" | |
7752 or ":endif". On the other hand, errors should be catchable as exceptions | |
7753 (thus, requiring the immediate abortion). | |
7754 | |
7755 This problem has been solved by converting errors to exceptions and using | |
7756 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 7757 conditional is active. This is no restriction since an (error) exception can |
7758 be caught only from an active try conditional. If you want an immediate | |
7 | 7759 termination without catching the error, just use a try conditional without |
7760 catch clause. (You can cause cleanup code being executed before termination | |
7761 by specifying a finally clause.) | |
7762 | |
7763 When no try conditional is active, the usual abortion and continuation | |
7764 behavior is used instead of immediate abortion. This ensures compatibility of | |
7765 scripts written for Vim 6.1 and earlier. | |
7766 | |
7767 However, when sourcing an existing script that does not use exception handling | |
7768 commands (or when calling one of its functions) from inside an active try | |
7769 conditional of a new script, you might change the control flow of the existing | |
7770 script on error. You get the immediate abortion on error and can catch the | |
7771 error in the new script. If however the sourced script suppresses error | |
7772 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 7773 |v:errmsg| if appropriate), its execution path is not changed. The error is |
7774 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 7775 where this happens is for scripts that don't care about errors and produce |
7776 error messages. You probably won't want to use such code from your new | |
7777 scripts. | |
7778 | |
7779 *except-syntax-err* | |
7780 Syntax errors in the exception handling commands are never caught by any of | |
7781 the ":catch" commands of the try conditional they belong to. Its finally | |
7782 clauses, however, is executed. | |
7783 Example: > | |
7784 | |
7785 :try | |
7786 : try | |
7787 : throw 4711 | |
7788 : catch /\(/ | |
7789 : echo "in catch with syntax error" | |
7790 : catch | |
7791 : echo "inner catch-all" | |
7792 : finally | |
7793 : echo "inner finally" | |
7794 : endtry | |
7795 :catch | |
7796 : echo 'outer catch-all caught "' . v:exception . '"' | |
7797 : finally | |
7798 : echo "outer finally" | |
7799 :endtry | |
7800 | |
7801 This displays: > | |
7802 inner finally | |
7803 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
7804 outer finally | |
7805 The original exception is discarded and an error exception is raised, instead. | |
7806 | |
7807 *except-single-line* | |
7808 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
7809 a single line, but then syntax errors may make it difficult to recognize the | |
7810 "catch" line, thus you better avoid this. | |
7811 Example: > | |
7812 :try | unlet! foo # | catch | endtry | |
7813 raises an error exception for the trailing characters after the ":unlet!" | |
7814 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
7815 error exception is discarded and the "E488: Trailing characters" message gets | |
7816 displayed. | |
7817 | |
7818 *except-several-errors* | |
7819 When several errors appear in a single command, the first error message is | |
7820 usually the most specific one and therefor converted to the error exception. | |
7821 Example: > | |
7822 echo novar | |
7823 causes > | |
7824 E121: Undefined variable: novar | |
7825 E15: Invalid expression: novar | |
7826 The value of the error exception inside try conditionals is: > | |
7827 Vim(echo):E121: Undefined variable: novar | |
7828 < *except-syntax-error* | |
7829 But when a syntax error is detected after a normal error in the same command, | |
7830 the syntax error is used for the exception being thrown. | |
7831 Example: > | |
7832 unlet novar # | |
7833 causes > | |
7834 E108: No such variable: "novar" | |
7835 E488: Trailing characters | |
7836 The value of the error exception inside try conditionals is: > | |
7837 Vim(unlet):E488: Trailing characters | |
7838 This is done because the syntax error might change the execution path in a way | |
7839 not intended by the user. Example: > | |
7840 try | |
7841 try | unlet novar # | catch | echo v:exception | endtry | |
7842 catch /.*/ | |
7843 echo "outer catch:" v:exception | |
7844 endtry | |
7845 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
7846 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
7847 | |
7848 ============================================================================== | |
7849 9. Examples *eval-examples* | |
7850 | |
1156 | 7851 Printing in Binary ~ |
7 | 7852 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7853 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 7854 :func Nr2Bin(nr) |
7 | 7855 : let n = a:nr |
7856 : let r = "" | |
7857 : while n | |
1156 | 7858 : let r = '01'[n % 2] . r |
7859 : let n = n / 2 | |
7 | 7860 : endwhile |
7861 : return r | |
7862 :endfunc | |
7863 | |
1156 | 7864 :" The function String2Bin() converts each character in a string to a |
7865 :" binary string, separated with dashes. | |
7866 :func String2Bin(str) | |
7 | 7867 : let out = '' |
1156 | 7868 : for ix in range(strlen(a:str)) |
7869 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
7870 : endfor | |
7871 : return out[1:] | |
7 | 7872 :endfunc |
7873 | |
7874 Example of its use: > | |
1156 | 7875 :echo Nr2Bin(32) |
7876 result: "100000" > | |
7877 :echo String2Bin("32") | |
7878 result: "110011-110010" | |
7879 | |
7880 | |
7881 Sorting lines ~ | |
7882 | |
7883 This example sorts lines with a specific compare function. > | |
7884 | |
7885 :func SortBuffer() | |
7886 : let lines = getline(1, '$') | |
7887 : call sort(lines, function("Strcmp")) | |
7888 : call setline(1, lines) | |
7 | 7889 :endfunction |
7890 | |
1156 | 7891 As a one-liner: > |
7892 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
7893 | |
7894 | |
7895 scanf() replacement ~ | |
7 | 7896 *sscanf* |
7897 There is no sscanf() function in Vim. If you need to extract parts from a | |
7898 line, you can use matchstr() and substitute() to do it. This example shows | |
7899 how to get the file name, line number and column number out of a line like | |
7900 "foobar.txt, 123, 45". > | |
7901 :" Set up the match bit | |
7902 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
7903 :"get the part matching the whole expression | |
7904 :let l = matchstr(line, mx) | |
7905 :"get each item out of the match | |
7906 :let file = substitute(l, mx, '\1', '') | |
7907 :let lnum = substitute(l, mx, '\2', '') | |
7908 :let col = substitute(l, mx, '\3', '') | |
7909 | |
7910 The input is in the variable "line", the results in the variables "file", | |
7911 "lnum" and "col". (idea from Michael Geddes) | |
7912 | |
1156 | 7913 |
7914 getting the scriptnames in a Dictionary ~ | |
7915 *scriptnames-dictionary* | |
7916 The |:scriptnames| command can be used to get a list of all script files that | |
7917 have been sourced. There is no equivalent function or variable for this | |
7918 (because it's rarely needed). In case you need to manipulate the list this | |
7919 code can be used: > | |
7920 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
7921 let scriptnames_output = '' | |
7922 redir => scriptnames_output | |
7923 silent scriptnames | |
7924 redir END | |
7925 | |
1621 | 7926 " Split the output into lines and parse each line. Add an entry to the |
1156 | 7927 " "scripts" dictionary. |
7928 let scripts = {} | |
7929 for line in split(scriptnames_output, "\n") | |
7930 " Only do non-blank lines. | |
7931 if line =~ '\S' | |
7932 " Get the first number in the line. | |
1621 | 7933 let nr = matchstr(line, '\d\+') |
1156 | 7934 " Get the file name, remove the script number " 123: ". |
1621 | 7935 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 7936 " Add an item to the Dictionary |
1621 | 7937 let scripts[nr] = name |
1156 | 7938 endif |
7939 endfor | |
7940 unlet scriptnames_output | |
7941 | |
7 | 7942 ============================================================================== |
7943 10. No +eval feature *no-eval-feature* | |
7944 | |
7945 When the |+eval| feature was disabled at compile time, none of the expression | |
7946 evaluation commands are available. To prevent this from causing Vim scripts | |
7947 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
7948 recognized, though the argument of the ":if" and everything between the ":if" | |
7949 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
7950 only if the commands are at the start of the line. The ":else" command is not | |
7951 recognized. | |
7952 | |
7953 Example of how to avoid executing commands when the |+eval| feature is | |
7954 missing: > | |
7955 | |
7956 :if 1 | |
7957 : echo "Expression evaluation is compiled in" | |
7958 :else | |
7959 : echo "You will _never_ see this message" | |
7960 :endif | |
7961 | |
7962 ============================================================================== | |
7963 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
7964 | |
7965 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext' | |
7966 options are evaluated in a sandbox. This means that you are protected from | |
7967 these expressions having nasty side effects. This gives some safety for when | |
1621 | 7968 these options are set from a modeline. It is also used when the command from |
620 | 7969 a tags file is executed and for CTRL-R = in the command line. |
29 | 7970 The sandbox is also used for the |:sandbox| command. |
7 | 7971 |
7972 These items are not allowed in the sandbox: | |
7973 - changing the buffer text | |
7974 - defining or changing mapping, autocommands, functions, user commands | |
7975 - setting certain options (see |option-summary|) | |
1156 | 7976 - setting certain v: variables (see |v:var|) *E794* |
7 | 7977 - executing a shell command |
7978 - reading or writing a file | |
7979 - jumping to another buffer or editing a file | |
625 | 7980 - executing Python, Perl, etc. commands |
29 | 7981 This is not guaranteed 100% secure, but it should block most attacks. |
7982 | |
7983 *:san* *:sandbox* | |
401 | 7984 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 7985 option that may have been set from a modeline, e.g. |
7986 'foldexpr'. | |
7987 | |
634 | 7988 *sandbox-option* |
7989 A few options contain an expression. When this expression is evaluated it may | |
790 | 7990 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 7991 restrictive, thus this only happens when the option was set from an insecure |
7992 location. Insecure in this context are: | |
843 | 7993 - sourcing a .vimrc or .exrc in the current directory |
634 | 7994 - while executing in the sandbox |
7995 - value coming from a modeline | |
7996 | |
7997 Note that when in the sandbox and saving an option value and restoring it, the | |
7998 option will still be marked as it was set in the sandbox. | |
7999 | |
8000 ============================================================================== | |
8001 12. Textlock *textlock* | |
8002 | |
8003 In a few situations it is not allowed to change the text in the buffer, jump | |
8004 to another window and some other things that might confuse or break what Vim | |
8005 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 8006 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 8007 happen any moment the mouse cursor is resting at some position. |
8008 | |
8009 This is not allowed when the textlock is active: | |
8010 - changing the buffer text | |
8011 - jumping to another buffer or window | |
8012 - editing another file | |
8013 - closing a window or quitting Vim | |
8014 - etc. | |
8015 | |
7 | 8016 |
8017 vim:tw=78:ts=8:ft=help:norl: |