Mercurial > vim
annotate runtime/doc/eval.txt @ 3256:ba708ee8d69d
Updated runtime files.
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Tue, 10 Jan 2012 14:55:01 +0100 |
parents | 91e53bcb7946 |
children | b7811ab264bf |
rev | line source |
---|---|
3256 | 1 *eval.txt* For Vim version 7.3. Last change: 2012 Jan 04 |
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 | |
3082 | 42 Number A 32 or 64 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 | |
2581 | 66 the Number. Examples: |
67 Number 123 --> String "123" ~ | |
68 Number 0 --> String "0" ~ | |
69 Number -1 --> String "-1" ~ | |
2152 | 70 *octal* |
7 | 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 | |
2581 | 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 ~ | |
7 | 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 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
538 If you get an error for a numbered function, you can find out what it is with |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
539 a trick. Assuming the function is 42, the command is: > |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
540 :function {42} |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
541 |
102 | 542 |
543 Functions for Dictionaries ~ | |
114 | 544 *E715* |
545 Functions that can be used with a Dictionary: > | |
102 | 546 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
547 :if empty(dict) " TRUE if dict is empty | |
548 :let l = len(dict) " number of items in dict | |
549 :let big = max(dict) " maximum value in dict | |
550 :let small = min(dict) " minimum value in dict | |
551 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
552 :let s = string(dict) " String representation of dict | |
553 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
99 | 554 |
555 | |
556 1.5 More about variables ~ | |
85 | 557 *more-variables* |
7 | 558 If you need to know the type of a variable or expression, use the |type()| |
559 function. | |
560 | |
561 When the '!' flag is included in the 'viminfo' option, global variables that | |
562 start with an uppercase letter, and don't contain a lowercase letter, are | |
563 stored in the viminfo file |viminfo-file|. | |
564 | |
565 When the 'sessionoptions' option contains "global", global variables that | |
566 start with an uppercase letter and contain at least one lowercase letter are | |
567 stored in the session file |session-file|. | |
568 | |
569 variable name can be stored where ~ | |
570 my_var_6 not | |
571 My_Var_6 session file | |
572 MY_VAR_6 viminfo file | |
573 | |
574 | |
575 It's possible to form a variable name with curly braces, see | |
576 |curly-braces-names|. | |
577 | |
578 ============================================================================== | |
579 2. Expression syntax *expression-syntax* | |
580 | |
581 Expression syntax summary, from least to most significant: | |
582 | |
583 |expr1| expr2 ? expr1 : expr1 if-then-else | |
584 | |
585 |expr2| expr3 || expr3 .. logical OR | |
586 | |
587 |expr3| expr4 && expr4 .. logical AND | |
588 | |
589 |expr4| expr5 == expr5 equal | |
590 expr5 != expr5 not equal | |
591 expr5 > expr5 greater than | |
592 expr5 >= expr5 greater than or equal | |
593 expr5 < expr5 smaller than | |
594 expr5 <= expr5 smaller than or equal | |
595 expr5 =~ expr5 regexp matches | |
596 expr5 !~ expr5 regexp doesn't match | |
597 | |
598 expr5 ==? expr5 equal, ignoring case | |
599 expr5 ==# expr5 equal, match case | |
600 etc. As above, append ? for ignoring case, # for | |
601 matching case | |
602 | |
685 | 603 expr5 is expr5 same |List| instance |
604 expr5 isnot expr5 different |List| instance | |
79 | 605 |
606 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 607 expr6 - expr6 .. number subtraction |
608 expr6 . expr6 .. string concatenation | |
609 | |
610 |expr6| expr7 * expr7 .. number multiplication | |
611 expr7 / expr7 .. number division | |
612 expr7 % expr7 .. number modulo | |
613 | |
614 |expr7| ! expr7 logical NOT | |
615 - expr7 unary minus | |
616 + expr7 unary plus | |
102 | 617 |
685 | 618 |expr8| expr8[expr1] byte of a String or item of a |List| |
619 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
620 expr8.name entry in a |Dictionary| | |
621 expr8(expr1, ...) function call with |Funcref| variable | |
102 | 622 |
623 |expr9| number number constant | |
26 | 624 "string" string constant, backslash is special |
99 | 625 'string' string constant, ' is doubled |
685 | 626 [expr1, ...] |List| |
627 {expr1: expr1, ...} |Dictionary| | |
7 | 628 &option option value |
629 (expr1) nested expression | |
630 variable internal variable | |
631 va{ria}ble internal variable with curly braces | |
632 $VAR environment variable | |
633 @r contents of register 'r' | |
634 function(expr1, ...) function call | |
635 func{ti}on(expr1, ...) function call with curly braces | |
636 | |
637 | |
638 ".." indicates that the operations in this level can be concatenated. | |
639 Example: > | |
640 &nu || &list && &shell == "csh" | |
641 | |
642 All expressions within one level are parsed from left to right. | |
643 | |
644 | |
645 expr1 *expr1* *E109* | |
646 ----- | |
647 | |
648 expr2 ? expr1 : expr1 | |
649 | |
650 The expression before the '?' is evaluated to a number. If it evaluates to | |
651 non-zero, the result is the value of the expression between the '?' and ':', | |
652 otherwise the result is the value of the expression after the ':'. | |
653 Example: > | |
654 :echo lnum == 1 ? "top" : lnum | |
655 | |
656 Since the first expression is an "expr2", it cannot contain another ?:. The | |
657 other two expressions can, thus allow for recursive use of ?:. | |
658 Example: > | |
659 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
660 | |
661 To keep this readable, using |line-continuation| is suggested: > | |
662 :echo lnum == 1 | |
663 :\ ? "top" | |
664 :\ : lnum == 1000 | |
665 :\ ? "last" | |
666 :\ : lnum | |
667 | |
1156 | 668 You should always put a space before the ':', otherwise it can be mistaken for |
669 use in a variable such as "a:1". | |
670 | |
7 | 671 |
672 expr2 and expr3 *expr2* *expr3* | |
673 --------------- | |
674 | |
675 *expr-barbar* *expr-&&* | |
676 The "||" and "&&" operators take one argument on each side. The arguments | |
677 are (converted to) Numbers. The result is: | |
678 | |
679 input output ~ | |
680 n1 n2 n1 || n2 n1 && n2 ~ | |
681 zero zero zero zero | |
682 zero non-zero non-zero zero | |
683 non-zero zero non-zero zero | |
684 non-zero non-zero non-zero non-zero | |
685 | |
686 The operators can be concatenated, for example: > | |
687 | |
688 &nu || &list && &shell == "csh" | |
689 | |
690 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
691 | |
692 &nu || (&list && &shell == "csh") | |
693 | |
694 Once the result is known, the expression "short-circuits", that is, further | |
695 arguments are not evaluated. This is like what happens in C. For example: > | |
696 | |
697 let a = 1 | |
698 echo a || b | |
699 | |
700 This is valid even if there is no variable called "b" because "a" is non-zero, | |
701 so the result must be non-zero. Similarly below: > | |
702 | |
703 echo exists("b") && b == "yes" | |
704 | |
705 This is valid whether "b" has been defined or not. The second clause will | |
706 only be evaluated if "b" has been defined. | |
707 | |
708 | |
709 expr4 *expr4* | |
710 ----- | |
711 | |
712 expr5 {cmp} expr5 | |
713 | |
714 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
715 if it evaluates to true. | |
716 | |
1621 | 717 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 718 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
719 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
720 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
721 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
722 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 723 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
724 *expr-is?* *expr-isnot?* | |
7 | 725 use 'ignorecase' match case ignore case ~ |
726 equal == ==# ==? | |
727 not equal != !=# !=? | |
728 greater than > ># >? | |
729 greater than or equal >= >=# >=? | |
730 smaller than < <# <? | |
731 smaller than or equal <= <=# <=? | |
732 regexp matches =~ =~# =~? | |
733 regexp doesn't match !~ !~# !~? | |
2908 | 734 same instance is is# is? |
735 different instance isnot isnot# isnot? | |
7 | 736 |
737 Examples: | |
738 "abc" ==# "Abc" evaluates to 0 | |
739 "abc" ==? "Abc" evaluates to 1 | |
740 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
741 | |
85 | 742 *E691* *E692* |
685 | 743 A |List| can only be compared with a |List| and only "equal", "not equal" and |
744 "is" can be used. This compares the values of the list, recursively. | |
745 Ignoring case means case is ignored when comparing item values. | |
79 | 746 |
114 | 747 *E735* *E736* |
685 | 748 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
749 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
114 | 750 recursively. Ignoring case means case is ignored when comparing item values. |
751 | |
85 | 752 *E693* *E694* |
685 | 753 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
754 equal" can be used. Case is never ignored. | |
755 | |
2908 | 756 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
757 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
758 of a |List| is different from the original |List|. When using "is" without | |
759 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
760 equivalent to using "not equal". Except that a different type means the | |
761 values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is | |
762 false and not a error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match | |
763 and ignore case. | |
79 | 764 |
7 | 765 When comparing a String with a Number, the String is converted to a Number, |
1621 | 766 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
7 | 767 because 'x' converted to a Number is zero. |
768 | |
769 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
770 results in the mathematical difference (comparing byte values), not | |
771 necessarily the alphabetical difference in the local language. | |
772 | |
1621 | 773 When using the operators with a trailing '#', or the short version and |
1156 | 774 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 775 |
776 When using the operators with a trailing '?', or the short version and | |
1156 | 777 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
778 | |
779 'smartcase' is not used. | |
7 | 780 |
781 The "=~" and "!~" operators match the lefthand argument with the righthand | |
782 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
783 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
784 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
785 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
786 single-quote string, see |literal-string|. | |
787 Since a string is considered to be a single line, a multi-line pattern | |
788 (containing \n, backslash-n) will not match. However, a literal NL character | |
789 can be matched like an ordinary character. Examples: | |
790 "foo\nbar" =~ "\n" evaluates to 1 | |
791 "foo\nbar" =~ "\\n" evaluates to 0 | |
792 | |
793 | |
794 expr5 and expr6 *expr5* *expr6* | |
795 --------------- | |
685 | 796 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 797 expr6 - expr6 .. Number subtraction *expr--* |
798 expr6 . expr6 .. String concatenation *expr-.* | |
799 | |
692 | 800 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 801 result is a new list with the two lists Concatenated. |
79 | 802 |
3214 | 803 expr7 * expr7 .. Number multiplication *expr-star* |
804 expr7 / expr7 .. Number division *expr-/* | |
805 expr7 % expr7 .. Number modulo *expr-%* | |
7 | 806 |
807 For all, except ".", Strings are converted to Numbers. | |
3214 | 808 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 809 |
810 Note the difference between "+" and ".": | |
811 "123" + "456" = 579 | |
812 "123" . "456" = "123456" | |
813 | |
1621 | 814 Since '.' has the same precedence as '+' and '-', you need to read: > |
815 1 . 90 + 90.0 | |
816 As: > | |
817 (1 . 90) + 90.0 | |
818 That works, since the String "190" is automatically converted to the Number | |
819 190, which can be added to the Float 90.0. However: > | |
820 1 . 90 * 90.0 | |
821 Should be read as: > | |
822 1 . (90 * 90.0) | |
823 Since '.' has lower precedence than '*'. This does NOT work, since this | |
824 attempts to concatenate a Float and a String. | |
825 | |
826 When dividing a Number by zero the result depends on the value: | |
827 0 / 0 = -0x80000000 (like NaN for Float) | |
828 >0 / 0 = 0x7fffffff (like positive infinity) | |
829 <0 / 0 = -0x7fffffff (like negative infinity) | |
830 (before Vim 7.2 it was always 0x7fffffff) | |
831 | |
7 | 832 When the righthand side of '%' is zero, the result is 0. |
833 | |
685 | 834 None of these work for |Funcref|s. |
79 | 835 |
1621 | 836 . and % do not work for Float. *E804* |
837 | |
7 | 838 |
839 expr7 *expr7* | |
840 ----- | |
841 ! expr7 logical NOT *expr-!* | |
842 - expr7 unary minus *expr-unary--* | |
843 + expr7 unary plus *expr-unary-+* | |
844 | |
845 For '!' non-zero becomes zero, zero becomes one. | |
846 For '-' the sign of the number is changed. | |
847 For '+' the number is unchanged. | |
848 | |
849 A String will be converted to a Number first. | |
850 | |
1621 | 851 These three can be repeated and mixed. Examples: |
7 | 852 !-1 == 0 |
853 !!8 == 1 | |
854 --9 == 9 | |
855 | |
856 | |
857 expr8 *expr8* | |
858 ----- | |
685 | 859 expr8[expr1] item of String or |List| *expr-[]* *E111* |
102 | 860 |
861 If expr8 is a Number or String this results in a String that contains the | |
862 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
|
863 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
864 an alternative. |
55 | 865 |
866 Index zero gives the first character. This is like it works in C. Careful: | |
867 text column numbers start with one! Example, to get the character under the | |
868 cursor: > | |
823 | 869 :let c = getline(".")[col(".") - 1] |
7 | 870 |
871 If the length of the String is less than the index, the result is an empty | |
55 | 872 String. A negative index always results in an empty string (reason: backwards |
873 compatibility). Use [-1:] to get the last byte. | |
874 | |
685 | 875 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 876 for possible index values. If the index is out of range this results in an |
1621 | 877 error. Example: > |
55 | 878 :let item = mylist[-1] " get last item |
879 | |
685 | 880 Generally, if a |List| index is equal to or higher than the length of the |
881 |List|, or more negative than the length of the |List|, this results in an | |
882 error. | |
55 | 883 |
99 | 884 |
102 | 885 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
886 | |
887 If expr8 is a Number or String this results in the substring with the bytes | |
888 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
|
889 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
|
890 |byteidx()| for computing the indexes. |
55 | 891 |
892 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
893 string minus one is used. | |
894 | |
895 A negative number can be used to measure from the end of the string. -1 is | |
896 the last character, -2 the last but one, etc. | |
897 | |
898 If an index goes out of range for the string characters are omitted. If | |
899 expr1b is smaller than expr1a the result is an empty string. | |
900 | |
901 Examples: > | |
902 :let c = name[-1:] " last byte of a string | |
903 :let c = name[-2:-2] " last but one byte of a string | |
904 :let s = line(".")[4:] " from the fifth byte to the end | |
905 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
906 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
907 *sublist* *slice* |
685 | 908 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 909 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 910 just above, except that indexes out of range cause an error. Examples: > |
55 | 911 :let l = mylist[:3] " first four items |
912 :let l = mylist[4:4] " List with one item | |
913 :let l = mylist[:] " shallow copy of a List | |
914 | |
685 | 915 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
916 error. | |
917 | |
918 | |
919 expr8.name entry in a |Dictionary| *expr-entry* | |
920 | |
921 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
922 name will be used as a key in the |Dictionary|. This is just like: | |
923 expr8[name]. | |
99 | 924 |
925 The name must consist of alphanumeric characters, just like a variable name, | |
926 but it may start with a number. Curly braces cannot be used. | |
927 | |
928 There must not be white space before or after the dot. | |
929 | |
930 Examples: > | |
931 :let dict = {"one": 1, 2: "two"} | |
932 :echo dict.one | |
933 :echo dict .2 | |
934 | |
935 Note that the dot is also used for String concatenation. To avoid confusion | |
936 always put spaces around the dot for String concatenation. | |
937 | |
938 | |
685 | 939 expr8(expr1, ...) |Funcref| function call |
102 | 940 |
941 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
942 | |
943 | |
944 | |
945 *expr9* | |
7 | 946 number |
947 ------ | |
3224 | 948 number number constant *expr-number* |
949 *hex-number* *octal-number* | |
7 | 950 |
951 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
952 | |
1621 | 953 *floating-point-format* |
954 Floating point numbers can be written in two forms: | |
955 | |
956 [-+]{N}.{M} | |
957 [-+]{N}.{M}e[-+]{exp} | |
958 | |
959 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
960 contain digits. | |
961 [-+] means there is an optional plus or minus sign. | |
962 {exp} is the exponent, power of 10. | |
963 Only a decimal point is accepted, not a comma. No matter what the current | |
964 locale is. | |
965 {only when compiled with the |+float| feature} | |
966 | |
967 Examples: | |
968 123.456 | |
969 +0.0001 | |
970 55.0 | |
971 -0.123 | |
972 1.234e03 | |
973 1.0E-6 | |
974 -3.1416e+88 | |
975 | |
976 These are INVALID: | |
977 3. empty {M} | |
978 1e40 missing .{M} | |
979 | |
1698 | 980 *float-pi* *float-e* |
981 A few useful values to copy&paste: > | |
982 :let pi = 3.14159265359 | |
983 :let e = 2.71828182846 | |
984 | |
1621 | 985 Rationale: |
986 Before floating point was introduced, the text "123.456" was interpreted as | |
987 the two numbers "123" and "456", both converted to a string and concatenated, | |
988 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 989 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 990 incompatibility was accepted in favor of being able to use the normal notation |
991 for floating point numbers. | |
992 | |
993 *floating-point-precision* | |
994 The precision and range of floating points numbers depends on what "double" | |
995 means in the library Vim was compiled with. There is no way to change this at | |
996 runtime. | |
997 | |
998 The default for displaying a |Float| is to use 6 decimal places, like using | |
999 printf("%g", f). You can select something else when using the |printf()| | |
1000 function. Example: > | |
1001 :echo printf('%.15e', atan(1)) | |
1002 < 7.853981633974483e-01 | |
1003 | |
1004 | |
7 | 1005 |
1006 string *expr-string* *E114* | |
1007 ------ | |
1008 "string" string constant *expr-quote* | |
1009 | |
1010 Note that double quotes are used. | |
1011 | |
1012 A string constant accepts these special characters: | |
1013 \... three-digit octal number (e.g., "\316") | |
1014 \.. two-digit octal number (must be followed by non-digit) | |
1015 \. one-digit octal number (must be followed by non-digit) | |
1016 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1017 \x. byte specified with one hex number (must be followed by non-hex char) | |
1018 \X.. same as \x.. | |
1019 \X. same as \x. | |
1621 | 1020 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1021 current value of 'encoding' (e.g., "\u02a4") |
1022 \U.... same as \u.... | |
1023 \b backspace <BS> | |
1024 \e escape <Esc> | |
1025 \f formfeed <FF> | |
1026 \n newline <NL> | |
1027 \r return <CR> | |
1028 \t tab <Tab> | |
1029 \\ backslash | |
1030 \" double quote | |
2152 | 1031 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1032 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1033 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1034 |
1156 | 1035 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1036 encodings. Use "\u00ff" to store character 255 according to the current value | |
1037 of 'encoding'. | |
1038 | |
7 | 1039 Note that "\000" and "\x00" force the end of the string. |
1040 | |
1041 | |
1042 literal-string *literal-string* *E115* | |
1043 --------------- | |
26 | 1044 'string' string constant *expr-'* |
7 | 1045 |
1046 Note that single quotes are used. | |
1047 | |
1621 | 1048 This string is taken as it is. No backslashes are removed or have a special |
99 | 1049 meaning. The only exception is that two quotes stand for one quote. |
26 | 1050 |
1051 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1052 to be doubled. These two commands are equivalent: > |
26 | 1053 if a =~ "\\s*" |
1054 if a =~ '\s*' | |
7 | 1055 |
1056 | |
1057 option *expr-option* *E112* *E113* | |
1058 ------ | |
1059 &option option value, local value if possible | |
1060 &g:option global option value | |
1061 &l:option local option value | |
1062 | |
1063 Examples: > | |
1064 echo "tabstop is " . &tabstop | |
1065 if &insertmode | |
1066 | |
1067 Any option name can be used here. See |options|. When using the local value | |
1068 and there is no buffer-local or window-local value, the global value is used | |
1069 anyway. | |
1070 | |
1071 | |
1156 | 1072 register *expr-register* *@r* |
7 | 1073 -------- |
1074 @r contents of register 'r' | |
1075 | |
1076 The result is the contents of the named register, as a single string. | |
1077 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1078 register use @" or @@. See |registers| for an explanation of the available |
336 | 1079 registers. |
1080 | |
1081 When using the '=' register you get the expression itself, not what it | |
1082 evaluates to. Use |eval()| to evaluate it. | |
7 | 1083 |
1084 | |
1085 nesting *expr-nesting* *E110* | |
1086 ------- | |
1087 (expr1) nested expression | |
1088 | |
1089 | |
1090 environment variable *expr-env* | |
1091 -------------------- | |
1092 $VAR environment variable | |
1093 | |
1094 The String value of any environment variable. When it is not defined, the | |
1095 result is an empty string. | |
1096 *expr-env-expand* | |
1097 Note that there is a difference between using $VAR directly and using | |
1098 expand("$VAR"). Using it directly will only expand environment variables that | |
1099 are known inside the current Vim session. Using expand() will first try using | |
1100 the environment variables known inside the current Vim session. If that | |
1101 fails, a shell will be used to expand the variable. This can be slow, but it | |
1102 does expand all variables that the shell knows about. Example: > | |
1103 :echo $version | |
1104 :echo expand("$version") | |
1105 The first one probably doesn't echo anything, the second echoes the $version | |
1106 variable (if your shell supports it). | |
1107 | |
1108 | |
1109 internal variable *expr-variable* | |
1110 ----------------- | |
1111 variable internal variable | |
1112 See below |internal-variables|. | |
1113 | |
1114 | |
170 | 1115 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1116 ------------- |
1117 function(expr1, ...) function call | |
1118 See below |functions|. | |
1119 | |
1120 | |
1121 ============================================================================== | |
2596 | 1122 3. Internal variable *internal-variables* *E461* |
1123 | |
7 | 1124 An internal variable name can be made up of letters, digits and '_'. But it |
1125 cannot start with a digit. It's also possible to use curly braces, see | |
1126 |curly-braces-names|. | |
1127 | |
1128 An internal variable is created with the ":let" command |:let|. | |
87 | 1129 An internal variable is explicitly destroyed with the ":unlet" command |
1130 |:unlet|. | |
1131 Using a name that is not an internal variable or refers to a variable that has | |
1132 been destroyed results in an error. | |
7 | 1133 |
1134 There are several name spaces for variables. Which one is to be used is | |
1135 specified by what is prepended: | |
1136 | |
1137 (nothing) In a function: local to a function; otherwise: global | |
1138 |buffer-variable| b: Local to the current buffer. | |
1139 |window-variable| w: Local to the current window. | |
819 | 1140 |tabpage-variable| t: Local to the current tab page. |
7 | 1141 |global-variable| g: Global. |
1142 |local-variable| l: Local to a function. | |
1143 |script-variable| s: Local to a |:source|'ed Vim script. | |
1144 |function-argument| a: Function argument (only inside a function). | |
1621 | 1145 |vim-variable| v: Global, predefined by Vim. |
7 | 1146 |
685 | 1147 The scope name by itself can be used as a |Dictionary|. For example, to |
1148 delete all script-local variables: > | |
133 | 1149 :for k in keys(s:) |
1150 : unlet s:[k] | |
1151 :endfor | |
1152 < | |
7 | 1153 *buffer-variable* *b:var* |
1154 A variable name that is preceded with "b:" is local to the current buffer. | |
1155 Thus you can have several "b:foo" variables, one for each buffer. | |
1156 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1157 |:bdelete|. | |
1158 | |
1159 One local buffer variable is predefined: | |
1160 *b:changedtick-variable* *changetick* | |
1161 b:changedtick The total number of changes to the current buffer. It is | |
1162 incremented for each change. An undo command is also a change | |
1163 in this case. This can be used to perform an action only when | |
1164 the buffer has changed. Example: > | |
1165 :if my_changedtick != b:changedtick | |
1621 | 1166 : let my_changedtick = b:changedtick |
1167 : call My_Update() | |
7 | 1168 :endif |
1169 < | |
1170 *window-variable* *w:var* | |
1171 A variable name that is preceded with "w:" is local to the current window. It | |
1172 is deleted when the window is closed. | |
1173 | |
819 | 1174 *tabpage-variable* *t:var* |
1175 A variable name that is preceded with "t:" is local to the current tab page, | |
1176 It is deleted when the tab page is closed. {not available when compiled | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
1177 without the |+windows| feature} |
819 | 1178 |
7 | 1179 *global-variable* *g:var* |
1180 Inside functions global variables are accessed with "g:". Omitting this will | |
1621 | 1181 access a variable local to a function. But "g:" can also be used in any other |
7 | 1182 place if you like. |
1183 | |
1184 *local-variable* *l:var* | |
1185 Inside functions local variables are accessed without prepending anything. | |
1156 | 1186 But you can also prepend "l:" if you like. However, without prepending "l:" |
1187 you may run into reserved variable names. For example "count". By itself it | |
1188 refers to "v:count". Using "l:count" you can have a local variable with the | |
1189 same name. | |
7 | 1190 |
1191 *script-variable* *s:var* | |
1192 In a Vim script variables starting with "s:" can be used. They cannot be | |
1193 accessed from outside of the scripts, thus are local to the script. | |
1194 | |
1195 They can be used in: | |
1196 - commands executed while the script is sourced | |
1197 - functions defined in the script | |
1198 - autocommands defined in the script | |
1199 - functions and autocommands defined in functions and autocommands which were | |
1200 defined in the script (recursively) | |
1201 - user defined commands defined in the script | |
1202 Thus not in: | |
1203 - other scripts sourced from this one | |
1204 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1205 - menus |
7 | 1206 - etc. |
1207 | |
1156 | 1208 Script variables can be used to avoid conflicts with global variable names. |
1209 Take this example: > | |
7 | 1210 |
1211 let s:counter = 0 | |
1212 function MyCounter() | |
1213 let s:counter = s:counter + 1 | |
1214 echo s:counter | |
1215 endfunction | |
1216 command Tick call MyCounter() | |
1217 | |
1218 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1219 that script will not be changed, only the "s:counter" in the script where | |
1220 "Tick" was defined is used. | |
1221 | |
1222 Another example that does the same: > | |
1223 | |
1224 let s:counter = 0 | |
1225 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1226 | |
1227 When calling a function and invoking a user-defined command, the context for | |
9 | 1228 script variables is set to the script where the function or command was |
7 | 1229 defined. |
1230 | |
1231 The script variables are also available when a function is defined inside a | |
1232 function that is defined in a script. Example: > | |
1233 | |
1234 let s:counter = 0 | |
1235 function StartCounting(incr) | |
1236 if a:incr | |
1237 function MyCounter() | |
1238 let s:counter = s:counter + 1 | |
1239 endfunction | |
1240 else | |
1241 function MyCounter() | |
1242 let s:counter = s:counter - 1 | |
1243 endfunction | |
1244 endif | |
1245 endfunction | |
1246 | |
1247 This defines the MyCounter() function either for counting up or counting down | |
1248 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1249 called, the s:counter variable will be accessible in MyCounter(). | |
1250 | |
1251 When the same script is sourced again it will use the same script variables. | |
1252 They will remain valid as long as Vim is running. This can be used to | |
1253 maintain a counter: > | |
1254 | |
1255 if !exists("s:counter") | |
1256 let s:counter = 1 | |
1257 echo "script executed for the first time" | |
1258 else | |
1259 let s:counter = s:counter + 1 | |
1260 echo "script executed " . s:counter . " times now" | |
1261 endif | |
1262 | |
1263 Note that this means that filetype plugins don't get a different set of script | |
1264 variables for each buffer. Use local buffer variables instead |b:var|. | |
1265 | |
1266 | |
1267 Predefined Vim variables: *vim-variable* *v:var* | |
1268 | |
189 | 1269 *v:beval_col* *beval_col-variable* |
1270 v:beval_col The number of the column, over which the mouse pointer is. | |
1271 This is the byte index in the |v:beval_lnum| line. | |
1272 Only valid while evaluating the 'balloonexpr' option. | |
1273 | |
1274 *v:beval_bufnr* *beval_bufnr-variable* | |
1275 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1276 valid while evaluating the 'balloonexpr' option. | |
1277 | |
1278 *v:beval_lnum* *beval_lnum-variable* | |
1279 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1280 valid while evaluating the 'balloonexpr' option. | |
1281 | |
1282 *v:beval_text* *beval_text-variable* | |
374 | 1283 v:beval_text The text under or after the mouse pointer. Usually a word as |
1284 it is useful for debugging a C program. 'iskeyword' applies, | |
1285 but a dot and "->" before the position is included. When on a | |
1286 ']' the text before it is used, including the matching '[' and | |
189 | 1287 word before it. When on a Visual area within one line the |
1288 highlighted text is used. | |
1289 Only valid while evaluating the 'balloonexpr' option. | |
1290 | |
1291 *v:beval_winnr* *beval_winnr-variable* | |
1292 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1293 valid while evaluating the 'balloonexpr' option. The first |
1294 window has number zero (unlike most other places where a | |
1295 window gets a number). | |
189 | 1296 |
844 | 1297 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1298 v:char Argument for evaluating 'formatexpr' and used for the typed |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
1299 character when using <expr> in an abbreviation |:map-<expr>|. |
2908 | 1300 It is also used by the |InsertCharPre| event. |
844 | 1301 |
7 | 1302 *v:charconvert_from* *charconvert_from-variable* |
1303 v:charconvert_from | |
1304 The name of the character encoding of a file to be converted. | |
1305 Only valid while evaluating the 'charconvert' option. | |
1306 | |
1307 *v:charconvert_to* *charconvert_to-variable* | |
1308 v:charconvert_to | |
1309 The name of the character encoding of a file after conversion. | |
1310 Only valid while evaluating the 'charconvert' option. | |
1311 | |
1312 *v:cmdarg* *cmdarg-variable* | |
1313 v:cmdarg This variable is used for two purposes: | |
1314 1. The extra arguments given to a file read/write command. | |
1315 Currently these are "++enc=" and "++ff=". This variable is | |
1316 set before an autocommand event for a file read/write | |
1317 command is triggered. There is a leading space to make it | |
1318 possible to append this variable directly after the | |
1621 | 1319 read/write command. Note: The "+cmd" argument isn't |
7 | 1320 included here, because it will be executed anyway. |
1321 2. When printing a PostScript file with ":hardcopy" this is | |
1322 the argument for the ":hardcopy" command. This can be used | |
1323 in 'printexpr'. | |
1324 | |
1325 *v:cmdbang* *cmdbang-variable* | |
1326 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1327 was used the value is 1, otherwise it is 0. Note that this | |
1328 can only be used in autocommands. For user commands |<bang>| | |
1329 can be used. | |
1330 | |
1331 *v:count* *count-variable* | |
1332 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1333 to get the count before a mapping. Read-only. Example: > |
7 | 1334 :map _x :<C-U>echo "the count is " . v:count<CR> |
1335 < Note: The <C-U> is required to remove the line range that you | |
1336 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1337 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1338 just like what happens in the command, "d6w" for the example. |
667 | 1339 Also used for evaluating the 'formatexpr' option. |
7 | 1340 "count" also works, for backwards compatibility. |
1341 | |
1342 *v:count1* *count1-variable* | |
1343 v:count1 Just like "v:count", but defaults to one when no count is | |
1344 used. | |
1345 | |
1346 *v:ctype* *ctype-variable* | |
1347 v:ctype The current locale setting for characters of the runtime | |
1348 environment. This allows Vim scripts to be aware of the | |
1349 current locale encoding. Technical: it's the value of | |
1350 LC_CTYPE. When not using a locale the value is "C". | |
1351 This variable can not be set directly, use the |:language| | |
1352 command. | |
1353 See |multi-lang|. | |
1354 | |
1355 *v:dying* *dying-variable* | |
1621 | 1356 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1357 one. When multiple signals are caught the number increases. |
1358 Can be used in an autocommand to check if Vim didn't | |
1359 terminate normally. {only works on Unix} | |
1360 Example: > | |
1361 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif | |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1362 < Note: if another deadly signal is caught when v:dying is one, |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1363 VimLeave autocommands will not be executed. |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1364 |
7 | 1365 *v:errmsg* *errmsg-variable* |
1366 v:errmsg Last given error message. It's allowed to set this variable. | |
1367 Example: > | |
1368 :let v:errmsg = "" | |
1369 :silent! next | |
1370 :if v:errmsg != "" | |
1371 : ... handle error | |
1372 < "errmsg" also works, for backwards compatibility. | |
1373 | |
1374 *v:exception* *exception-variable* | |
1375 v:exception The value of the exception most recently caught and not | |
1376 finished. See also |v:throwpoint| and |throw-variables|. | |
1377 Example: > | |
1378 :try | |
1379 : throw "oops" | |
1380 :catch /.*/ | |
1381 : echo "caught" v:exception | |
1382 :endtry | |
1383 < Output: "caught oops". | |
1384 | |
179 | 1385 *v:fcs_reason* *fcs_reason-variable* |
1386 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1387 Can be used in an autocommand to decide what to do and/or what | |
1388 to set v:fcs_choice to. Possible values: | |
1389 deleted file no longer exists | |
1390 conflict file contents, mode or timestamp was | |
1391 changed and buffer is modified | |
1392 changed file contents has changed | |
1393 mode mode of file changed | |
1394 time only file timestamp changed | |
1395 | |
1396 *v:fcs_choice* *fcs_choice-variable* | |
1397 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1398 triggered. Can be used in an autocommand to tell Vim what to | |
1399 do with the affected buffer: | |
1400 reload Reload the buffer (does not work if | |
1401 the file was deleted). | |
1402 ask Ask the user what to do, as if there | |
1403 was no autocommand. Except that when | |
1404 only the timestamp changed nothing | |
1405 will happen. | |
1406 <empty> Nothing, the autocommand should do | |
1407 everything that needs to be done. | |
1408 The default is empty. If another (invalid) value is used then | |
1409 Vim behaves like it is empty, there is no warning message. | |
1410 | |
7 | 1411 *v:fname_in* *fname_in-variable* |
579 | 1412 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1413 option used for ~ |
1414 'charconvert' file to be converted | |
1415 'diffexpr' original file | |
1416 'patchexpr' original file | |
1417 'printexpr' file to be printed | |
593 | 1418 And set to the swap file name for |SwapExists|. |
7 | 1419 |
1420 *v:fname_out* *fname_out-variable* | |
1421 v:fname_out The name of the output file. Only valid while | |
1422 evaluating: | |
1423 option used for ~ | |
1424 'charconvert' resulting converted file (*) | |
1425 'diffexpr' output of diff | |
1426 'patchexpr' resulting patched file | |
1427 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1428 file") it will be equal to v:fname_in. When doing conversion |
7 | 1429 for a read command (e.g., ":e file") it will be a temporary |
1430 file and different from v:fname_in. | |
1431 | |
1432 *v:fname_new* *fname_new-variable* | |
1433 v:fname_new The name of the new version of the file. Only valid while | |
1434 evaluating 'diffexpr'. | |
1435 | |
1436 *v:fname_diff* *fname_diff-variable* | |
1437 v:fname_diff The name of the diff (patch) file. Only valid while | |
1438 evaluating 'patchexpr'. | |
1439 | |
1440 *v:folddashes* *folddashes-variable* | |
1441 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1442 fold. | |
29 | 1443 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1444 |
1445 *v:foldlevel* *foldlevel-variable* | |
1446 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1447 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1448 |
1449 *v:foldend* *foldend-variable* | |
1450 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1451 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1452 |
1453 *v:foldstart* *foldstart-variable* | |
1454 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1455 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1456 |
11 | 1457 *v:insertmode* *insertmode-variable* |
1458 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1459 events. Values: | |
1460 i Insert mode | |
1461 r Replace mode | |
1462 v Virtual Replace mode | |
1463 | |
102 | 1464 *v:key* *key-variable* |
685 | 1465 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1466 evaluating the expression used with |map()| and |filter()|. |
1467 Read-only. | |
1468 | |
7 | 1469 *v:lang* *lang-variable* |
1470 v:lang The current locale setting for messages of the runtime | |
1471 environment. This allows Vim scripts to be aware of the | |
1472 current language. Technical: it's the value of LC_MESSAGES. | |
1473 The value is system dependent. | |
1474 This variable can not be set directly, use the |:language| | |
1475 command. | |
1476 It can be different from |v:ctype| when messages are desired | |
1477 in a different language than what is used for character | |
1478 encoding. See |multi-lang|. | |
1479 | |
1480 *v:lc_time* *lc_time-variable* | |
1481 v:lc_time The current locale setting for time messages of the runtime | |
1482 environment. This allows Vim scripts to be aware of the | |
1483 current language. Technical: it's the value of LC_TIME. | |
1484 This variable can not be set directly, use the |:language| | |
1485 command. See |multi-lang|. | |
1486 | |
1487 *v:lnum* *lnum-variable* | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1488 v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1489 'indentexpr' expressions, tab page number for 'guitablabel' |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1490 and 'guitabtooltip'. Only valid while one of these |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1491 expressions is being evaluated. Read-only when in the |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1492 |sandbox|. |
7 | 1493 |
1029 | 1494 *v:mouse_win* *mouse_win-variable* |
1495 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1496 First window has number 1, like with |winnr()|. The value is | |
1497 zero when there was no mouse button click. | |
1498 | |
1499 *v:mouse_lnum* *mouse_lnum-variable* | |
1500 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1501 This is the text line number, not the screen line number. The | |
1502 value is zero when there was no mouse button click. | |
1503 | |
1504 *v:mouse_col* *mouse_col-variable* | |
1505 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1506 This is the screen column number, like with |virtcol()|. The | |
1507 value is zero when there was no mouse button click. | |
1508 | |
1733 | 1509 *v:oldfiles* *oldfiles-variable* |
1510 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1511 startup. These are the files that Vim remembers marks for. | |
1512 The length of the List is limited by the ' argument of the | |
1513 'viminfo' option (default is 100). | |
1514 Also see |:oldfiles| and |c_#<|. | |
1515 The List can be modified, but this has no effect on what is | |
1516 stored in the |viminfo| file later. If you use values other | |
1517 than String this will cause trouble. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
1518 {only when compiled with the |+viminfo| feature} |
1733 | 1519 |
1490 | 1520 *v:operator* *operator-variable* |
1521 v:operator The last operator given in Normal mode. This is a single | |
1522 character except for commands starting with <g> or <z>, | |
1523 in which case it is two characters. Best used alongside | |
1524 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1525 Operator-pending mode and then use the operator, e.g.: > | |
1526 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1527 < The value remains set until another operator is entered, thus | |
1528 don't expect it to be empty. | |
1529 v:operator is not set for |:delete|, |:yank| or other Ex | |
1530 commands. | |
1531 Read-only. | |
1532 | |
7 | 1533 *v:prevcount* *prevcount-variable* |
1534 v:prevcount The count given for the last but one Normal mode command. | |
1535 This is the v:count value of the previous command. Useful if | |
1490 | 1536 you want to cancel Visual or Operator-pending mode and then |
1537 use the count, e.g.: > | |
7 | 1538 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1539 < Read-only. | |
1540 | |
170 | 1541 *v:profiling* *profiling-variable* |
1621 | 1542 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1543 See |profiling|. |
1544 | |
7 | 1545 *v:progname* *progname-variable* |
1546 v:progname Contains the name (with path removed) with which Vim was | |
1547 invoked. Allows you to do special initialisations for "view", | |
1548 "evim" etc., or any other name you might symlink to Vim. | |
1549 Read-only. | |
1550 | |
1551 *v:register* *register-variable* | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1552 v:register The name of the register in effect for the current normal mode |
2826 | 1553 command. If none is supplied it is the default register '"', |
1554 unless 'clipboard' contains "unnamed" or "unnamedplus", then | |
1555 it is '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1556 Also see |getreg()| and |setreg()| |
7 | 1557 |
540 | 1558 *v:scrollstart* *scrollstart-variable* |
1559 v:scrollstart String describing the script or function that caused the | |
1560 screen to scroll up. It's only set when it is empty, thus the | |
1561 first reason is remembered. It is set to "Unknown" for a | |
1562 typed command. | |
1563 This can be used to find out why your script causes the | |
1564 hit-enter prompt. | |
1565 | |
7 | 1566 *v:servername* *servername-variable* |
1567 v:servername The resulting registered |x11-clientserver| name if any. | |
1568 Read-only. | |
1569 | |
1621 | 1570 |
1571 v:searchforward *v:searchforward* *searchforward-variable* | |
1572 Search direction: 1 after a forward search, 0 after a | |
1573 backward search. It is reset to forward when directly setting | |
1574 the last search pattern, see |quote/|. | |
1575 Note that the value is restored when returning from a | |
1576 function. |function-search-undo|. | |
1577 Read-write. | |
1578 | |
7 | 1579 *v:shell_error* *shell_error-variable* |
1580 v:shell_error Result of the last shell command. When non-zero, the last | |
1581 shell command had an error. When zero, there was no problem. | |
1582 This only works when the shell returns the error code to Vim. | |
1583 The value -1 is often used when the command could not be | |
1584 executed. Read-only. | |
1585 Example: > | |
1586 :!mv foo bar | |
1587 :if v:shell_error | |
1588 : echo 'could not rename "foo" to "bar"!' | |
1589 :endif | |
1590 < "shell_error" also works, for backwards compatibility. | |
1591 | |
1592 *v:statusmsg* *statusmsg-variable* | |
1593 v:statusmsg Last given status message. It's allowed to set this variable. | |
1594 | |
579 | 1595 *v:swapname* *swapname-variable* |
1596 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1597 the swap file found. Read-only. | |
1598 | |
1599 *v:swapchoice* *swapchoice-variable* | |
1600 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1601 for handling an existing swap file: | |
1602 'o' Open read-only | |
1603 'e' Edit anyway | |
1604 'r' Recover | |
1605 'd' Delete swapfile | |
1606 'q' Quit | |
1607 'a' Abort | |
1621 | 1608 The value should be a single-character string. An empty value |
579 | 1609 results in the user being asked, as would happen when there is |
1610 no SwapExists autocommand. The default is empty. | |
1611 | |
590 | 1612 *v:swapcommand* *swapcommand-variable* |
625 | 1613 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1614 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1615 another Vim open the file and jump to the right place. For |
590 | 1616 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1617 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1618 |
7 | 1619 *v:termresponse* *termresponse-variable* |
1620 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1621 termcap entry. It is set when Vim receives an escape sequence |
7 | 1622 that starts with ESC [ or CSI and ends in a 'c', with only |
1623 digits, ';' and '.' in between. | |
1624 When this option is set, the TermResponse autocommand event is | |
1625 fired, so that you can react to the response from the | |
1626 terminal. | |
1627 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1628 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1629 patch level (since this was introduced in patch 95, it's | |
1630 always 95 or bigger). Pc is always zero. | |
1631 {only when compiled with |+termresponse| feature} | |
1632 | |
1633 *v:this_session* *this_session-variable* | |
1634 v:this_session Full filename of the last loaded or saved session file. See | |
1635 |:mksession|. It is allowed to set this variable. When no | |
1636 session file has been saved, this variable is empty. | |
1637 "this_session" also works, for backwards compatibility. | |
1638 | |
1639 *v:throwpoint* *throwpoint-variable* | |
1640 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1641 finished was thrown. Not set when commands are typed. See |
7 | 1642 also |v:exception| and |throw-variables|. |
1643 Example: > | |
1644 :try | |
1645 : throw "oops" | |
1646 :catch /.*/ | |
1647 : echo "Exception from" v:throwpoint | |
1648 :endtry | |
1649 < Output: "Exception from test.vim, line 2" | |
1650 | |
102 | 1651 *v:val* *val-variable* |
1621 | 1652 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1653 valid while evaluating the expression used with |map()| and |
102 | 1654 |filter()|. Read-only. |
1655 | |
7 | 1656 *v:version* *version-variable* |
1657 v:version Version number of Vim: Major version number times 100 plus | |
1658 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1659 is 501. Read-only. "version" also works, for backwards | |
1660 compatibility. | |
1661 Use |has()| to check if a certain patch was included, e.g.: > | |
1662 if has("patch123") | |
1663 < Note that patch numbers are specific to the version, thus both | |
1664 version 5.0 and 5.1 may have a patch 123, but these are | |
1665 completely different. | |
1666 | |
1667 *v:warningmsg* *warningmsg-variable* | |
1668 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1669 | |
2609 | 1670 *v:windowid* *windowid-variable* |
1671 v:windowid When any X11 based GUI is running or when running in a | |
1672 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1673 set to the window ID. |
1674 When an MS-Windows GUI is running this will be set to the | |
1675 window handle. | |
1676 Otherwise the value is zero. | |
1677 Note: for windows inside Vim use |winnr()|. | |
2609 | 1678 |
7 | 1679 ============================================================================== |
1680 4. Builtin Functions *functions* | |
1681 | |
1682 See |function-list| for a list grouped by what the function is used for. | |
1683 | |
236 | 1684 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1685 |
1686 USAGE RESULT DESCRIPTION ~ | |
1687 | |
1621 | 1688 abs( {expr}) Float or Number absolute value of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1689 acos( {expr}) Float arc cosine of {expr} |
685 | 1690 add( {list}, {item}) List append {item} to |List| {list} |
3214 | 1691 and( {expr}, {expr}) Number bitwise AND |
55 | 1692 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1693 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1694 argc() Number number of files in the argument list |
55 | 1695 argidx() Number current index in the argument list |
7 | 1696 argv( {nr}) String {nr} entry of the argument list |
818 | 1697 argv( ) List the argument list |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1698 asin( {expr}) Float arc sine of {expr} |
1621 | 1699 atan( {expr}) Float arc tangent of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1700 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
7 | 1701 browse( {save}, {title}, {initdir}, {default}) |
1702 String put up a file requester | |
1621 | 1703 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1704 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1705 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1706 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1707 bufname( {expr}) String Name of the buffer {expr} |
1708 bufnr( {expr}) Number Number of the buffer {expr} | |
1709 bufwinnr( {expr}) Number window number of buffer {expr} | |
1710 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1711 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1712 call( {func}, {arglist} [, {dict}]) |
1713 any call {func} with arguments {arglist} | |
1621 | 1714 ceil( {expr}) Float round {expr} up |
1715 changenr() Number current change number | |
7 | 1716 char2nr( {expr}) Number ASCII value of first char in {expr} |
55 | 1717 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1718 clearmatches() none clear all matches |
7 | 1719 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1720 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1721 complete_add( {expr}) Number add completion match |
1621 | 1722 complete_check() Number check for key typed during completion |
7 | 1723 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1724 Number number of choice picked by user | |
55 | 1725 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1726 cos( {expr}) Float cosine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1727 cosh( {expr}) Float hyperbolic cosine of {expr} |
95 | 1728 count( {list}, {expr} [, {start} [, {ic}]]) |
1729 Number count how many {expr} are in {list} | |
7 | 1730 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1731 Number checks existence of cscope connection | |
703 | 1732 cursor( {lnum}, {col} [, {coladd}]) |
1733 Number move cursor to {lnum}, {col}, {coladd} | |
1734 cursor( {list}) Number move cursor to position in {list} | |
55 | 1735 deepcopy( {expr}) any make a full copy of {expr} |
7 | 1736 delete( {fname}) Number delete file {fname} |
1737 did_filetype() Number TRUE if FileType autocommand event used | |
55 | 1738 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1739 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
85 | 1740 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1741 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1742 eval( {string}) any evaluate {string} into its value |
55 | 1743 eventhandler( ) Number TRUE if inside an event handler |
7 | 1744 executable( {expr}) Number 1 if executable {expr} exists |
1745 exists( {expr}) Number TRUE if {expr} exists | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1746 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1747 List/Dict insert items of {expr2} into {expr1} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1748 exp( {expr}) Float exponential of {expr} |
1754 | 1749 expand( {expr} [, {flag}]) String expand special keywords in {expr} |
1621 | 1750 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1751 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1752 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1753 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1754 {string} is 0 | |
95 | 1755 finddir( {name}[, {path}[, {count}]]) |
824 | 1756 String find directory {name} in {path} |
19 | 1757 findfile( {name}[, {path}[, {count}]]) |
824 | 1758 String find file {name} in {path} |
1621 | 1759 float2nr( {expr}) Number convert Float {expr} to a Number |
1760 floor( {expr}) Float round {expr} down | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1761 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
1586 | 1762 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1763 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1764 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1765 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1766 foldlevel( {lnum}) Number fold level at {lnum} |
55 | 1767 foldtext( ) String line displayed for closed fold |
824 | 1768 foldtextresult( {lnum}) String text for closed fold at {lnum} |
7 | 1769 foreground( ) Number bring the Vim window to the foreground |
55 | 1770 function( {name}) Funcref reference to function {name} |
3224 | 1771 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
82 | 1772 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1773 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1774 getbufline( {expr}, {lnum} [, {end}]) |
1775 List lines {lnum} to {end} of buffer {expr} | |
824 | 1776 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr} |
55 | 1777 getchar( [expr]) Number get one character from the user |
1778 getcharmod( ) Number modifiers for the last typed character | |
7 | 1779 getcmdline() String return the current command-line |
1780 getcmdpos() Number return cursor position in command-line | |
531 | 1781 getcmdtype() String return the current command-line type |
7 | 1782 getcwd() String the current working directory |
20 | 1783 getfperm( {fname}) String file permissions of file {fname} |
1784 getfsize( {fname}) Number size in bytes of file {fname} | |
37 | 1785 getfontname( [{name}]) String name of font being used |
7 | 1786 getftime( {fname}) Number last modification time of file |
20 | 1787 getftype( {fname}) String description of type of file {fname} |
161 | 1788 getline( {lnum}) String line {lnum} of current buffer |
1789 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
|
1790 getloclist( {nr}) List list of location list items |
1326 | 1791 getmatches() List list of current matches |
1548 | 1792 getpid() Number process ID of Vim |
703 | 1793 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1794 getqflist() List list of quickfix items |
282 | 1795 getreg( [{regname} [, 1]]) String contents of register |
55 | 1796 getregtype( [{regname}]) String type of register |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
1797 gettabvar( {nr}, {varname}) any variable {varname} in tab {nr} |
831 | 1798 gettabwinvar( {tabnr}, {winnr}, {name}) |
1799 any {name} in {winnr} in tab page {tabnr} | |
7 | 1800 getwinposx() Number X coord in pixels of GUI Vim window |
1801 getwinposy() Number Y coord in pixels of GUI Vim window | |
824 | 1802 getwinvar( {nr}, {varname}) any variable {varname} in window {nr} |
1754 | 1803 glob( {expr} [, {flag}]) String expand file wildcards in {expr} |
1804 globpath( {path}, {expr} [, {flag}]) | |
1805 String do glob({expr}) for all dirs in {path} | |
7 | 1806 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1807 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
1104 | 1808 haslocaldir() Number TRUE if current window executed |:lcd| |
782 | 1809 hasmapto( {what} [, {mode} [, {abbr}]]) |
1810 Number TRUE if mapping to {what} exists | |
7 | 1811 histadd( {history},{item}) String add an item to a history |
1812 histdel( {history} [, {item}]) String remove an item from a history | |
1813 histget( {history} [, {index}]) String get the item {index} from a history | |
1814 histnr( {history}) Number highest index of a history | |
1815 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1816 hlID( {name}) Number syntax ID of highlight group {name} | |
1817 hostname() String name of the machine Vim is running on | |
55 | 1818 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1819 indent( {lnum}) Number indent of line {lnum} | |
95 | 1820 index( {list}, {expr} [, {start} [, {ic}]]) |
1821 Number index in {list} where {expr} appears | |
531 | 1822 input( {prompt} [, {text} [, {completion}]]) |
1823 String get input from the user | |
7 | 1824 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1825 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1826 inputrestore() Number restore typeahead |
1827 inputsave() Number save and clear typeahead | |
7 | 1828 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1829 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
3214 | 1830 invert( {expr}) Number bitwise invert |
7 | 1831 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1832 islocked( {expr}) Number TRUE if {expr} is locked |
685 | 1833 items( {dict}) List key-value pairs in {dict} |
95 | 1834 join( {list} [, {sep}]) String join {list} items into one String |
685 | 1835 keys( {dict}) List keys in {dict} |
55 | 1836 len( {expr}) Number the length of {expr} |
1837 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1838 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1839 line( {expr}) Number line nr of cursor, last line or mark | |
1840 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1841 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1842 localtime() Number current time |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1843 log( {expr}) Float natural logarithm (base e) of {expr} |
1621 | 1844 log10( {expr}) Float logarithm of Float {expr} to base 10 |
102 | 1845 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
2610 | 1846 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 1847 String or Dict |
1848 rhs of mapping {name} in mode {mode} | |
782 | 1849 mapcheck( {name}[, {mode} [, {abbr}]]) |
1850 String check for mappings matching {name} | |
19 | 1851 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1852 Number position where {pat} matches in {expr} |
1326 | 1853 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
1854 Number highlight {pattern} with {group} | |
819 | 1855 matcharg( {nr}) List arguments of |:match| |
1326 | 1856 matchdelete( {id}) Number delete match identified by {id} |
19 | 1857 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1858 Number position where {pat} ends in {expr} |
158 | 1859 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
1860 List match and submatches of {pat} in {expr} | |
19 | 1861 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
1862 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1863 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1864 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1865 mkdir( {name} [, {path} [, {prot}]]) |
168 | 1866 Number create directory {name} |
1621 | 1867 mode( [expr]) String current editing mode |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1868 mzeval( {expr}) any evaluate |MzScheme| expression |
7 | 1869 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
1870 nr2char( {expr}) String single char with ASCII value {expr} | |
3214 | 1871 or( {expr}, {expr}) Number bitwise OR |
819 | 1872 pathshorten( {expr}) String shorten directory names in a path |
1621 | 1873 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 1874 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 1875 printf( {fmt}, {expr1}...) String format text |
1876 pumvisible() Number whether popup menu is visible | |
99 | 1877 range( {expr} [, {max} [, {stride}]]) |
1878 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1879 readfile( {fname} [, {binary} [, {max}]]) |
168 | 1880 List get list of lines from file {fname} |
794 | 1881 reltime( [{start} [, {end}]]) List get time value |
1882 reltimestr( {time}) String turn time value into a String | |
7 | 1883 remote_expr( {server}, {string} [, {idvar}]) |
1884 String send expression | |
1885 remote_foreground( {server}) Number bring Vim server to the foreground | |
1886 remote_peek( {serverid} [, {retvar}]) | |
1887 Number check for reply string | |
1888 remote_read( {serverid}) String read reply string | |
1889 remote_send( {server}, {string} [, {idvar}]) | |
1890 String send key sequence | |
79 | 1891 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 1892 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 1893 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
1894 repeat( {expr}, {count}) String repeat {expr} {count} times | |
1895 resolve( {filename}) String get filename a shortcut points to | |
82 | 1896 reverse( {list}) List reverse {list} in-place |
1621 | 1897 round( {expr}) Float round off {expr} |
1496 | 1898 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1899 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1900 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 1901 Number search for variable declaration |
1496 | 1902 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 1903 Number search for other end of start/end pair |
1496 | 1904 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 1905 List search for other end of start/end pair |
1496 | 1906 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 1907 List search for {pattern} |
7 | 1908 server2client( {clientid}, {string}) |
1909 Number send reply string | |
1910 serverlist() String get a list of available servers | |
1911 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
1912 setcmdpos( {pos}) Number set cursor position in command-line | |
1913 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
647 | 1914 setloclist( {nr}, {list}[, {action}]) |
1915 Number modify location list using {list} | |
1326 | 1916 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1917 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 1918 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 1919 setreg( {n}, {v}[, {opt}]) Number set register to value and type |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
1920 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
831 | 1921 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
1922 {winnr} in tab page {tabnr} to {val} | |
7 | 1923 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
1661 | 1924 shellescape( {string} [, {special}]) |
1925 String escape {string} for use as shell | |
985 | 1926 command argument |
55 | 1927 simplify( {filename}) String simplify filename as much as possible |
1621 | 1928 sin( {expr}) Float sine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1929 sinh( {expr}) Float hyperbolic sine of {expr} |
2902 | 1930 sort( {list} [, {func} [, {dict}]]) |
1931 List sort {list}, using {func} to compare | |
374 | 1932 soundfold( {word}) String sound-fold {word} |
344 | 1933 spellbadword() String badly spelled word at cursor |
537 | 1934 spellsuggest( {word} [, {max} [, {capital}]]) |
1935 List spelling suggestions | |
282 | 1936 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 1937 List make |List| from {pat} separated {expr} |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1938 sqrt( {expr}) Float square root of {expr} |
1621 | 1939 str2float( {expr}) Float convert String to Float |
1940 str2nr( {expr} [, {base}]) Number convert String to Number | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1941 strchars( {expr}) Number character length of the String {expr} |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
1942 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
7 | 1943 strftime( {format}[, {time}]) String time in specified format |
133 | 1944 stridx( {haystack}, {needle}[, {start}]) |
1945 Number index of {needle} in {haystack} | |
95 | 1946 string( {expr}) String String representation of {expr} value |
7 | 1947 strlen( {expr}) Number length of the String {expr} |
1948 strpart( {src}, {start}[, {len}]) | |
1949 String {len} characters of {src} at {start} | |
140 | 1950 strridx( {haystack}, {needle} [, {start}]) |
1951 Number last index of {needle} in {haystack} | |
7 | 1952 strtrans( {expr}) String translate string to make it printable |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1953 strwidth( {expr}) Number display cell length of the String {expr} |
2908 | 1954 submatch( {nr}) String specific match in ":s" or substitute() |
7 | 1955 substitute( {expr}, {pat}, {sub}, {flags}) |
1956 String all {pat} in {expr} replaced with {sub} | |
32 | 1957 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 1958 synIDattr( {synID}, {what} [, {mode}]) |
1959 String attribute {what} of syntax ID {synID} | |
1960 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
1961 synconcealed( {lnum}, {col}) List info about concealing |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1962 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 1963 system( {expr} [, {input}]) String output of shell command/filter {expr} |
677 | 1964 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
1965 tabpagenr( [{arg}]) Number number of current or last tab page | |
1966 tabpagewinnr( {tabarg}[, {arg}]) | |
1967 Number number of current window in tab page | |
1968 taglist( {expr}) List list of tags matching {expr} | |
1621 | 1969 tagfiles() List tags files used |
7 | 1970 tempname() String name for a temporary file |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1971 tan( {expr}) Float tangent of {expr} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1972 tanh( {expr}) Float hyperbolic tangent of {expr} |
7 | 1973 tolower( {expr}) String the String {expr} switched to lowercase |
1974 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 1975 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
1976 to chars in {tostr} | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1977 trunc( {expr}) Float truncate Float {expr} |
7 | 1978 type( {name}) Number type of variable {name} |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
1979 undofile( {name}) String undo file name for {name} |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
1980 undotree() List undo file tree |
685 | 1981 values( {dict}) List values in {dict} |
7 | 1982 virtcol( {expr}) Number screen column of cursor or mark |
1983 visualmode( [expr]) String last visual mode used | |
1984 winbufnr( {nr}) Number buffer number of window {nr} | |
1985 wincol() Number window column of the cursor | |
1986 winheight( {nr}) Number height of window {nr} | |
1987 winline() Number window line of the cursor | |
674 | 1988 winnr( [{expr}]) Number number of current window |
55 | 1989 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1990 winrestview( {dict}) none restore view of current window |
712 | 1991 winsaveview() Dict save view of current window |
7 | 1992 winwidth( {nr}) Number width of window {nr} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1993 writefile( {list}, {fname} [, {binary}]) |
158 | 1994 Number write list of lines to file {fname} |
3214 | 1995 xor( {expr}, {expr}) Number bitwise XOR |
7 | 1996 |
1621 | 1997 abs({expr}) *abs()* |
1998 Return the absolute value of {expr}. When {expr} evaluates to | |
1999 a |Float| abs() returns a |Float|. When {expr} can be | |
2000 converted to a |Number| abs() returns a |Number|. Otherwise | |
2001 abs() gives an error message and returns -1. | |
2002 Examples: > | |
2003 echo abs(1.456) | |
2004 < 1.456 > | |
2005 echo abs(-5.456) | |
2006 < 5.456 > | |
2007 echo abs(-4) | |
2008 < 4 | |
2009 {only available when compiled with the |+float| feature} | |
2010 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2011 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2012 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2013 Return the arc cosine of {expr} measured in radians, as a |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2014 |Float| in the range of [0, pi]. |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2015 {expr} must evaluate to a |Float| or a |Number| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2016 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2017 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2018 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2019 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2020 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2021 < 2.094395 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2022 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2023 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2024 |
82 | 2025 add({list}, {expr}) *add()* |
685 | 2026 Append the item {expr} to |List| {list}. Returns the |
2027 resulting |List|. Examples: > | |
82 | 2028 :let alist = add([1, 2, 3], item) |
2029 :call add(mylist, "woodstock") | |
685 | 2030 < Note that when {expr} is a |List| it is appended as a single |
692 | 2031 item. Use |extend()| to concatenate |Lists|. |
85 | 2032 Use |insert()| to add an item at another position. |
55 | 2033 |
82 | 2034 |
3214 | 2035 and({expr}, {expr}) *and()* |
2036 Bitwise AND on the two arguments. The arguments are converted | |
2037 to a number. A List, Dict or Float argument causes an error. | |
2038 Example: > | |
2039 :let flag = and(bits, 0x80) | |
2040 | |
2041 | |
82 | 2042 append({lnum}, {expr}) *append()* |
685 | 2043 When {expr} is a |List|: Append each item of the |List| as a |
2044 text line below line {lnum} in the current buffer. | |
153 | 2045 Otherwise append {expr} as one text line below line {lnum} in |
2046 the current buffer. | |
2047 {lnum} can be zero to insert a line before the first one. | |
82 | 2048 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2049 0 for success. Example: > |
55 | 2050 :let failed = append(line('$'), "# THE END") |
82 | 2051 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2052 < |
7 | 2053 *argc()* |
2054 argc() The result is the number of files in the argument list of the | |
2055 current window. See |arglist|. | |
2056 | |
2057 *argidx()* | |
2058 argidx() The result is the current index in the argument list. 0 is | |
2059 the first file. argc() - 1 is the last one. See |arglist|. | |
2060 | |
2061 *argv()* | |
818 | 2062 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2063 current window. See |arglist|. "argv(0)" is the first one. |
2064 Example: > | |
2065 :let i = 0 | |
2066 :while i < argc() | |
1621 | 2067 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2068 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2069 : let i = i + 1 | |
2070 :endwhile | |
818 | 2071 < Without the {nr} argument a |List| with the whole |arglist| is |
2072 returned. | |
2073 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2074 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2075 Return the arc sine of {expr} measured in radians, as a |Float| |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2076 in the range of [-pi/2, pi/2]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2077 {expr} must evaluate to a |Float| or a |Number| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2078 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2079 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2080 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2081 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2082 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2083 < -0.523599 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2084 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2085 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2086 |
1621 | 2087 atan({expr}) *atan()* |
2088 Return the principal value of the arc tangent of {expr}, in | |
2089 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2090 {expr} must evaluate to a |Float| or a |Number|. | |
2091 Examples: > | |
2092 :echo atan(100) | |
2093 < 1.560797 > | |
2094 :echo atan(-4.01) | |
2095 < -1.326405 | |
2096 {only available when compiled with the |+float| feature} | |
2097 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2098 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2099 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2100 Return the arc tangent of {expr1} / {expr2}, measured in |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2101 radians, as a |Float| in the range [-pi, pi]. |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2102 {expr1} and {expr2} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2103 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2104 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2105 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2106 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2107 < 2.356194 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2108 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2109 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2110 |
7 | 2111 *browse()* |
2112 browse({save}, {title}, {initdir}, {default}) | |
2113 Put up a file requester. This only works when "has("browse")" | |
2114 returns non-zero (only in some GUI versions). | |
2115 The input fields are: | |
2116 {save} when non-zero, select file to write | |
2117 {title} title for the requester | |
2118 {initdir} directory to start browsing in | |
2119 {default} default file name | |
2120 When the "Cancel" button is hit, something went wrong, or | |
2121 browsing is not possible, an empty string is returned. | |
2122 | |
29 | 2123 *browsedir()* |
2124 browsedir({title}, {initdir}) | |
2125 Put up a directory requester. This only works when | |
2126 "has("browse")" returns non-zero (only in some GUI versions). | |
2127 On systems where a directory browser is not supported a file | |
2128 browser is used. In that case: select a file in the directory | |
2129 to be used. | |
2130 The input fields are: | |
2131 {title} title for the requester | |
2132 {initdir} directory to start browsing in | |
2133 When the "Cancel" button is hit, something went wrong, or | |
2134 browsing is not possible, an empty string is returned. | |
2135 | |
7 | 2136 bufexists({expr}) *bufexists()* |
2137 The result is a Number, which is non-zero if a buffer called | |
2138 {expr} exists. | |
9 | 2139 If the {expr} argument is a number, buffer numbers are used. |
7 | 2140 If the {expr} argument is a string it must match a buffer name |
9 | 2141 exactly. The name can be: |
2142 - Relative to the current directory. | |
2143 - A full path. | |
1621 | 2144 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2145 - A URL name. |
7 | 2146 Unlisted buffers will be found. |
2147 Note that help files are listed by their short name in the | |
2148 output of |:buffers|, but bufexists() requires using their | |
2149 long name to be able to find them. | |
1621 | 2150 bufexists() may report a buffer exists, but to use the name |
2151 with a |:buffer| command you may need to use |expand()|. Esp | |
2152 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2153 Use "bufexists(0)" to test for the existence of an alternate |
2154 file name. | |
2155 *buffer_exists()* | |
2156 Obsolete name: buffer_exists(). | |
2157 | |
2158 buflisted({expr}) *buflisted()* | |
2159 The result is a Number, which is non-zero if a buffer called | |
2160 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2161 The {expr} argument is used like with |bufexists()|. |
7 | 2162 |
2163 bufloaded({expr}) *bufloaded()* | |
2164 The result is a Number, which is non-zero if a buffer called | |
2165 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2166 The {expr} argument is used like with |bufexists()|. |
7 | 2167 |
2168 bufname({expr}) *bufname()* | |
2169 The result is the name of a buffer, as it is displayed by the | |
2170 ":ls" command. | |
2171 If {expr} is a Number, that buffer number's name is given. | |
2172 Number zero is the alternate buffer for the current window. | |
2173 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2174 with the buffer names. This is always done like 'magic' is |
7 | 2175 set and 'cpoptions' is empty. When there is more than one |
2176 match an empty string is returned. | |
2177 "" or "%" can be used for the current buffer, "#" for the | |
2178 alternate buffer. | |
2179 A full match is preferred, otherwise a match at the start, end | |
1156 | 2180 or middle of the buffer name is accepted. If you only want a |
2181 full match then put "^" at the start and "$" at the end of the | |
2182 pattern. | |
7 | 2183 Listed buffers are found first. If there is a single match |
2184 with a listed buffer, that one is returned. Next unlisted | |
2185 buffers are searched for. | |
2186 If the {expr} is a String, but you want to use it as a buffer | |
2187 number, force it to be a Number by adding zero to it: > | |
2188 :echo bufname("3" + 0) | |
2189 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2190 string is returned. > | |
2191 bufname("#") alternate buffer name | |
2192 bufname(3) name of buffer 3 | |
2193 bufname("%") name of current buffer | |
2194 bufname("file2") name of buffer where "file2" matches. | |
2195 < *buffer_name()* | |
2196 Obsolete name: buffer_name(). | |
2197 | |
2198 *bufnr()* | |
707 | 2199 bufnr({expr} [, {create}]) |
2200 The result is the number of a buffer, as it is displayed by | |
7 | 2201 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2202 above. |
2203 If the buffer doesn't exist, -1 is returned. Or, if the | |
2204 {create} argument is present and not zero, a new, unlisted, | |
2205 buffer is created and its number is returned. | |
7 | 2206 bufnr("$") is the last buffer: > |
2207 :let last_buffer = bufnr("$") | |
2208 < The result is a Number, which is the highest buffer number | |
2209 of existing buffers. Note that not all buffers with a smaller | |
2210 number necessarily exist, because ":bwipeout" may have removed | |
2211 them. Use bufexists() to test for the existence of a buffer. | |
2212 *buffer_number()* | |
2213 Obsolete name: buffer_number(). | |
2214 *last_buffer_nr()* | |
2215 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2216 | |
2217 bufwinnr({expr}) *bufwinnr()* | |
2218 The result is a Number, which is the number of the first | |
2219 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2220 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2221 there is no such window, -1 is returned. Example: > |
2222 | |
2223 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2224 | |
2225 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2226 |:wincmd|. | |
1156 | 2227 Only deals with the current tab page. |
7 | 2228 |
2229 | |
2230 byte2line({byte}) *byte2line()* | |
2231 Return the line number that contains the character at byte | |
2232 count {byte} in the current buffer. This includes the | |
2233 end-of-line character, depending on the 'fileformat' option | |
2234 for the current buffer. The first character has byte count | |
2235 one. | |
2236 Also see |line2byte()|, |go| and |:goto|. | |
2237 {not available when compiled without the |+byte_offset| | |
2238 feature} | |
2239 | |
18 | 2240 byteidx({expr}, {nr}) *byteidx()* |
2241 Return byte index of the {nr}'th character in the string | |
2242 {expr}. Use zero for the first character, it returns zero. | |
2243 This function is only useful when there are multibyte | |
2244 characters, otherwise the returned value is equal to {nr}. | |
2245 Composing characters are counted as a separate character. | |
2246 Example : > | |
2247 echo matchstr(str, ".", byteidx(str, 3)) | |
2248 < will display the fourth character. Another way to do the | |
2249 same: > | |
2250 let s = strpart(str, byteidx(str, 3)) | |
2251 echo strpart(s, 0, byteidx(s, 1)) | |
2252 < If there are less than {nr} characters -1 is returned. | |
2253 If there are exactly {nr} characters the length of the string | |
2254 is returned. | |
2255 | |
102 | 2256 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2257 Call function {func} with the items in |List| {arglist} as |
79 | 2258 arguments. |
685 | 2259 {func} can either be a |Funcref| or the name of a function. |
79 | 2260 a:firstline and a:lastline are set to the cursor line. |
2261 Returns the return value of the called function. | |
102 | 2262 {dict} is for functions with the "dict" attribute. It will be |
2263 used to set the local variable "self". |Dictionary-function| | |
79 | 2264 |
1621 | 2265 ceil({expr}) *ceil()* |
2266 Return the smallest integral value greater than or equal to | |
2267 {expr} as a |Float| (round up). | |
2268 {expr} must evaluate to a |Float| or a |Number|. | |
2269 Examples: > | |
2270 echo ceil(1.456) | |
2271 < 2.0 > | |
2272 echo ceil(-5.456) | |
2273 < -5.0 > | |
2274 echo ceil(4.0) | |
2275 < 4.0 | |
2276 {only available when compiled with the |+float| feature} | |
2277 | |
777 | 2278 changenr() *changenr()* |
2279 Return the number of the most recent change. This is the same | |
2280 number as what is displayed with |:undolist| and can be used | |
2281 with the |:undo| command. | |
2282 When a change was made it is the number of that change. After | |
2283 redo it is the number of the redone change. After undo it is | |
2284 one less than the number of the undone change. | |
2285 | |
7 | 2286 char2nr({expr}) *char2nr()* |
2287 Return number value of the first char in {expr}. Examples: > | |
2288 char2nr(" ") returns 32 | |
2289 char2nr("ABC") returns 65 | |
2290 < The current 'encoding' is used. Example for "utf-8": > | |
1156 | 2291 char2nr("á") returns 225 |
2292 char2nr("á"[0]) returns 195 | |
2965 | 2293 < A combining character is a separate character. |
2294 |nr2char()| does the opposite. | |
7 | 2295 |
2296 cindent({lnum}) *cindent()* | |
2297 Get the amount of indent for line {lnum} according the C | |
2298 indenting rules, as with 'cindent'. | |
2299 The indent is counted in spaces, the value of 'tabstop' is | |
2300 relevant. {lnum} is used just like in |getline()|. | |
2301 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2302 feature, -1 is returned. | |
548 | 2303 See |C-indenting|. |
7 | 2304 |
1326 | 2305 clearmatches() *clearmatches()* |
2306 Clears all matches previously defined by |matchadd()| and the | |
2307 |:match| commands. | |
2308 | |
7 | 2309 *col()* |
24 | 2310 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2311 position given with {expr}. The accepted positions are: |
2312 . the cursor position | |
2313 $ the end of the cursor line (the result is the | |
2314 number of characters in the cursor line plus one) | |
2315 'x position of mark x (if the mark is not set, 0 is | |
2316 returned) | |
1317 | 2317 Additionally {expr} can be [lnum, col]: a |List| with the line |
2318 and column number. Most useful when the column is "$", to get | |
1621 | 2319 the last column of a specific line. When "lnum" or "col" is |
1317 | 2320 out of range then col() returns zero. |
1156 | 2321 To get the line number use |line()|. To get both use |
703 | 2322 |getpos()|. |
7 | 2323 For the screen column position use |virtcol()|. |
2324 Note that only marks in the current file can be used. | |
2325 Examples: > | |
2326 col(".") column of cursor | |
2327 col("$") length of cursor line plus one | |
2328 col("'t") column of mark t | |
2329 col("'" . markname) column of mark markname | |
1621 | 2330 < The first column is 1. 0 is returned for an error. |
1156 | 2331 For an uppercase mark the column may actually be in another |
2332 buffer. | |
7 | 2333 For the cursor position, when 'virtualedit' is active, the |
2334 column is one higher if the cursor is after the end of the | |
2335 line. This can be used to obtain the column in Insert mode: > | |
2336 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2337 \<C-O>:set ve=all<CR> | |
2338 \<C-O>:echo col(".") . "\n" <Bar> | |
2339 \let &ve = save_ve<CR> | |
2340 < | |
464 | 2341 |
724 | 2342 complete({startcol}, {matches}) *complete()* *E785* |
2343 Set the matches for Insert mode completion. | |
2344 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2345 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2346 with an expression mapping. | |
724 | 2347 {startcol} is the byte offset in the line where the completed |
2348 text start. The text up to the cursor is the original text | |
2349 that will be replaced by the matches. Use col('.') for an | |
2350 empty string. "col('.') - 1" will replace one character by a | |
2351 match. | |
2352 {matches} must be a |List|. Each |List| item is one match. | |
2353 See |complete-items| for the kind of items that are possible. | |
2354 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
|
2355 inserting anything that would cause completion to stop. |
724 | 2356 The match can be selected with CTRL-N and CTRL-P as usual with |
2357 Insert mode completion. The popup menu will appear if | |
2358 specified, see |ins-completion-menu|. | |
2359 Example: > | |
1156 | 2360 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2361 |
2362 func! ListMonths() | |
2363 call complete(col('.'), ['January', 'February', 'March', | |
2364 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2365 \ 'October', 'November', 'December']) | |
2366 return '' | |
2367 endfunc | |
2368 < This isn't very useful, but it shows how it works. Note that | |
2369 an empty string is returned to avoid a zero being inserted. | |
2370 | |
464 | 2371 complete_add({expr}) *complete_add()* |
2372 Add {expr} to the list of matches. Only to be used by the | |
2373 function specified with the 'completefunc' option. | |
2374 Returns 0 for failure (empty string or out of memory), | |
2375 1 when the match was added, 2 when the match was already in | |
2376 the list. | |
1621 | 2377 See |complete-functions| for an explanation of {expr}. It is |
786 | 2378 the same as one item in the list that 'omnifunc' would return. |
464 | 2379 |
2380 complete_check() *complete_check()* | |
2381 Check for a key typed while looking for completion matches. | |
2382 This is to be used when looking for matches takes some time. | |
2383 Returns non-zero when searching for matches is to be aborted, | |
2384 zero otherwise. | |
2385 Only to be used by the function specified with the | |
2386 'completefunc' option. | |
2387 | |
7 | 2388 *confirm()* |
2389 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2390 Confirm() offers the user a dialog, from which a choice can be | |
2391 made. It returns the number of the choice. For the first | |
2392 choice this is 1. | |
2393 Note: confirm() is only supported when compiled with dialog | |
2394 support, see |+dialog_con| and |+dialog_gui|. | |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2395 |
7 | 2396 {msg} is displayed in a |dialog| with {choices} as the |
2397 alternatives. When {choices} is missing or empty, "&OK" is | |
2398 used (and translated). | |
2399 {msg} is a String, use '\n' to include a newline. Only on | |
2400 some systems the string is wrapped when it doesn't fit. | |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2401 |
7 | 2402 {choices} is a String, with the individual choices separated |
2403 by '\n', e.g. > | |
2404 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2405 < The letter after the '&' is the shortcut key for that choice. | |
2406 Thus you can type 'c' to select "Cancel". The shortcut does | |
2407 not need to be the first letter: > | |
2408 confirm("file has been modified", "&Save\nSave &All") | |
2409 < For the console, the first letter of each choice is used as | |
2410 the default shortcut key. | |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2411 |
7 | 2412 The optional {default} argument is the number of the choice |
2413 that is made if the user hits <CR>. Use 1 to make the first | |
2414 choice the default one. Use 0 to not set a default. If | |
2415 {default} is omitted, 1 is used. | |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2416 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2417 The optional {type} argument gives the type of dialog. This |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2418 is only used for the icon of the GTK, Mac, Motif and Win32 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2419 GUI. It can be one of these values: "Error", "Question", |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2420 "Info", "Warning" or "Generic". Only the first character is |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2421 relevant. When {type} is omitted, "Generic" is used. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2422 |
7 | 2423 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2424 or another valid interrupt key, confirm() returns 0. | |
2425 | |
2426 An example: > | |
2427 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2428 :if choice == 0 | |
2429 : echo "make up your mind!" | |
2430 :elseif choice == 3 | |
2431 : echo "tasteful" | |
2432 :else | |
2433 : echo "I prefer bananas myself." | |
2434 :endif | |
2435 < In a GUI dialog, buttons are used. The layout of the buttons | |
2436 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2437 the buttons are always put vertically. Otherwise, confirm() |
7 | 2438 tries to put the buttons in one horizontal line. If they |
2439 don't fit, a vertical layout is used anyway. For some systems | |
2440 the horizontal layout is always used. | |
2441 | |
55 | 2442 *copy()* |
1621 | 2443 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2444 different from using {expr} directly. |
685 | 2445 When {expr} is a |List| a shallow copy is created. This means |
2446 that the original |List| can be changed without changing the | |
1621 | 2447 copy, and vice versa. But the items are identical, thus |
2448 changing an item changes the contents of both |Lists|. Also | |
685 | 2449 see |deepcopy()|. |
55 | 2450 |
1621 | 2451 cos({expr}) *cos()* |
2452 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2453 {expr} must evaluate to a |Float| or a |Number|. | |
2454 Examples: > | |
2455 :echo cos(100) | |
2456 < 0.862319 > | |
2457 :echo cos(-4.01) | |
2458 < -0.646043 | |
2459 {only available when compiled with the |+float| feature} | |
2460 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2461 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2462 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2463 Return the hyperbolic cosine of {expr} as a |Float| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2464 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2465 {expr} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2466 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2467 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2468 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2469 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2470 < -1.127626 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2471 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2472 |
1621 | 2473 |
102 | 2474 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2475 Return the number of times an item with value {expr} appears |
685 | 2476 in |List| or |Dictionary| {comp}. |
102 | 2477 If {start} is given then start with the item with this index. |
685 | 2478 {start} can only be used with a |List|. |
79 | 2479 When {ic} is given and it's non-zero then case is ignored. |
2480 | |
2481 | |
7 | 2482 *cscope_connection()* |
2483 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2484 Checks for the existence of a |cscope| connection. If no | |
2485 parameters are specified, then the function returns: | |
2486 0, if cscope was not available (not compiled in), or | |
2487 if there are no cscope connections; | |
2488 1, if there is at least one cscope connection. | |
2489 | |
2490 If parameters are specified, then the value of {num} | |
2491 determines how existence of a cscope connection is checked: | |
2492 | |
2493 {num} Description of existence check | |
2494 ----- ------------------------------ | |
2495 0 Same as no parameters (e.g., "cscope_connection()"). | |
2496 1 Ignore {prepend}, and use partial string matches for | |
2497 {dbpath}. | |
2498 2 Ignore {prepend}, and use exact string matches for | |
2499 {dbpath}. | |
2500 3 Use {prepend}, use partial string matches for both | |
2501 {dbpath} and {prepend}. | |
2502 4 Use {prepend}, use exact string matches for both | |
2503 {dbpath} and {prepend}. | |
2504 | |
2505 Note: All string comparisons are case sensitive! | |
2506 | |
2507 Examples. Suppose we had the following (from ":cs show"): > | |
2508 | |
2509 # pid database name prepend path | |
2510 0 27664 cscope.out /usr/local | |
2511 < | |
2512 Invocation Return Val ~ | |
2513 ---------- ---------- > | |
2514 cscope_connection() 1 | |
2515 cscope_connection(1, "out") 1 | |
2516 cscope_connection(2, "out") 0 | |
2517 cscope_connection(3, "out") 0 | |
2518 cscope_connection(3, "out", "local") 1 | |
2519 cscope_connection(4, "out") 0 | |
2520 cscope_connection(4, "out", "local") 0 | |
2521 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2522 < | |
703 | 2523 cursor({lnum}, {col} [, {off}]) *cursor()* |
2524 cursor({list}) | |
1156 | 2525 Positions the cursor at the column (byte count) {col} in the |
2526 line {lnum}. The first column is one. | |
703 | 2527 When there is one argument {list} this is used as a |List| |
707 | 2528 with two or three items {lnum}, {col} and {off}. This is like |
2529 the return value of |getpos()|, but without the first item. | |
7 | 2530 Does not change the jumplist. |
2531 If {lnum} is greater than the number of lines in the buffer, | |
2532 the cursor will be positioned at the last line in the buffer. | |
2533 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 2534 If {col} is greater than the number of bytes in the line, |
7 | 2535 the cursor will be positioned at the last character in the |
2536 line. | |
2537 If {col} is zero, the cursor will stay in the current column. | |
703 | 2538 When 'virtualedit' is used {off} specifies the offset in |
2539 screen columns from the start of the character. E.g., a | |
1266 | 2540 position within a <Tab> or after the last character. |
1851 | 2541 Returns 0 when the position could be set, -1 otherwise. |
7 | 2542 |
55 | 2543 |
164 | 2544 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 2545 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2546 different from using {expr} directly. |
685 | 2547 When {expr} is a |List| a full copy is created. This means |
2548 that the original |List| can be changed without changing the | |
1621 | 2549 copy, and vice versa. When an item is a |List|, a copy for it |
55 | 2550 is made, recursively. Thus changing an item in the copy does |
685 | 2551 not change the contents of the original |List|. |
2552 When {noref} is omitted or zero a contained |List| or | |
2553 |Dictionary| is only copied once. All references point to | |
2554 this single copy. With {noref} set to 1 every occurrence of a | |
2555 |List| or |Dictionary| results in a new copy. This also means | |
2556 that a cyclic reference causes deepcopy() to fail. | |
114 | 2557 *E724* |
2558 Nesting is possible up to 100 levels. When there is an item | |
164 | 2559 that refers back to a higher level making a deep copy with |
2560 {noref} set to 1 will fail. | |
55 | 2561 Also see |copy()|. |
2562 | |
2563 delete({fname}) *delete()* | |
2564 Deletes the file by the name {fname}. The result is a Number, | |
7 | 2565 which is 0 if the file was deleted successfully, and non-zero |
2566 when the deletion failed. | |
685 | 2567 Use |remove()| to delete an item from a |List|. |
7 | 2568 |
2569 *did_filetype()* | |
2570 did_filetype() Returns non-zero when autocommands are being executed and the | |
2571 FileType event has been triggered at least once. Can be used | |
2572 to avoid triggering the FileType event again in the scripts | |
2573 that detect the file type. |FileType| | |
2574 When editing another file, the counter is reset, thus this | |
2575 really checks if the FileType event has been triggered for the | |
2576 current buffer. This allows an autocommand that starts | |
2577 editing another buffer to set 'filetype' and load a syntax | |
2578 file. | |
2579 | |
32 | 2580 diff_filler({lnum}) *diff_filler()* |
2581 Returns the number of filler lines above line {lnum}. | |
2582 These are the lines that were inserted at this point in | |
2583 another diff'ed window. These filler lines are shown in the | |
2584 display but don't exist in the buffer. | |
2585 {lnum} is used like with |getline()|. Thus "." is the current | |
2586 line, "'m" mark m, etc. | |
2587 Returns 0 if the current window is not in diff mode. | |
2588 | |
2589 diff_hlID({lnum}, {col}) *diff_hlID()* | |
2590 Returns the highlight ID for diff mode at line {lnum} column | |
2591 {col} (byte index). When the current line does not have a | |
2592 diff change zero is returned. | |
2593 {lnum} is used like with |getline()|. Thus "." is the current | |
2594 line, "'m" mark m, etc. | |
2595 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
2596 line. | |
2597 The highlight ID can be used with |synIDattr()| to obtain | |
2598 syntax information about the highlighting. | |
2599 | |
85 | 2600 empty({expr}) *empty()* |
2601 Return the Number 1 if {expr} is empty, zero otherwise. | |
685 | 2602 A |List| or |Dictionary| is empty when it does not have any |
1621 | 2603 items. A Number is empty when its value is zero. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2604 For a long |List| this is much faster than comparing the |
685 | 2605 length with zero. |
85 | 2606 |
7 | 2607 escape({string}, {chars}) *escape()* |
2608 Escape the characters in {chars} that occur in {string} with a | |
2609 backslash. Example: > | |
2610 :echo escape('c:\program files\vim', ' \') | |
2611 < results in: > | |
2612 c:\\program\ files\\vim | |
1621 | 2613 < Also see |shellescape()|. |
2614 | |
2615 *eval()* | |
95 | 2616 eval({string}) Evaluate {string} and return the result. Especially useful to |
2617 turn the result of |string()| back into the original value. | |
1621 | 2618 This works for Numbers, Floats, Strings and composites of |
2619 them. Also works for |Funcref|s that refer to existing | |
2620 functions. | |
95 | 2621 |
7 | 2622 eventhandler() *eventhandler()* |
2623 Returns 1 when inside an event handler. That is that Vim got | |
2624 interrupted while waiting for the user to type a character, | |
2625 e.g., when dropping a file on Vim. This means interactive | |
2626 commands cannot be used. Otherwise zero is returned. | |
2627 | |
2628 executable({expr}) *executable()* | |
2629 This function checks if an executable with the name {expr} | |
2630 exists. {expr} must be the name of the program without any | |
10 | 2631 arguments. |
2632 executable() uses the value of $PATH and/or the normal | |
2633 searchpath for programs. *PATHEXT* | |
2634 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
2635 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 2636 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
2637 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 2638 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 2639 the name without an extension. When 'shell' looks like a |
10 | 2640 Unix shell, then the name is also tried without adding an |
2641 extension. | |
2642 On MS-DOS and MS-Windows it only checks if the file exists and | |
2643 is not a directory, not if it's really executable. | |
819 | 2644 On MS-Windows an executable in the same directory as Vim is |
2645 always found. Since this directory is added to $PATH it | |
2646 should also work to execute it |win32-PATH|. | |
7 | 2647 The result is a Number: |
2648 1 exists | |
2649 0 does not exist | |
2650 -1 not implemented on this system | |
2651 | |
2652 *exists()* | |
2653 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
2654 defined, zero otherwise. The {expr} argument is a string, | |
2655 which contains one of these: | |
2656 &option-name Vim option (only checks if it exists, | |
2657 not if it really works) | |
2658 +option-name Vim option that works. | |
2659 $ENVNAME environment variable (could also be | |
2660 done by comparing with an empty | |
2661 string) | |
2662 *funcname built-in function (see |functions|) | |
2663 or user defined function (see | |
2664 |user-functions|). | |
2665 varname internal variable (see | |
1621 | 2666 |internal-variables|). Also works |
685 | 2667 for |curly-braces-names|, |Dictionary| |
2668 entries, |List| items, etc. Beware | |
1668 | 2669 that evaluating an index may cause an |
2670 error message for an invalid | |
2671 expression. E.g.: > | |
2672 :let l = [1, 2, 3] | |
2673 :echo exists("l[5]") | |
2674 < 0 > | |
2675 :echo exists("l[xx]") | |
2676 < E121: Undefined variable: xx | |
2677 0 | |
7 | 2678 :cmdname Ex command: built-in command, user |
2679 command or command modifier |:command|. | |
2680 Returns: | |
2681 1 for match with start of a command | |
2682 2 full match with a command | |
2683 3 matches several user commands | |
2684 To check for a supported command | |
2685 always check the return value to be 2. | |
864 | 2686 :2match The |:2match| command. |
2687 :3match The |:3match| command. | |
7 | 2688 #event autocommand defined for this event |
2689 #event#pattern autocommand defined for this event and | |
2690 pattern (the pattern is taken | |
2691 literally and compared to the | |
2692 autocommand patterns character by | |
2693 character) | |
613 | 2694 #group autocommand group exists |
2695 #group#event autocommand defined for this group and | |
2696 event. | |
2697 #group#event#pattern | |
856 | 2698 autocommand defined for this group, |
613 | 2699 event and pattern. |
615 | 2700 ##event autocommand for this event is |
2701 supported. | |
7 | 2702 For checking for a supported feature use |has()|. |
2703 | |
2704 Examples: > | |
2705 exists("&shortname") | |
2706 exists("$HOSTNAME") | |
2707 exists("*strftime") | |
2708 exists("*s:MyFunc") | |
2709 exists("bufcount") | |
2710 exists(":Make") | |
613 | 2711 exists("#CursorHold") |
7 | 2712 exists("#BufReadPre#*.gz") |
613 | 2713 exists("#filetypeindent") |
2714 exists("#filetypeindent#FileType") | |
2715 exists("#filetypeindent#FileType#*") | |
615 | 2716 exists("##ColorScheme") |
7 | 2717 < There must be no space between the symbol (&/$/*/#) and the |
2718 name. | |
867 | 2719 There must be no extra characters after the name, although in |
2720 a few cases this is ignored. That may become more strict in | |
2721 the future, thus don't count on it! | |
2722 Working example: > | |
2723 exists(":make") | |
2724 < NOT working example: > | |
2725 exists(":make install") | |
859 | 2726 |
2727 < Note that the argument must be a string, not the name of the | |
2728 variable itself. For example: > | |
7 | 2729 exists(bufcount) |
2730 < This doesn't check for existence of the "bufcount" variable, | |
853 | 2731 but gets the value of "bufcount", and checks if that exists. |
7 | 2732 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2733 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2734 Return the exponential of {expr} as a |Float| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2735 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2736 {expr} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2737 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2738 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2739 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2740 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2741 < 0.367879 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2742 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2743 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2744 |
7 | 2745 expand({expr} [, {flag}]) *expand()* |
2746 Expand wildcards and the following special keywords in {expr}. | |
2662 | 2747 The result is a String. 'wildignorecase' applies. |
7 | 2748 |
2749 When there are several matches, they are separated by <NL> | |
2750 characters. [Note: in version 5.0 a space was used, which | |
2751 caused problems when a file name contains a space] | |
2752 | |
1621 | 2753 If the expansion fails, the result is an empty string. A name |
7 | 2754 for a non-existing file is not included. |
2755 | |
2756 When {expr} starts with '%', '#' or '<', the expansion is done | |
2757 like for the |cmdline-special| variables with their associated | |
2758 modifiers. Here is a short overview: | |
2759 | |
2760 % current file name | |
2761 # alternate file name | |
2762 #n alternate file name n | |
2763 <cfile> file name under the cursor | |
2764 <afile> autocmd file name | |
2765 <abuf> autocmd buffer number (as a String!) | |
2766 <amatch> autocmd matched name | |
2767 <sfile> sourced script file name | |
2662 | 2768 <slnum> sourced script file line number |
7 | 2769 <cword> word under the cursor |
2770 <cWORD> WORD under the cursor | |
2771 <client> the {clientid} of the last received | |
2772 message |server2client()| | |
2773 Modifiers: | |
2774 :p expand to full path | |
2775 :h head (last path component removed) | |
2776 :t tail (last path component only) | |
2777 :r root (one extension removed) | |
2778 :e extension only | |
2779 | |
2780 Example: > | |
2781 :let &tags = expand("%:p:h") . "/tags" | |
2782 < Note that when expanding a string that starts with '%', '#' or | |
2783 '<', any following text is ignored. This does NOT work: > | |
2784 :let doesntwork = expand("%:h.bak") | |
2785 < Use this: > | |
2786 :let doeswork = expand("%:h") . ".bak" | |
2787 < Also note that expanding "<cfile>" and others only returns the | |
2788 referenced file name without further expansion. If "<cfile>" | |
2789 is "~/.cshrc", you need to do another expand() to have the | |
2790 "~/" expanded into the path of the home directory: > | |
2791 :echo expand(expand("<cfile>")) | |
2792 < | |
2793 There cannot be white space between the variables and the | |
2794 following modifier. The |fnamemodify()| function can be used | |
2795 to modify normal file names. | |
2796 | |
2797 When using '%' or '#', and the current or alternate file name | |
2798 is not defined, an empty string is used. Using "%:p" in a | |
2799 buffer with no name, results in the current directory, with a | |
2800 '/' added. | |
2801 | |
2802 When {expr} does not start with '%', '#' or '<', it is | |
2803 expanded like a file name is expanded on the command line. | |
2804 'suffixes' and 'wildignore' are used, unless the optional | |
2805 {flag} argument is given and it is non-zero. Names for | |
444 | 2806 non-existing files are included. The "**" item can be used to |
2807 search in a directory tree. For example, to find all "README" | |
2808 files in the current directory and below: > | |
2809 :echo expand("**/README") | |
2810 < | |
7 | 2811 Expand() can also be used to expand variables and environment |
2812 variables that are only known in a shell. But this can be | |
1621 | 2813 slow, because a shell must be started. See |expr-env-expand|. |
7 | 2814 The expanded variable is still handled like a list of file |
1621 | 2815 names. When an environment variable cannot be expanded, it is |
7 | 2816 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
2817 "$FOOBAR". | |
2818 | |
2819 See |glob()| for finding existing files. See |system()| for | |
2820 getting the raw output of an external command. | |
2821 | |
102 | 2822 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 2823 {expr1} and {expr2} must be both |Lists| or both |
2824 |Dictionaries|. | |
2825 | |
2826 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 2827 If {expr3} is given insert the items of {expr2} before item |
2828 {expr3} in {expr1}. When {expr3} is zero insert before the | |
2829 first item. When {expr3} is equal to len({expr1}) then | |
2830 {expr2} is appended. | |
79 | 2831 Examples: > |
2832 :echo sort(extend(mylist, [7, 5])) | |
2833 :call extend(mylist, [2, 3], 1) | |
1699 | 2834 < When {expr1} is the same List as {expr2} then the number of |
2835 items copied is equal to the original length of the List. | |
2836 E.g., when {expr3} is 1 you get N new copies of the first item | |
2837 (where N is the original length of the List). | |
2838 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 2839 two lists into a new list use the + operator: > |
79 | 2840 :let newlist = [1, 2, 3] + [4, 5] |
102 | 2841 < |
692 | 2842 If they are |Dictionaries|: |
102 | 2843 Add all entries from {expr2} to {expr1}. |
2844 If a key exists in both {expr1} and {expr2} then {expr3} is | |
2845 used to decide what to do: | |
2846 {expr3} = "keep": keep the value of {expr1} | |
2847 {expr3} = "force": use the value of {expr2} | |
856 | 2848 {expr3} = "error": give an error message *E737* |
102 | 2849 When {expr3} is omitted then "force" is assumed. |
2850 | |
2851 {expr1} is changed when {expr2} is not empty. If necessary | |
2852 make a copy of {expr1} first. | |
2853 {expr2} remains unchanged. | |
2854 Returns {expr1}. | |
2855 | |
79 | 2856 |
842 | 2857 feedkeys({string} [, {mode}]) *feedkeys()* |
2858 Characters in {string} are queued for processing as if they | |
1621 | 2859 come from a mapping or were typed by the user. They are added |
1156 | 2860 to the end of the typeahead buffer, thus if a mapping is still |
842 | 2861 being executed these characters come after them. |
2862 The function does not wait for processing of keys contained in | |
2863 {string}. | |
2864 To include special keys into {string}, use double-quotes | |
2865 and "\..." notation |expr-quote|. For example, | |
1215 | 2866 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 2867 feedkeys('\<CR>') pushes 5 characters. |
2868 If {mode} is absent, keys are remapped. | |
2869 {mode} is a String, which can contain these character flags: | |
843 | 2870 'm' Remap keys. This is default. |
2871 'n' Do not remap keys. | |
2872 't' Handle keys as if typed; otherwise they are handled as | |
2873 if coming from a mapping. This matters for undo, | |
2874 opening folds, etc. | |
842 | 2875 Return value is always 0. |
2876 | |
7 | 2877 filereadable({file}) *filereadable()* |
2878 The result is a Number, which is TRUE when a file with the | |
2879 name {file} exists, and can be read. If {file} doesn't exist, | |
2880 or is a directory, the result is FALSE. {file} is any | |
2881 expression, which is used as a String. | |
1156 | 2882 If you don't care about the file being readable you can use |
2883 |glob()|. | |
7 | 2884 *file_readable()* |
2885 Obsolete name: file_readable(). | |
2886 | |
95 | 2887 |
1156 | 2888 filewritable({file}) *filewritable()* |
2889 The result is a Number, which is 1 when a file with the | |
2890 name {file} exists, and can be written. If {file} doesn't | |
1621 | 2891 exist, or is not writable, the result is 0. If {file} is a |
1156 | 2892 directory, and we can write to it, the result is 2. |
2893 | |
2894 | |
102 | 2895 filter({expr}, {string}) *filter()* |
685 | 2896 {expr} must be a |List| or a |Dictionary|. |
102 | 2897 For each item in {expr} evaluate {string} and when the result |
685 | 2898 is zero remove the item from the |List| or |Dictionary|. |
102 | 2899 Inside {string} |v:val| has the value of the current item. |
685 | 2900 For a |Dictionary| |v:key| has the key of the current item. |
102 | 2901 Examples: > |
2902 :call filter(mylist, 'v:val !~ "OLD"') | |
2903 < Removes the items where "OLD" appears. > | |
2904 :call filter(mydict, 'v:key >= 8') | |
2905 < Removes the items with a key below 8. > | |
2906 :call filter(var, 0) | |
685 | 2907 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 2908 |
102 | 2909 Note that {string} is the result of expression and is then |
2910 used as an expression again. Often it is good to use a | |
2911 |literal-string| to avoid having to double backslashes. | |
2912 | |
685 | 2913 The operation is done in-place. If you want a |List| or |
2914 |Dictionary| to remain unmodified make a copy first: > | |
650 | 2915 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 2916 |
685 | 2917 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 2918 When an error is encountered while evaluating {string} no |
2919 further items in {expr} are processed. | |
95 | 2920 |
2921 | |
19 | 2922 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 2923 Find directory {name} in {path}. Supports both downwards and |
2924 upwards recursive directory searches. See |file-searching| | |
2925 for the syntax of {path}. | |
2926 Returns the path of the first found match. When the found | |
2927 directory is below the current directory a relative path is | |
2928 returned. Otherwise a full path is returned. | |
19 | 2929 If {path} is omitted or empty then 'path' is used. |
2930 If the optional {count} is given, find {count}'s occurrence of | |
794 | 2931 {name} in {path} instead of the first one. |
809 | 2932 When {count} is negative return all the matches in a |List|. |
19 | 2933 This is quite similar to the ex-command |:find|. |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2934 {only available when compiled with the |+file_in_path| |
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2935 feature} |
794 | 2936 |
2937 findfile({name}[, {path}[, {count}]]) *findfile()* | |
2938 Just like |finddir()|, but find a file instead of a directory. | |
2939 Uses 'suffixesadd'. | |
19 | 2940 Example: > |
2941 :echo findfile("tags.vim", ".;") | |
1156 | 2942 < Searches from the directory of the current file upwards until |
2943 it finds the file "tags.vim". | |
7 | 2944 |
1621 | 2945 float2nr({expr}) *float2nr()* |
2946 Convert {expr} to a Number by omitting the part after the | |
2947 decimal point. | |
2948 {expr} must evaluate to a |Float| or a Number. | |
2949 When the value of {expr} is out of range for a |Number| the | |
2950 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
2951 in -0x80000000. | |
2952 Examples: > | |
2953 echo float2nr(3.95) | |
2954 < 3 > | |
2955 echo float2nr(-23.45) | |
2956 < -23 > | |
2957 echo float2nr(1.0e100) | |
2958 < 2147483647 > | |
2959 echo float2nr(-1.0e150) | |
2960 < -2147483647 > | |
2961 echo float2nr(1.0e-100) | |
2962 < 0 | |
2963 {only available when compiled with the |+float| feature} | |
2964 | |
2965 | |
2966 floor({expr}) *floor()* | |
2967 Return the largest integral value less than or equal to | |
2968 {expr} as a |Float| (round down). | |
2969 {expr} must evaluate to a |Float| or a |Number|. | |
2970 Examples: > | |
2971 echo floor(1.856) | |
2972 < 1.0 > | |
2973 echo floor(-5.456) | |
2974 < -6.0 > | |
2975 echo floor(4.0) | |
2976 < 4.0 | |
2977 {only available when compiled with the |+float| feature} | |
2978 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2979 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2980 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2981 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2982 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2983 for some integer i such that if {expr2} is non-zero, the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2984 result has the same sign as {expr1} and magnitude less than |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2985 the magnitude of {expr2}. If {expr2} is zero, the value |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2986 returned is zero. The value returned is a |Float|. |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2987 {expr1} and {expr2} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2988 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2989 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2990 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2991 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2992 < -0.13 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2993 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2994 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2995 |
1586 | 2996 fnameescape({string}) *fnameescape()* |
1621 | 2997 Escape {string} for use as file name command argument. All |
1586 | 2998 characters that have a special meaning, such as '%' and '|' |
2999 are escaped with a backslash. | |
1621 | 3000 For most systems the characters escaped are |
3001 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3002 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3003 A leading '+' and '>' is also escaped (special after |:edit| |
3004 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3005 Example: > |
1700 | 3006 :let fname = '+some str%nge|name' |
1586 | 3007 :exe "edit " . fnameescape(fname) |
3008 < results in executing: > | |
1700 | 3009 edit \+some\ str\%nge\|name |
1586 | 3010 |
7 | 3011 fnamemodify({fname}, {mods}) *fnamemodify()* |
3012 Modify file name {fname} according to {mods}. {mods} is a | |
3013 string of characters like it is used for file names on the | |
3014 command line. See |filename-modifiers|. | |
3015 Example: > | |
3016 :echo fnamemodify("main.c", ":p:h") | |
3017 < results in: > | |
3018 /home/mool/vim/vim/src | |
1621 | 3019 < Note: Environment variables don't work in {fname}, use |
7 | 3020 |expand()| first then. |
3021 | |
3022 foldclosed({lnum}) *foldclosed()* | |
3023 The result is a Number. If the line {lnum} is in a closed | |
3024 fold, the result is the number of the first line in that fold. | |
3025 If the line {lnum} is not in a closed fold, -1 is returned. | |
3026 | |
3027 foldclosedend({lnum}) *foldclosedend()* | |
3028 The result is a Number. If the line {lnum} is in a closed | |
3029 fold, the result is the number of the last line in that fold. | |
3030 If the line {lnum} is not in a closed fold, -1 is returned. | |
3031 | |
3032 foldlevel({lnum}) *foldlevel()* | |
3033 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3034 in the current buffer. For nested folds the deepest level is |
7 | 3035 returned. If there is no fold at line {lnum}, zero is |
3036 returned. It doesn't matter if the folds are open or closed. | |
3037 When used while updating folds (from 'foldexpr') -1 is | |
3038 returned for lines where folds are still to be updated and the | |
3039 foldlevel is unknown. As a special case the level of the | |
3040 previous line is usually available. | |
3041 | |
3042 *foldtext()* | |
3043 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3044 the default function used for the 'foldtext' option and should | |
3045 only be called from evaluating 'foldtext'. It uses the | |
3046 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3047 The returned string looks like this: > | |
3048 +-- 45 lines: abcdef | |
1621 | 3049 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3050 the number of lines in the fold. "abcdef" is the text in the |
3051 first non-blank line of the fold. Leading white space, "//" | |
3052 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3053 options is removed. | |
3054 {not available when compiled without the |+folding| feature} | |
3055 | |
29 | 3056 foldtextresult({lnum}) *foldtextresult()* |
3057 Returns the text that is displayed for the closed fold at line | |
3058 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3059 When there is no closed fold at {lnum} an empty string is | |
3060 returned. | |
3061 {lnum} is used like with |getline()|. Thus "." is the current | |
3062 line, "'m" mark m, etc. | |
3063 Useful when exporting folded text, e.g., to HTML. | |
3064 {not available when compiled without the |+folding| feature} | |
3065 | |
7 | 3066 *foreground()* |
1621 | 3067 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3068 a client to a Vim server. |remote_send()| |
3069 On Win32 systems this might not work, the OS does not always | |
3070 allow a window to bring itself to the foreground. Use | |
3071 |remote_foreground()| instead. | |
3072 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3073 Win32 console version} | |
3074 | |
82 | 3075 |
85 | 3076 function({name}) *function()* *E700* |
685 | 3077 Return a |Funcref| variable that refers to function {name}. |
55 | 3078 {name} can be a user defined function or an internal function. |
3079 | |
82 | 3080 |
3224 | 3081 garbagecollect([{atexit}]) *garbagecollect()* |
692 | 3082 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 3083 references. There is hardly ever a need to invoke this |
3084 function, as it is automatically done when Vim runs out of | |
3085 memory or is waiting for the user to press a key after | |
3086 'updatetime'. Items without circular references are always | |
3087 freed when they become unused. | |
685 | 3088 This is useful if you have deleted a very big |List| and/or |
3089 |Dictionary| with circular references in a script that runs | |
3090 for a long time. | |
3224 | 3091 When the optional {atexit} argument is one, garbage |
1405 | 3092 collection will also be done when exiting Vim, if it wasn't |
3093 done before. This is useful when checking for memory leaks. | |
370 | 3094 |
140 | 3095 get({list}, {idx} [, {default}]) *get()* |
685 | 3096 Get item {idx} from |List| {list}. When this item is not |
82 | 3097 available return {default}. Return zero when {default} is |
3098 omitted. | |
102 | 3099 get({dict}, {key} [, {default}]) |
685 | 3100 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3101 item is not available return {default}. Return zero when |
3102 {default} is omitted. | |
3103 | |
435 | 3104 *getbufline()* |
3105 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3106 Return a |List| with the lines starting from {lnum} to {end} |
3107 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3108 |List| with only the line {lnum} is returned. | |
435 | 3109 |
3110 For the use of {expr}, see |bufname()| above. | |
3111 | |
448 | 3112 For {lnum} and {end} "$" can be used for the last line of the |
3113 buffer. Otherwise a number must be used. | |
435 | 3114 |
3115 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3116 lines in the buffer, an empty |List| is returned. |
435 | 3117 |
3118 When {end} is greater than the number of lines in the buffer, | |
3119 it is treated as {end} is set to the number of lines in the | |
685 | 3120 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3121 returned. |
3122 | |
448 | 3123 This function works only for loaded buffers. For unloaded and |
685 | 3124 non-existing buffers, an empty |List| is returned. |
435 | 3125 |
3126 Example: > | |
3127 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3128 |
3129 getbufvar({expr}, {varname}) *getbufvar()* | |
3130 The result is the value of option or local buffer variable | |
3131 {varname} in buffer {expr}. Note that the name without "b:" | |
3132 must be used. | |
1668 | 3133 When {varname} is empty returns a dictionary with all the |
3134 buffer-local variables. | |
216 | 3135 This also works for a global or buffer-local option, but it |
3136 doesn't work for a global variable, window-local variable or | |
3137 window-local option. | |
82 | 3138 For the use of {expr}, see |bufname()| above. |
3139 When the buffer or variable doesn't exist an empty string is | |
3140 returned, there is no error message. | |
3141 Examples: > | |
3142 :let bufmodified = getbufvar(1, "&mod") | |
3143 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3144 < | |
7 | 3145 getchar([expr]) *getchar()* |
867 | 3146 Get a single character from the user or input stream. |
7 | 3147 If [expr] is omitted, wait until a character is available. |
3148 If [expr] is 0, only get a character when one is available. | |
867 | 3149 Return zero otherwise. |
7 | 3150 If [expr] is 1, only check if a character is available, it is |
867 | 3151 not consumed. Return zero if no character available. |
3152 | |
3153 Without {expr} and when {expr} is 0 a whole character or | |
3154 special key is returned. If it is an 8-bit character, the | |
3155 result is a number. Use nr2char() to convert it to a String. | |
3156 Otherwise a String is returned with the encoded character. | |
3157 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3158 (decimal: 128). This is the same value as the string |
3159 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3160 String when a modifier (shift, control, alt) was used that is | |
3161 not included in the character. | |
867 | 3162 |
3163 When {expr} is 1 only the first byte is returned. For a | |
872 | 3164 one-byte character it is the character itself as a number. |
3165 Use nr2char() to convert it to a String. | |
867 | 3166 |
3224 | 3167 Use getcharmod() to obtain any additional modifiers. |
3168 | |
1029 | 3169 When the user clicks a mouse button, the mouse event will be |
3170 returned. The position can then be found in |v:mouse_col|, | |
3171 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3172 mouse as it would normally happen: > | |
3173 let c = getchar() | |
1621 | 3174 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3175 exe v:mouse_win . "wincmd w" |
3176 exe v:mouse_lnum | |
3177 exe "normal " . v:mouse_col . "|" | |
3178 endif | |
3179 < | |
7 | 3180 There is no prompt, you will somehow have to make clear to the |
3181 user that a character has to be typed. | |
3182 There is no mapping for the character. | |
3183 Key codes are replaced, thus when the user presses the <Del> | |
3184 key you get the code for the <Del> key, not the raw character | |
3185 sequence. Examples: > | |
3186 getchar() == "\<Del>" | |
3187 getchar() == "\<S-Left>" | |
3188 < This example redefines "f" to ignore case: > | |
3189 :nmap f :call FindChar()<CR> | |
3190 :function FindChar() | |
3191 : let c = nr2char(getchar()) | |
3192 : while col('.') < col('$') - 1 | |
3193 : normal l | |
3194 : if getline('.')[col('.') - 1] ==? c | |
3195 : break | |
3196 : endif | |
3197 : endwhile | |
3198 :endfunction | |
3199 | |
3200 getcharmod() *getcharmod()* | |
3201 The result is a Number which is the state of the modifiers for | |
3202 the last obtained character with getchar() or in another way. | |
3203 These values are added together: | |
3204 2 shift | |
3205 4 control | |
3206 8 alt (meta) | |
3224 | 3207 16 meta (when it's different from ALT) |
3208 32 mouse double click | |
3209 64 mouse triple click | |
3210 96 mouse quadruple click (== 32 + 64) | |
3211 128 command (Macintosh only) | |
7 | 3212 Only the modifiers that have not been included in the |
1621 | 3213 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3214 without a modifier. |
7 | 3215 |
3216 getcmdline() *getcmdline()* | |
3217 Return the current command-line. Only works when the command | |
3218 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3219 |c_CTRL-R_=|. | |
3220 Example: > | |
3221 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3222 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3223 |
95 | 3224 getcmdpos() *getcmdpos()* |
7 | 3225 Return the position of the cursor in the command line as a |
3226 byte count. The first column is 1. | |
3227 Only works when editing the command line, thus requires use of | |
3228 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise. | |
531 | 3229 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3230 | |
3231 getcmdtype() *getcmdtype()* | |
3232 Return the current command-line type. Possible return values | |
3233 are: | |
532 | 3234 : normal Ex command |
3235 > debug mode command |debug-mode| | |
3236 / forward search command | |
3237 ? backward search command | |
3238 @ |input()| command | |
3239 - |:insert| or |:append| command | |
531 | 3240 Only works when editing the command line, thus requires use of |
3241 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string | |
3242 otherwise. | |
3243 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. | |
7 | 3244 |
3245 *getcwd()* | |
3246 getcwd() The result is a String, which is the name of the current | |
3247 working directory. | |
3248 | |
3249 getfsize({fname}) *getfsize()* | |
3250 The result is a Number, which is the size in bytes of the | |
3251 given file {fname}. | |
3252 If {fname} is a directory, 0 is returned. | |
3253 If the file {fname} can't be found, -1 is returned. | |
1293 | 3254 If the size of {fname} is too big to fit in a Number then -2 |
3255 is returned. | |
7 | 3256 |
37 | 3257 getfontname([{name}]) *getfontname()* |
3258 Without an argument returns the name of the normal font being | |
3259 used. Like what is used for the Normal highlight group | |
3260 |hl-Normal|. | |
3261 With an argument a check is done whether {name} is a valid | |
3262 font name. If not then an empty string is returned. | |
3263 Otherwise the actual font name is returned, or {name} if the | |
3264 GUI does not support obtaining the real name. | |
824 | 3265 Only works when the GUI is running, thus not in your vimrc or |
819 | 3266 gvimrc file. Use the |GUIEnter| autocommand to use this |
3267 function just after the GUI has started. | |
37 | 3268 Note that the GTK 2 GUI accepts any font name, thus checking |
3269 for a valid name does not work. | |
3270 | |
20 | 3271 getfperm({fname}) *getfperm()* |
3272 The result is a String, which is the read, write, and execute | |
3273 permissions of the given file {fname}. | |
3274 If {fname} does not exist or its directory cannot be read, an | |
3275 empty string is returned. | |
3276 The result is of the form "rwxrwxrwx", where each group of | |
3277 "rwx" flags represent, in turn, the permissions of the owner | |
3278 of the file, the group the file belongs to, and other users. | |
3279 If a user does not have a given permission the flag for this | |
3280 is replaced with the string "-". Example: > | |
3281 :echo getfperm("/etc/passwd") | |
3282 < This will hopefully (from a security point of view) display | |
3283 the string "rw-r--r--" or even "rw-------". | |
205 | 3284 |
7 | 3285 getftime({fname}) *getftime()* |
3286 The result is a Number, which is the last modification time of | |
3287 the given file {fname}. The value is measured as seconds | |
3288 since 1st Jan 1970, and may be passed to strftime(). See also | |
3289 |localtime()| and |strftime()|. | |
3290 If the file {fname} can't be found -1 is returned. | |
3291 | |
20 | 3292 getftype({fname}) *getftype()* |
3293 The result is a String, which is a description of the kind of | |
3294 file of the given file {fname}. | |
3295 If {fname} does not exist an empty string is returned. | |
3296 Here is a table over different kinds of files and their | |
3297 results: | |
3298 Normal file "file" | |
3299 Directory "dir" | |
3300 Symbolic link "link" | |
3301 Block device "bdev" | |
3302 Character device "cdev" | |
3303 Socket "socket" | |
3304 FIFO "fifo" | |
3305 All other "other" | |
3306 Example: > | |
3307 getftype("/home") | |
3308 < Note that a type such as "link" will only be returned on | |
3309 systems that support it. On some systems only "dir" and | |
3310 "file" are returned. | |
3311 | |
7 | 3312 *getline()* |
82 | 3313 getline({lnum} [, {end}]) |
3314 Without {end} the result is a String, which is line {lnum} | |
3315 from the current buffer. Example: > | |
7 | 3316 getline(1) |
3317 < When {lnum} is a String that doesn't start with a | |
3318 digit, line() is called to translate the String into a Number. | |
3319 To get the line under the cursor: > | |
3320 getline(".") | |
3321 < When {lnum} is smaller than 1 or bigger than the number of | |
3322 lines in the buffer, an empty string is returned. | |
3323 | |
685 | 3324 When {end} is given the result is a |List| where each item is |
3325 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3326 including line {end}. |
3327 {end} is used in the same way as {lnum}. | |
3328 Non-existing lines are silently omitted. | |
685 | 3329 When {end} is before {lnum} an empty |List| is returned. |
82 | 3330 Example: > |
3331 :let start = line('.') | |
3332 :let end = search("^$") - 1 | |
3333 :let lines = getline(start, end) | |
3334 | |
1156 | 3335 < To get lines from another buffer see |getbufline()| |
3336 | |
647 | 3337 getloclist({nr}) *getloclist()* |
3338 Returns a list with all the entries in the location list for | |
3339 window {nr}. When {nr} is zero the current window is used. | |
3340 For a location list window, the displayed location list is | |
648 | 3341 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
|
3342 returned. Otherwise, same as |getqflist()|. |
82 | 3343 |
1326 | 3344 getmatches() *getmatches()* |
3345 Returns a |List| with all matches previously defined by | |
3346 |matchadd()| and the |:match| commands. |getmatches()| is | |
3347 useful in combination with |setmatches()|, as |setmatches()| | |
3348 can restore a list of matches saved by |getmatches()|. | |
3349 Example: > | |
3350 :echo getmatches() | |
3351 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3352 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3353 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3354 :let m = getmatches() | |
3355 :call clearmatches() | |
3356 :echo getmatches() | |
3357 < [] > | |
3358 :call setmatches(m) | |
3359 :echo getmatches() | |
3360 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3361 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3362 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3363 :unlet m | |
3364 < | |
3365 | |
230 | 3366 getqflist() *getqflist()* |
3367 Returns a list with all the current quickfix errors. Each | |
3368 list item is a dictionary with these entries: | |
3369 bufnr number of buffer that has the file name, use | |
3370 bufname() to get the name | |
3371 lnum line number in the buffer (first line is 1) | |
3372 col column number (first column is 1) | |
233 | 3373 vcol non-zero: "col" is visual column |
3374 zero: "col" is byte index | |
230 | 3375 nr error number |
1065 | 3376 pattern search pattern used to locate the error |
230 | 3377 text description of the error |
3378 type type of the error, 'E', '1', etc. | |
3379 valid non-zero: recognized error message | |
3380 | |
515 | 3381 When there is no error list or it's empty an empty list is |
1065 | 3382 returned. Quickfix list entries with non-existing buffer |
3383 number are returned with "bufnr" set to zero. | |
515 | 3384 |
230 | 3385 Useful application: Find pattern matches in multiple files and |
3386 do something with them: > | |
3387 :vimgrep /theword/jg *.c | |
3388 :for d in getqflist() | |
3389 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
3390 :endfor | |
3391 | |
3392 | |
282 | 3393 getreg([{regname} [, 1]]) *getreg()* |
7 | 3394 The result is a String, which is the contents of register |
236 | 3395 {regname}. Example: > |
7 | 3396 :let cliptext = getreg('*') |
3397 < getreg('=') returns the last evaluated value of the expression | |
236 | 3398 register. (For use in maps.) |
282 | 3399 getreg('=', 1) returns the expression itself, so that it can |
3400 be restored with |setreg()|. For other registers the extra | |
3401 argument is ignored, thus you can always give it. | |
7 | 3402 If {regname} is not specified, |v:register| is used. |
3403 | |
82 | 3404 |
7 | 3405 getregtype([{regname}]) *getregtype()* |
3406 The result is a String, which is type of register {regname}. | |
3407 The value will be one of: | |
3408 "v" for |characterwise| text | |
3409 "V" for |linewise| text | |
3410 "<CTRL-V>{width}" for |blockwise-visual| text | |
3411 0 for an empty or unknown register | |
3412 <CTRL-V> is one character with value 0x16. | |
3413 If {regname} is not specified, |v:register| is used. | |
3414 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3415 gettabvar({tabnr}, {varname}) *gettabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3416 Get the value of a tab-local variable {varname} in tab page |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3417 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3418 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3419 Note that the name without "t:" must be used. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3420 |
831 | 3421 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()* |
1156 | 3422 Get the value of window-local variable {varname} in window |
3423 {winnr} in tab page {tabnr}. | |
3424 When {varname} starts with "&" get the value of a window-local | |
3425 option. | |
831 | 3426 Tabs are numbered starting with one. For the current tabpage |
3427 use |getwinvar()|. | |
3428 When {winnr} is zero the current window is used. | |
3429 This also works for a global option, buffer-local option and | |
3430 window-local option, but it doesn't work for a global variable | |
3431 or buffer-local variable. | |
1156 | 3432 When {varname} is empty a dictionary with all window-local |
3433 variables is returned. | |
3434 Note that {varname} must be the name without "w:". | |
831 | 3435 Examples: > |
3436 :let list_is_on = gettabwinvar(1, 2, '&list') | |
3437 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 3438 < |
7 | 3439 *getwinposx()* |
3440 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
3441 the left hand side of the GUI Vim window. The result will be | |
3442 -1 if the information is not available. | |
3443 | |
3444 *getwinposy()* | |
3445 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 3446 the top of the GUI Vim window. The result will be -1 if the |
7 | 3447 information is not available. |
3448 | |
831 | 3449 getwinvar({winnr}, {varname}) *getwinvar()* |
3450 Like |gettabwinvar()| for the current tabpage. | |
7 | 3451 Examples: > |
3452 :let list_is_on = getwinvar(2, '&list') | |
3453 :echo "myvar = " . getwinvar(1, 'myvar') | |
3454 < | |
1754 | 3455 glob({expr} [, {flag}]) *glob()* |
3456 Expand the file wildcards in {expr}. See |wildcards| for the | |
1156 | 3457 use of special characters. |
3458 The result is a String. | |
7 | 3459 When there are several matches, they are separated by <NL> |
3460 characters. | |
1754 | 3461 Unless the optional {flag} argument is given and is non-zero, |
3462 the 'suffixes' and 'wildignore' options apply: Names matching | |
3463 one of the patterns in 'wildignore' will be skipped and | |
3464 'suffixes' affect the ordering of matches. | |
2662 | 3465 'wildignorecase' always applies. |
7 | 3466 If the expansion fails, the result is an empty string. |
3467 A name for a non-existing file is not included. | |
3468 | |
3469 For most systems backticks can be used to get files names from | |
3470 any external command. Example: > | |
3471 :let tagfiles = glob("`find . -name tags -print`") | |
3472 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
3473 < The result of the program inside the backticks should be one | |
1621 | 3474 item per line. Spaces inside an item are allowed. |
7 | 3475 |
3476 See |expand()| for expanding special Vim variables. See | |
3477 |system()| for getting the raw output of an external command. | |
3478 | |
1754 | 3479 globpath({path}, {expr} [, {flag}]) *globpath()* |
7 | 3480 Perform glob() on all directories in {path} and concatenate |
3481 the results. Example: > | |
3482 :echo globpath(&rtp, "syntax/c.vim") | |
3483 < {path} is a comma-separated list of directory names. Each | |
3484 directory name is prepended to {expr} and expanded like with | |
1754 | 3485 |glob()|. A path separator is inserted when needed. |
7 | 3486 To add a comma inside a directory name escape it with a |
3487 backslash. Note that on MS-Windows a directory may have a | |
3488 trailing backslash, remove it if you put a comma after it. | |
3489 If the expansion fails for one of the directories, there is no | |
3490 error message. | |
1754 | 3491 Unless the optional {flag} argument is given and is non-zero, |
3492 the 'suffixes' and 'wildignore' options apply: Names matching | |
3493 one of the patterns in 'wildignore' will be skipped and | |
3494 'suffixes' affect the ordering of matches. | |
7 | 3495 |
444 | 3496 The "**" item can be used to search in a directory tree. |
3497 For example, to find all "README.txt" files in the directories | |
3498 in 'runtimepath' and below: > | |
3499 :echo globpath(&rtp, "**/README.txt") | |
1668 | 3500 < Upwards search and limiting the depth of "**" is not |
3501 supported, thus using 'path' will not always work properly. | |
3502 | |
7 | 3503 *has()* |
3504 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
3505 supported, zero otherwise. The {feature} argument is a | |
3506 string. See |feature-list| below. | |
3507 Also see |exists()|. | |
3508 | |
102 | 3509 |
3510 has_key({dict}, {key}) *has_key()* | |
685 | 3511 The result is a Number, which is 1 if |Dictionary| {dict} has |
3512 an entry with key {key}. Zero otherwise. | |
102 | 3513 |
1104 | 3514 haslocaldir() *haslocaldir()* |
3515 The result is a Number, which is 1 when the current | |
1621 | 3516 window has set a local path via |:lcd|, and 0 otherwise. |
102 | 3517 |
782 | 3518 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 3519 The result is a Number, which is 1 if there is a mapping that |
3520 contains {what} in somewhere in the rhs (what it is mapped to) | |
3521 and this mapping exists in one of the modes indicated by | |
3522 {mode}. | |
782 | 3523 When {abbr} is there and it is non-zero use abbreviations |
786 | 3524 instead of mappings. Don't forget to specify Insert and/or |
3525 Command-line mode. | |
7 | 3526 Both the global mappings and the mappings local to the current |
3527 buffer are checked for a match. | |
3528 If no matching mapping is found 0 is returned. | |
3529 The following characters are recognized in {mode}: | |
3530 n Normal mode | |
3531 v Visual mode | |
3532 o Operator-pending mode | |
3533 i Insert mode | |
3534 l Language-Argument ("r", "f", "t", etc.) | |
3535 c Command-line mode | |
3536 When {mode} is omitted, "nvo" is used. | |
3537 | |
3538 This function is useful to check if a mapping already exists | |
1621 | 3539 to a function in a Vim script. Example: > |
7 | 3540 :if !hasmapto('\ABCdoit') |
3541 : map <Leader>d \ABCdoit | |
3542 :endif | |
3543 < This installs the mapping to "\ABCdoit" only if there isn't | |
3544 already a mapping to "\ABCdoit". | |
3545 | |
3546 histadd({history}, {item}) *histadd()* | |
3547 Add the String {item} to the history {history} which can be | |
3548 one of: *hist-names* | |
3549 "cmd" or ":" command line history | |
3550 "search" or "/" search pattern history | |
1621 | 3551 "expr" or "=" typed expression history |
7 | 3552 "input" or "@" input line history |
3553 If {item} does already exist in the history, it will be | |
3554 shifted to become the newest entry. | |
3555 The result is a Number: 1 if the operation was successful, | |
3556 otherwise 0 is returned. | |
3557 | |
3558 Example: > | |
3559 :call histadd("input", strftime("%Y %b %d")) | |
3560 :let date=input("Enter date: ") | |
3561 < This function is not available in the |sandbox|. | |
3562 | |
3563 histdel({history} [, {item}]) *histdel()* | |
236 | 3564 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 3565 for the possible values of {history}. |
3566 | |
1668 | 3567 If the parameter {item} evaluates to a String, it is used as a |
3568 regular expression. All entries matching that expression will | |
3569 be removed from the history (if there are any). | |
7 | 3570 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 3571 If {item} evaluates to a Number, it will be interpreted as |
3572 an index, see |:history-indexing|. The respective entry will | |
3573 be removed if it exists. | |
7 | 3574 |
3575 The result is a Number: 1 for a successful operation, | |
3576 otherwise 0 is returned. | |
3577 | |
3578 Examples: | |
3579 Clear expression register history: > | |
3580 :call histdel("expr") | |
3581 < | |
3582 Remove all entries starting with "*" from the search history: > | |
3583 :call histdel("/", '^\*') | |
3584 < | |
3585 The following three are equivalent: > | |
3586 :call histdel("search", histnr("search")) | |
3587 :call histdel("search", -1) | |
3588 :call histdel("search", '^'.histget("search", -1).'$') | |
3589 < | |
3590 To delete the last search pattern and use the last-but-one for | |
3591 the "n" command and 'hlsearch': > | |
3592 :call histdel("search", -1) | |
3593 :let @/ = histget("search", -1) | |
3594 | |
3595 histget({history} [, {index}]) *histget()* | |
3596 The result is a String, the entry with Number {index} from | |
3597 {history}. See |hist-names| for the possible values of | |
3598 {history}, and |:history-indexing| for {index}. If there is | |
3599 no such entry, an empty String is returned. When {index} is | |
3600 omitted, the most recent item from the history is used. | |
3601 | |
3602 Examples: | |
3603 Redo the second last search from history. > | |
3604 :execute '/' . histget("search", -2) | |
3605 | |
3606 < Define an Ex command ":H {num}" that supports re-execution of | |
3607 the {num}th entry from the output of |:history|. > | |
3608 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
3609 < | |
3610 histnr({history}) *histnr()* | |
3611 The result is the Number of the current entry in {history}. | |
3612 See |hist-names| for the possible values of {history}. | |
3613 If an error occurred, -1 is returned. | |
3614 | |
3615 Example: > | |
3616 :let inp_index = histnr("expr") | |
3617 < | |
3618 hlexists({name}) *hlexists()* | |
3619 The result is a Number, which is non-zero if a highlight group | |
3620 called {name} exists. This is when the group has been | |
3621 defined in some way. Not necessarily when highlighting has | |
3622 been defined for it, it may also have been used for a syntax | |
3623 item. | |
3624 *highlight_exists()* | |
3625 Obsolete name: highlight_exists(). | |
3626 | |
3627 *hlID()* | |
3628 hlID({name}) The result is a Number, which is the ID of the highlight group | |
3629 with name {name}. When the highlight group doesn't exist, | |
3630 zero is returned. | |
3631 This can be used to retrieve information about the highlight | |
1621 | 3632 group. For example, to get the background color of the |
7 | 3633 "Comment" group: > |
3634 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
3635 < *highlightID()* | |
3636 Obsolete name: highlightID(). | |
3637 | |
3638 hostname() *hostname()* | |
3639 The result is a String, which is the name of the machine on | |
236 | 3640 which Vim is currently running. Machine names greater than |
7 | 3641 256 characters long are truncated. |
3642 | |
3643 iconv({expr}, {from}, {to}) *iconv()* | |
3644 The result is a String, which is the text {expr} converted | |
3645 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3646 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3647 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3648 are replaced with "?". |
7 | 3649 The encoding names are whatever the iconv() library function |
3650 can accept, see ":!man 3 iconv". | |
3651 Most conversions require Vim to be compiled with the |+iconv| | |
3652 feature. Otherwise only UTF-8 to latin1 conversion and back | |
3653 can be done. | |
3654 This can be used to display messages with special characters, | |
3655 no matter what 'encoding' is set to. Write the message in | |
3656 UTF-8 and use: > | |
3657 echo iconv(utf8_str, "utf-8", &enc) | |
3658 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
3659 from/to UCS-2 is automatically changed to use UTF-8. You | |
3660 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3661 {only available when compiled with the |+multi_byte| feature} |
7 | 3662 |
3663 *indent()* | |
3664 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
3665 current buffer. The indent is counted in spaces, the value | |
3666 of 'tabstop' is relevant. {lnum} is used just like in | |
3667 |getline()|. | |
3668 When {lnum} is invalid -1 is returned. | |
3669 | |
79 | 3670 |
95 | 3671 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 3672 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
|
3673 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3674 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
|
3675 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
|
3676 is not used here, case always matters. |
153 | 3677 If {start} is given then start looking at the item with index |
3678 {start} (may be negative for an item relative to the end). | |
79 | 3679 When {ic} is given and it is non-zero, ignore case. Otherwise |
3680 case must match. | |
3681 -1 is returned when {expr} is not found in {list}. | |
3682 Example: > | |
3683 :let idx = index(words, "the") | |
87 | 3684 :if index(numbers, 123) >= 0 |
79 | 3685 |
3686 | |
531 | 3687 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 3688 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
|
3689 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3690 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
|
3691 in the prompt to start a new line. |
531 | 3692 The highlighting set with |:echohl| is used for the prompt. |
3693 The input is entered just like a command-line, with the same | |
1621 | 3694 editing commands and mappings. There is a separate history |
531 | 3695 for lines typed for input(). |
3696 Example: > | |
3697 :if input("Coffee or beer? ") == "beer" | |
3698 : echo "Cheers!" | |
3699 :endif | |
3700 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3701 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3702 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
|
3703 Example: > |
531 | 3704 :let color = input("Color? ", "white") |
3705 | |
3706 < The optional {completion} argument specifies the type of | |
3707 completion supported for the input. Without it completion is | |
1621 | 3708 not performed. The supported completion types are the same as |
531 | 3709 that can be supplied to a user-defined command using the |
1621 | 3710 "-complete=" argument. Refer to |:command-completion| for |
531 | 3711 more information. Example: > |
3712 let fname = input("File: ", "", "file") | |
3713 < | |
3714 NOTE: This function must not be used in a startup file, for | |
3715 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 3716 Note: When input() is called from within a mapping it will |
3717 consume remaining characters from that mapping, because a | |
3718 mapping is handled like the characters were typed. | |
3719 Use |inputsave()| before input() and |inputrestore()| | |
3720 after input() to avoid that. Another solution is to avoid | |
3721 that further characters follow in the mapping, e.g., by using | |
3722 |:execute| or |:normal|. | |
3723 | |
531 | 3724 Example with a mapping: > |
7 | 3725 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
3726 :function GetFoo() | |
3727 : call inputsave() | |
3728 : let g:Foo = input("enter search pattern: ") | |
3729 : call inputrestore() | |
3730 :endfunction | |
3731 | |
3732 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3733 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3734 are supported, a dialog window pops up to input the text. |
7 | 3735 Example: > |
3736 :let n = inputdialog("value for shiftwidth", &sw) | |
3737 :if n != "" | |
3738 : let &sw = n | |
3739 :endif | |
3740 < When the dialog is cancelled {cancelreturn} is returned. When | |
3741 omitted an empty string is returned. | |
3742 Hitting <Enter> works like pressing the OK button. Hitting | |
3743 <Esc> works like pressing the Cancel button. | |
531 | 3744 NOTE: Command-line completion is not supported. |
7 | 3745 |
519 | 3746 inputlist({textlist}) *inputlist()* |
819 | 3747 {textlist} must be a |List| of strings. This |List| is |
3748 displayed, one string per line. The user will be prompted to | |
3749 enter a number, which is returned. | |
519 | 3750 The user can also select an item by clicking on it with the |
1621 | 3751 mouse. For the first string 0 is returned. When clicking |
519 | 3752 above the first item a negative number is returned. When |
3753 clicking on the prompt one more than the length of {textlist} | |
3754 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3755 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 3756 it won't work. It's a good idea to put the entry number at |
1156 | 3757 the start of the string. And put a prompt in the first item. |
3758 Example: > | |
519 | 3759 let color = inputlist(['Select color:', '1. red', |
3760 \ '2. green', '3. blue']) | |
3761 | |
7 | 3762 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3763 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 3764 Should be called the same number of times inputsave() is |
3765 called. Calling it more often is harmless though. | |
3766 Returns 1 when there is nothing to restore, 0 otherwise. | |
3767 | |
3768 inputsave() *inputsave()* | |
3769 Preserve typeahead (also from mappings) and clear it, so that | |
3770 a following prompt gets input from the user. Should be | |
3771 followed by a matching inputrestore() after the prompt. Can | |
3772 be used several times, in which case there must be just as | |
3773 many inputrestore() calls. | |
3774 Returns 1 when out of memory, 0 otherwise. | |
3775 | |
3776 inputsecret({prompt} [, {text}]) *inputsecret()* | |
3777 This function acts much like the |input()| function with but | |
3778 two exceptions: | |
3779 a) the user's response will be displayed as a sequence of | |
3780 asterisks ("*") thereby keeping the entry secret, and | |
3781 b) the user's response will not be recorded on the input | |
3782 |history| stack. | |
3783 The result is a String, which is whatever the user actually | |
3784 typed on the command-line in response to the issued prompt. | |
531 | 3785 NOTE: Command-line completion is not supported. |
7 | 3786 |
55 | 3787 insert({list}, {item} [, {idx}]) *insert()* |
685 | 3788 Insert {item} at the start of |List| {list}. |
55 | 3789 If {idx} is specified insert {item} before the item with index |
1621 | 3790 {idx}. If {idx} is zero it goes before the first item, just |
55 | 3791 like omitting {idx}. A negative {idx} is also possible, see |
3792 |list-index|. -1 inserts just before the last item. | |
685 | 3793 Returns the resulting |List|. Examples: > |
55 | 3794 :let mylist = insert([2, 3, 5], 1) |
3795 :call insert(mylist, 4, -1) | |
3796 :call insert(mylist, 6, len(mylist)) | |
82 | 3797 < The last example can be done simpler with |add()|. |
685 | 3798 Note that when {item} is a |List| it is inserted as a single |
692 | 3799 item. Use |extend()| to concatenate |Lists|. |
55 | 3800 |
3214 | 3801 invert({expr}) *invert()* |
3802 Bitwise invert. The argument is converted to a number. A | |
3803 List, Dict or Float argument causes an error. Example: > | |
3804 :let bits = invert(bits) | |
3805 | |
7 | 3806 isdirectory({directory}) *isdirectory()* |
3807 The result is a Number, which is non-zero when a directory | |
3808 with the name {directory} exists. If {directory} doesn't | |
3809 exist, or isn't a directory, the result is FALSE. {directory} | |
3810 is any expression, which is used as a String. | |
3811 | |
819 | 3812 islocked({expr}) *islocked()* *E786* |
148 | 3813 The result is a Number, which is non-zero when {expr} is the |
3814 name of a locked variable. | |
685 | 3815 {expr} must be the name of a variable, |List| item or |
3816 |Dictionary| entry, not the variable itself! Example: > | |
148 | 3817 :let alist = [0, ['a', 'b'], 2, 3] |
3818 :lockvar 1 alist | |
3819 :echo islocked('alist') " 1 | |
3820 :echo islocked('alist[1]') " 0 | |
3821 | |
3822 < When {expr} is a variable that does not exist you get an error | |
843 | 3823 message. Use |exists()| to check for existence. |
148 | 3824 |
140 | 3825 items({dict}) *items()* |
685 | 3826 Return a |List| with all the key-value pairs of {dict}. Each |
3827 |List| item is a list with two items: the key of a {dict} | |
3828 entry and the value of this entry. The |List| is in arbitrary | |
3829 order. | |
140 | 3830 |
95 | 3831 |
3832 join({list} [, {sep}]) *join()* | |
3833 Join the items in {list} together into one String. | |
3834 When {sep} is specified it is put in between the items. If | |
3835 {sep} is omitted a single space is used. | |
3836 Note that {sep} is not added at the end. You might want to | |
3837 add it there too: > | |
3838 let lines = join(mylist, "\n") . "\n" | |
692 | 3839 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 3840 converted into a string like with |string()|. |
3841 The opposite function is |split()|. | |
3842 | |
99 | 3843 keys({dict}) *keys()* |
685 | 3844 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 3845 arbitrary order. |
3846 | |
85 | 3847 *len()* *E701* |
55 | 3848 len({expr}) The result is a Number, which is the length of the argument. |
3849 When {expr} is a String or a Number the length in bytes is | |
3850 used, as with |strlen()|. | |
685 | 3851 When {expr} is a |List| the number of items in the |List| is |
55 | 3852 returned. |
685 | 3853 When {expr} is a |Dictionary| the number of entries in the |
3854 |Dictionary| is returned. | |
55 | 3855 Otherwise an error is given. |
3856 | |
7 | 3857 *libcall()* *E364* *E368* |
3858 libcall({libname}, {funcname}, {argument}) | |
3859 Call function {funcname} in the run-time library {libname} | |
3860 with single argument {argument}. | |
3861 This is useful to call functions in a library that you | |
3862 especially made to be used with Vim. Since only one argument | |
3863 is possible, calling standard library functions is rather | |
3864 limited. | |
3865 The result is the String returned by the function. If the | |
3866 function returns NULL, this will appear as an empty string "" | |
3867 to Vim. | |
3868 If the function returns a number, use libcallnr()! | |
3869 If {argument} is a number, it is passed to the function as an | |
3870 int; if {argument} is a string, it is passed as a | |
3871 null-terminated string. | |
3872 This function will fail in |restricted-mode|. | |
3873 | |
3874 libcall() allows you to write your own 'plug-in' extensions to | |
3875 Vim without having to recompile the program. It is NOT a | |
3876 means to call system functions! If you try to do so Vim will | |
3877 very probably crash. | |
3878 | |
3879 For Win32, the functions you write must be placed in a DLL | |
3880 and use the normal C calling convention (NOT Pascal which is | |
3881 used in Windows System DLLs). The function must take exactly | |
3882 one parameter, either a character pointer or a long integer, | |
3883 and must return a character pointer or NULL. The character | |
3884 pointer returned must point to memory that will remain valid | |
3885 after the function has returned (e.g. in static data in the | |
3886 DLL). If it points to allocated memory, that memory will | |
3887 leak away. Using a static buffer in the function should work, | |
3888 it's then freed when the DLL is unloaded. | |
3889 | |
3890 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 3891 crash! This also happens if the function returns a number, |
7 | 3892 because Vim thinks it's a pointer. |
3893 For Win32 systems, {libname} should be the filename of the DLL | |
3894 without the ".DLL" suffix. A full path is only required if | |
3895 the DLL is not in the usual places. | |
3896 For Unix: When compiling your own plugins, remember that the | |
3897 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3898 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 3899 feature is present} |
3900 Examples: > | |
3901 :echo libcall("libc.so", "getenv", "HOME") | |
3902 < | |
3903 *libcallnr()* | |
3904 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3905 Just like |libcall()|, but used for a function that returns an |
7 | 3906 int instead of a string. |
3907 {only in Win32 on some Unix versions, when the |+libcall| | |
3908 feature is present} | |
1621 | 3909 Examples: > |
3910 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 3911 :call libcallnr("libc.so", "printf", "Hello World!\n") |
3912 :call libcallnr("libc.so", "sleep", 10) | |
3913 < | |
3914 *line()* | |
3915 line({expr}) The result is a Number, which is the line number of the file | |
3916 position given with {expr}. The accepted positions are: | |
3917 . the cursor position | |
3918 $ the last line in the current buffer | |
3919 'x position of mark x (if the mark is not set, 0 is | |
3920 returned) | |
665 | 3921 w0 first line visible in current window |
3922 w$ last line visible in current window | |
1609 | 3923 v In Visual mode: the start of the Visual area (the |
3924 cursor is the end). When not in Visual mode | |
3925 returns the cursor position. Differs from |'<| in | |
3926 that it's updated right away. | |
1156 | 3927 Note that a mark in another file can be used. The line number |
3928 then applies to another buffer. | |
703 | 3929 To get the column number use |col()|. To get both use |
3930 |getpos()|. | |
7 | 3931 Examples: > |
3932 line(".") line number of the cursor | |
3933 line("'t") line number of mark t | |
3934 line("'" . marker) line number of mark marker | |
3935 < *last-position-jump* | |
3936 This autocommand jumps to the last known position in a file | |
3937 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3938 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 3939 |
7 | 3940 line2byte({lnum}) *line2byte()* |
3941 Return the byte count from the start of the buffer for line | |
3942 {lnum}. This includes the end-of-line character, depending on | |
3943 the 'fileformat' option for the current buffer. The first | |
3237 | 3944 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 3945 This can also be used to get the byte count for the line just |
3946 below the last line: > | |
3947 line2byte(line("$") + 1) | |
3237 | 3948 < This is the buffer size plus one. If 'fileencoding' is empty |
3949 it is the file size plus one. | |
7 | 3950 When {lnum} is invalid, or the |+byte_offset| feature has been |
3951 disabled at compile time, -1 is returned. | |
3952 Also see |byte2line()|, |go| and |:goto|. | |
3953 | |
3954 lispindent({lnum}) *lispindent()* | |
3955 Get the amount of indent for line {lnum} according the lisp | |
3956 indenting rules, as with 'lisp'. | |
3957 The indent is counted in spaces, the value of 'tabstop' is | |
3958 relevant. {lnum} is used just like in |getline()|. | |
3959 When {lnum} is invalid or Vim was not compiled the | |
3960 |+lispindent| feature, -1 is returned. | |
3961 | |
3962 localtime() *localtime()* | |
3963 Return the current time, measured as seconds since 1st Jan | |
3964 1970. See also |strftime()| and |getftime()|. | |
3965 | |
95 | 3966 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3967 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3968 Return the natural logarithm (base e) of {expr} as a |Float|. |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3969 {expr} must evaluate to a |Float| or a |Number| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3970 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3971 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3972 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3973 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3974 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3975 < 5.0 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3976 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3977 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3978 |
1621 | 3979 log10({expr}) *log10()* |
3980 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
3981 {expr} must evaluate to a |Float| or a |Number|. | |
3982 Examples: > | |
3983 :echo log10(1000) | |
3984 < 3.0 > | |
3985 :echo log10(0.01) | |
3986 < -2.0 | |
3987 {only available when compiled with the |+float| feature} | |
3988 | |
102 | 3989 map({expr}, {string}) *map()* |
685 | 3990 {expr} must be a |List| or a |Dictionary|. |
102 | 3991 Replace each item in {expr} with the result of evaluating |
3992 {string}. | |
3993 Inside {string} |v:val| has the value of the current item. | |
1998 | 3994 For a |Dictionary| |v:key| has the key of the current item |
3995 and for a |List| |v:key| has the index of the current item. | |
102 | 3996 Example: > |
3997 :call map(mylist, '"> " . v:val . " <"') | |
95 | 3998 < This puts "> " before and " <" after each item in "mylist". |
102 | 3999 |
158 | 4000 Note that {string} is the result of an expression and is then |
102 | 4001 used as an expression again. Often it is good to use a |
158 | 4002 |literal-string| to avoid having to double backslashes. You |
4003 still have to double ' quotes | |
102 | 4004 |
685 | 4005 The operation is done in-place. If you want a |List| or |
4006 |Dictionary| to remain unmodified make a copy first: > | |
99 | 4007 :let tlist = map(copy(mylist), ' & . "\t"') |
102 | 4008 |
685 | 4009 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4010 When an error is encountered while evaluating {string} no |
4011 further items in {expr} are processed. | |
95 | 4012 |
4013 | |
2610 | 4014 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4015 When {dict} is omitted or zero: Return the rhs of mapping | |
4016 {name} in mode {mode}. The returned String has special | |
4017 characters translated like in the output of the ":map" command | |
4018 listing. | |
4019 | |
4020 When there is no mapping for {name}, an empty String is | |
4021 returned. | |
4022 | |
4023 The {name} can have special key names, like in the ":map" | |
4024 command. | |
4025 | |
644 | 4026 {mode} can be one of these strings: |
7 | 4027 "n" Normal |
2610 | 4028 "v" Visual (including Select) |
7 | 4029 "o" Operator-pending |
4030 "i" Insert | |
4031 "c" Cmd-line | |
2610 | 4032 "s" Select |
4033 "x" Visual | |
7 | 4034 "l" langmap |language-mapping| |
4035 "" Normal, Visual and Operator-pending | |
644 | 4036 When {mode} is omitted, the modes for "" are used. |
2610 | 4037 |
782 | 4038 When {abbr} is there and it is non-zero use abbreviations |
4039 instead of mappings. | |
2610 | 4040 |
4041 When {dict} is there and it is non-zero return a dictionary | |
4042 containing all the information of the mapping with the | |
4043 following items: | |
4044 "lhs" The {lhs} of the mapping. | |
4045 "rhs" The {rhs} of the mapping as typed. | |
4046 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 4047 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 4048 "expr" 1 for an expression mapping (|:map-<expr>|). |
4049 "buffer" 1 for a buffer local mapping (|:map-local|). | |
4050 "mode" Modes for which the mapping is defined. In | |
4051 addition to the modes mentioned above, these | |
4052 characters will be used: | |
4053 " " Normal, Visual and Operator-pending | |
4054 "!" Insert and Commandline mode | |
2642 | 4055 (|mapmode-ic|) |
2625 | 4056 "sid" The script local ID, used for <sid> mappings |
4057 (|<SID>|). | |
2610 | 4058 |
7 | 4059 The mappings local to the current buffer are checked first, |
4060 then the global mappings. | |
626 | 4061 This function can be used to map a key even when it's already |
4062 mapped, and have it do the original mapping too. Sketch: > | |
4063 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
4064 | |
7 | 4065 |
782 | 4066 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 4067 Check if there is a mapping that matches with {name} in mode |
4068 {mode}. See |maparg()| for {mode} and special names in | |
4069 {name}. | |
782 | 4070 When {abbr} is there and it is non-zero use abbreviations |
4071 instead of mappings. | |
7 | 4072 A match happens with a mapping that starts with {name} and |
4073 with a mapping which is equal to the start of {name}. | |
4074 | |
1621 | 4075 matches mapping "a" "ab" "abc" ~ |
7 | 4076 mapcheck("a") yes yes yes |
4077 mapcheck("abc") yes yes yes | |
4078 mapcheck("ax") yes no no | |
4079 mapcheck("b") no no no | |
4080 | |
4081 The difference with maparg() is that mapcheck() finds a | |
4082 mapping that matches with {name}, while maparg() only finds a | |
4083 mapping for {name} exactly. | |
4084 When there is no mapping that starts with {name}, an empty | |
4085 String is returned. If there is one, the rhs of that mapping | |
4086 is returned. If there are several mappings that start with | |
4087 {name}, the rhs of one of them is returned. | |
4088 The mappings local to the current buffer are checked first, | |
4089 then the global mappings. | |
4090 This function can be used to check if a mapping can be added | |
4091 without being ambiguous. Example: > | |
4092 :if mapcheck("_vv") == "" | |
4093 : map _vv :set guifont=7x13<CR> | |
4094 :endif | |
4095 < This avoids adding the "_vv" mapping when there already is a | |
4096 mapping for "_v" or for "_vvv". | |
4097 | |
19 | 4098 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 4099 When {expr} is a |List| then this returns the index of the |
4100 first item where {pat} matches. Each item is used as a | |
692 | 4101 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 4102 Otherwise, {expr} is used as a String. The result is a |
95 | 4103 Number, which gives the index (byte offset) in {expr} where |
4104 {pat} matches. | |
685 | 4105 A match at the first character or |List| item returns zero. |
19 | 4106 If there is no match -1 is returned. |
2833 | 4107 For getting submatches see |matchlist()|. |
19 | 4108 Example: > |
95 | 4109 :echo match("testing", "ing") " results in 4 |
714 | 4110 :echo match([1, 'x'], '\a') " results in 1 |
95 | 4111 < See |string-match| for how {pat} is used. |
170 | 4112 *strpbrk()* |
1621 | 4113 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 4114 :let sepidx = match(line, '[.,;: \t]') |
4115 < *strcasestr()* | |
4116 Vim doesn't have a strcasestr() function. But you can add | |
4117 "\c" to the pattern to ignore case: > | |
4118 :let idx = match(haystack, '\cneedle') | |
4119 < | |
95 | 4120 If {start} is given, the search starts from byte index |
685 | 4121 {start} in a String or item {start} in a |List|. |
7 | 4122 The result, however, is still the index counted from the |
236 | 4123 first character/item. Example: > |
7 | 4124 :echo match("testing", "ing", 2) |
4125 < result is again "4". > | |
4126 :echo match("testing", "ing", 4) | |
4127 < result is again "4". > | |
4128 :echo match("testing", "t", 2) | |
4129 < result is "3". | |
694 | 4130 For a String, if {start} > 0 then it is like the string starts |
703 | 4131 {start} bytes later, thus "^" will match at {start}. Except |
4132 when {count} is given, then it's like matches before the | |
4133 {start} byte are ignored (this is a bit complicated to keep it | |
4134 backwards compatible). | |
95 | 4135 For a String, if {start} < 0, it will be set to 0. For a list |
4136 the index is counted from the end. | |
697 | 4137 If {start} is out of range ({start} > strlen({expr}) for a |
4138 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 4139 |
694 | 4140 When {count} is given use the {count}'th match. When a match |
697 | 4141 is found in a String the search for the next one starts one |
694 | 4142 character further. Thus this example results in 1: > |
4143 echo match("testing", "..", 0, 2) | |
4144 < In a |List| the search continues in the next item. | |
703 | 4145 Note that when {count} is added the way {start} works changes, |
4146 see above. | |
694 | 4147 |
7 | 4148 See |pattern| for the patterns that are accepted. |
4149 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 4150 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 4151 done like 'magic' is set and 'cpoptions' is empty. |
4152 | |
1326 | 4153 *matchadd()* *E798* *E799* *E801* |
4154 matchadd({group}, {pattern}[, {priority}[, {id}]]) | |
4155 Defines a pattern to be highlighted in the current window (a | |
4156 "match"). It will be highlighted with {group}. Returns an | |
4157 identification number (ID), which can be used to delete the | |
4158 match using |matchdelete()|. | |
4159 | |
4160 The optional {priority} argument assigns a priority to the | |
1621 | 4161 match. A match with a high priority will have its |
1326 | 4162 highlighting overrule that of a match with a lower priority. |
4163 A priority is specified as an integer (negative numbers are no | |
4164 exception). If the {priority} argument is not specified, the | |
4165 default priority is 10. The priority of 'hlsearch' is zero, | |
4166 hence all matches with a priority greater than zero will | |
4167 overrule it. Syntax highlighting (see 'syntax') is a separate | |
4168 mechanism, and regardless of the chosen priority a match will | |
4169 always overrule syntax highlighting. | |
4170 | |
4171 The optional {id} argument allows the request for a specific | |
4172 match ID. If a specified ID is already taken, an error | |
4173 message will appear and the match will not be added. An ID | |
4174 is specified as a positive integer (zero excluded). IDs 1, 2 | |
4175 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
4176 respectively. If the {id} argument is not specified, | |
4177 |matchadd()| automatically chooses a free ID. | |
4178 | |
4179 The number of matches is not limited, as it is the case with | |
4180 the |:match| commands. | |
4181 | |
4182 Example: > | |
4183 :highlight MyGroup ctermbg=green guibg=green | |
4184 :let m = matchadd("MyGroup", "TODO") | |
4185 < Deletion of the pattern: > | |
4186 :call matchdelete(m) | |
4187 | |
4188 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 4189 available from |getmatches()|. All matches can be deleted in |
1326 | 4190 one operation by |clearmatches()|. |
819 | 4191 |
4192 matcharg({nr}) *matcharg()* | |
856 | 4193 Selects the {nr} match item, as set with a |:match|, |
819 | 4194 |:2match| or |:3match| command. |
4195 Return a |List| with two elements: | |
4196 The name of the highlight group used | |
4197 The pattern used. | |
4198 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
4199 When there is no match item set returns ['', '']. | |
1326 | 4200 This is useful to save and restore a |:match|. |
4201 Highlighting matches using the |:match| commands are limited | |
4202 to three matches. |matchadd()| does not have this limitation. | |
4203 | |
4204 matchdelete({id}) *matchdelete()* *E802* *E803* | |
4205 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 4206 or one of the |:match| commands. Returns 0 if successful, |
1326 | 4207 otherwise -1. See example for |matchadd()|. All matches can |
4208 be deleted in one operation by |clearmatches()|. | |
819 | 4209 |
19 | 4210 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4211 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4212 after the match. Example: > |
7 | 4213 :echo matchend("testing", "ing") |
4214 < results in "7". | |
170 | 4215 *strspn()* *strcspn()* |
4216 Vim doesn't have a strspn() or strcspn() function, but you can | |
4217 do it with matchend(): > | |
4218 :let span = matchend(line, '[a-zA-Z]') | |
4219 :let span = matchend(line, '[^a-zA-Z]') | |
4220 < Except that -1 is returned when there are no matches. | |
4221 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4222 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4223 :echo matchend("testing", "ing", 2) |
4224 < results in "7". > | |
4225 :echo matchend("testing", "ing", 5) | |
4226 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4227 When {expr} is a |List| the result is equal to |match()|. |
7 | 4228 |
158 | 4229 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4230 Same as |match()|, but return a |List|. The first item in the |
158 | 4231 list is the matched string, same as what matchstr() would |
4232 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 4233 in |:substitute|. When an optional submatch didn't match an |
4234 empty string is used. Example: > | |
4235 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
4236 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 4237 When there is no match an empty list is returned. |
4238 | |
19 | 4239 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 4240 Same as |match()|, but return the matched string. Example: > |
7 | 4241 :echo matchstr("testing", "ing") |
4242 < results in "ing". | |
4243 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4244 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4245 :echo matchstr("testing", "ing", 2) |
4246 < results in "ing". > | |
4247 :echo matchstr("testing", "ing", 5) | |
4248 < result is "". | |
685 | 4249 When {expr} is a |List| then the matching item is returned. |
95 | 4250 The type isn't changed, it's not necessarily a String. |
7 | 4251 |
87 | 4252 *max()* |
4253 max({list}) Return the maximum value of all items in {list}. | |
4254 If {list} is not a list or one of the items in {list} cannot | |
4255 be used as a Number this results in an error. | |
685 | 4256 An empty |List| results in zero. |
87 | 4257 |
4258 *min()* | |
1215 | 4259 min({list}) Return the minimum value of all items in {list}. |
87 | 4260 If {list} is not a list or one of the items in {list} cannot |
4261 be used as a Number this results in an error. | |
685 | 4262 An empty |List| results in zero. |
87 | 4263 |
843 | 4264 *mkdir()* *E739* |
168 | 4265 mkdir({name} [, {path} [, {prot}]]) |
4266 Create directory {name}. | |
4267 If {path} is "p" then intermediate directories are created as | |
4268 necessary. Otherwise it must be "". | |
4269 If {prot} is given it is used to set the protection bits of | |
4270 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 4271 the user readable for others). Use 0700 to make it unreadable |
1702 | 4272 for others. This is only used for the last part of {name}. |
4273 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
4274 with 0755. | |
4275 Example: > | |
4276 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
4277 < This function is not available in the |sandbox|. | |
168 | 4278 Not available on all systems. To check use: > |
4279 :if exists("*mkdir") | |
4280 < | |
7 | 4281 *mode()* |
1621 | 4282 mode([expr]) Return a string that indicates the current mode. |
1661 | 4283 If [expr] is supplied and it evaluates to a non-zero Number or |
4284 a non-empty String (|non-zero-arg|), then the full mode is | |
4285 returned, otherwise only the first letter is returned. Note | |
4286 that " " and "0" are also non-empty strings. | |
1621 | 4287 |
7 | 4288 n Normal |
1621 | 4289 no Operator-pending |
7 | 4290 v Visual by character |
4291 V Visual by line | |
4292 CTRL-V Visual blockwise | |
4293 s Select by character | |
4294 S Select by line | |
4295 CTRL-S Select blockwise | |
4296 i Insert | |
1621 | 4297 R Replace |R| |
4298 Rv Virtual Replace |gR| | |
7 | 4299 c Command-line |
1621 | 4300 cv Vim Ex mode |gQ| |
4301 ce Normal Ex mode |Q| | |
7 | 4302 r Hit-enter prompt |
1621 | 4303 rm The -- more -- prompt |
4304 r? A |:confirm| query of some sort | |
4305 ! Shell or external command is executing | |
4306 This is useful in the 'statusline' option or when used | |
4307 with |remote_expr()| In most other places it always returns | |
4308 "c" or "n". | |
4309 Also see |visualmode()|. | |
7 | 4310 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4311 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4312 Evaluate MzScheme expression {expr} and return its result |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4313 convert to Vim data structures. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4314 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4315 Pairs (including lists and improper lists) and vectors are |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4316 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4317 Hash tables are represented as Vim |Dictionary| type with keys |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4318 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4319 All other types are converted to string with display function. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4320 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4321 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4322 :mz (define h (make-hash)) (hash-set! h "list" l) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4323 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4324 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4325 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4326 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4327 |
7 | 4328 nextnonblank({lnum}) *nextnonblank()* |
4329 Return the line number of the first line at or below {lnum} | |
4330 that is not blank. Example: > | |
4331 if getline(nextnonblank(1)) =~ "Java" | |
4332 < When {lnum} is invalid or there is no non-blank line at or | |
4333 below it, zero is returned. | |
4334 See also |prevnonblank()|. | |
4335 | |
4336 nr2char({expr}) *nr2char()* | |
4337 Return a string with a single character, which has the number | |
4338 value {expr}. Examples: > | |
4339 nr2char(64) returns "@" | |
4340 nr2char(32) returns " " | |
4341 < The current 'encoding' is used. Example for "utf-8": > | |
4342 nr2char(300) returns I with bow character | |
4343 < Note that a NUL character in the file is specified with | |
4344 nr2char(10), because NULs are represented with newline | |
4345 characters. nr2char(0) is a real NUL and terminates the | |
119 | 4346 string, thus results in an empty string. |
7 | 4347 |
1548 | 4348 *getpid()* |
4349 getpid() Return a Number which is the process ID of the Vim process. | |
1621 | 4350 On Unix and MS-Windows this is a unique number, until Vim |
4351 exits. On MS-DOS it's always zero. | |
1548 | 4352 |
703 | 4353 *getpos()* |
707 | 4354 getpos({expr}) Get the position for {expr}. For possible values of {expr} |
4355 see |line()|. | |
4356 The result is a |List| with four numbers: | |
4357 [bufnum, lnum, col, off] | |
4358 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
4359 is the buffer number of the mark. | |
4360 "lnum" and "col" are the position in the buffer. The first | |
4361 column is 1. | |
703 | 4362 The "off" number is zero, unless 'virtualedit' is used. Then |
4363 it is the offset in screen columns from the start of the | |
1266 | 4364 character. E.g., a position within a <Tab> or after the last |
703 | 4365 character. |
4366 This can be used to save and restore the cursor position: > | |
4367 let save_cursor = getpos(".") | |
4368 MoveTheCursorAround | |
798 | 4369 call setpos('.', save_cursor) |
707 | 4370 < Also see |setpos()|. |
703 | 4371 |
3214 | 4372 or({expr}, {expr}) *or()* |
4373 Bitwise OR on the two arguments. The arguments are converted | |
4374 to a number. A List, Dict or Float argument causes an error. | |
4375 Example: > | |
4376 :let bits = or(bits, 0x80) | |
4377 | |
4378 | |
819 | 4379 pathshorten({expr}) *pathshorten()* |
4380 Shorten directory names in the path {expr} and return the | |
4381 result. The tail, the file name, is kept as-is. The other | |
4382 components in the path are reduced to single letters. Leading | |
4383 '~' and '.' characters are kept. Example: > | |
4384 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
4385 < ~/.v/a/myfile.vim ~ | |
4386 It doesn't matter if the path exists or not. | |
4387 | |
1621 | 4388 pow({x}, {y}) *pow()* |
4389 Return the power of {x} to the exponent {y} as a |Float|. | |
4390 {x} and {y} must evaluate to a |Float| or a |Number|. | |
4391 Examples: > | |
4392 :echo pow(3, 3) | |
4393 < 27.0 > | |
4394 :echo pow(2, 16) | |
4395 < 65536.0 > | |
4396 :echo pow(32, 0.20) | |
4397 < 2.0 | |
4398 {only available when compiled with the |+float| feature} | |
4399 | |
667 | 4400 prevnonblank({lnum}) *prevnonblank()* |
4401 Return the line number of the first line at or above {lnum} | |
4402 that is not blank. Example: > | |
4403 let ind = indent(prevnonblank(v:lnum - 1)) | |
4404 < When {lnum} is invalid or there is no non-blank line at or | |
4405 above it, zero is returned. | |
4406 Also see |nextnonblank()|. | |
4407 | |
4408 | |
449 | 4409 printf({fmt}, {expr1} ...) *printf()* |
4410 Return a String with {fmt}, where "%" items are replaced by | |
4411 the formatted form of their respective arguments. Example: > | |
452 | 4412 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 4413 < May result in: |
452 | 4414 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 4415 |
4416 Often used items are: | |
856 | 4417 %s string |
653 | 4418 %6s string right-aligned in 6 bytes |
1621 | 4419 %.9s string truncated to 9 bytes |
4420 %c single byte | |
4421 %d decimal number | |
4422 %5d decimal number padded with spaces to 5 characters | |
4423 %x hex number | |
4424 %04x hex number padded with zeros to at least 4 characters | |
4425 %X hex number using upper case letters | |
4426 %o octal number | |
4427 %f floating point number in the form 123.456 | |
4428 %e floating point number in the form 1.234e3 | |
4429 %E floating point number in the form 1.234E3 | |
4430 %g floating point number, as %f or %e depending on value | |
4431 %G floating point number, as %f or %E depending on value | |
4432 %% the % character itself | |
449 | 4433 |
4434 Conversion specifications start with '%' and end with the | |
4435 conversion type. All other characters are copied unchanged to | |
4436 the result. | |
4437 | |
4438 The "%" starts a conversion specification. The following | |
452 | 4439 arguments appear in sequence: |
4440 | |
4441 % [flags] [field-width] [.precision] type | |
4442 | |
856 | 4443 flags |
452 | 4444 Zero or more of the following flags: |
4445 | |
449 | 4446 # The value should be converted to an "alternate |
4447 form". For c, d, and s conversions, this option | |
4448 has no effect. For o conversions, the precision | |
4449 of the number is increased to force the first | |
4450 character of the output string to a zero (except | |
4451 if a zero value is printed with an explicit | |
4452 precision of zero). | |
4453 For x and X conversions, a non-zero result has | |
4454 the string "0x" (or "0X" for X conversions) | |
4455 prepended to it. | |
452 | 4456 |
449 | 4457 0 (zero) Zero padding. For all conversions the converted |
4458 value is padded on the left with zeros rather | |
4459 than blanks. If a precision is given with a | |
4460 numeric conversion (d, o, x, and X), the 0 flag | |
4461 is ignored. | |
452 | 4462 |
449 | 4463 - A negative field width flag; the converted value |
4464 is to be left adjusted on the field boundary. | |
4465 The converted value is padded on the right with | |
4466 blanks, rather than on the left with blanks or | |
4467 zeros. A - overrides a 0 if both are given. | |
452 | 4468 |
449 | 4469 ' ' (space) A blank should be left before a positive |
4470 number produced by a signed conversion (d). | |
452 | 4471 |
449 | 4472 + A sign must always be placed before a number |
1621 | 4473 produced by a signed conversion. A + overrides |
449 | 4474 a space if both are used. |
452 | 4475 |
4476 field-width | |
4477 An optional decimal digit string specifying a minimum | |
653 | 4478 field width. If the converted value has fewer bytes |
4479 than the field width, it will be padded with spaces on | |
4480 the left (or right, if the left-adjustment flag has | |
4481 been given) to fill out the field width. | |
452 | 4482 |
4483 .precision | |
4484 An optional precision, in the form of a period '.' | |
4485 followed by an optional digit string. If the digit | |
4486 string is omitted, the precision is taken as zero. | |
4487 This gives the minimum number of digits to appear for | |
4488 d, o, x, and X conversions, or the maximum number of | |
653 | 4489 bytes to be printed from a string for s conversions. |
1621 | 4490 For floating point it is the number of digits after |
4491 the decimal point. | |
452 | 4492 |
4493 type | |
4494 A character that specifies the type of conversion to | |
4495 be applied, see below. | |
4496 | |
449 | 4497 A field width or precision, or both, may be indicated by an |
4498 asterisk '*' instead of a digit string. In this case, a | |
1621 | 4499 Number argument supplies the field width or precision. A |
449 | 4500 negative field width is treated as a left adjustment flag |
4501 followed by a positive field width; a negative precision is | |
4502 treated as though it were missing. Example: > | |
452 | 4503 :echo printf("%d: %.*s", nr, width, line) |
449 | 4504 < This limits the length of the text used from "line" to |
452 | 4505 "width" bytes. |
449 | 4506 |
856 | 4507 The conversion specifiers and their meanings are: |
452 | 4508 |
1621 | 4509 *printf-d* *printf-o* *printf-x* *printf-X* |
4510 doxX The Number argument is converted to signed decimal | |
449 | 4511 (d), unsigned octal (o), or unsigned hexadecimal (x |
4512 and X) notation. The letters "abcdef" are used for | |
4513 x conversions; the letters "ABCDEF" are used for X | |
452 | 4514 conversions. |
4515 The precision, if any, gives the minimum number of | |
4516 digits that must appear; if the converted value | |
4517 requires fewer digits, it is padded on the left with | |
4518 zeros. | |
4519 In no case does a non-existent or small field width | |
4520 cause truncation of a numeric field; if the result of | |
4521 a conversion is wider than the field width, the field | |
4522 is expanded to contain the conversion result. | |
4523 | |
1621 | 4524 *printf-c* |
452 | 4525 c The Number argument is converted to a byte, and the |
4526 resulting character is written. | |
4527 | |
1621 | 4528 *printf-s* |
452 | 4529 s The text of the String argument is used. If a |
4530 precision is specified, no more bytes than the number | |
4531 specified are used. | |
4532 | |
1621 | 4533 *printf-f* *E807* |
4534 f The Float argument is converted into a string of the | |
4535 form 123.456. The precision specifies the number of | |
4536 digits after the decimal point. When the precision is | |
4537 zero the decimal point is omitted. When the precision | |
4538 is not specified 6 is used. A really big number | |
4539 (out of range or dividing by zero) results in "inf". | |
4540 "0.0 / 0.0" results in "nan". | |
4541 Example: > | |
4542 echo printf("%.2f", 12.115) | |
4543 < 12.12 | |
4544 Note that roundoff depends on the system libraries. | |
4545 Use |round()| when in doubt. | |
4546 | |
4547 *printf-e* *printf-E* | |
4548 e E The Float argument is converted into a string of the | |
4549 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
4550 precision specifies the number of digits after the | |
4551 decimal point, like with 'f'. | |
4552 | |
4553 *printf-g* *printf-G* | |
4554 g G The Float argument is converted like with 'f' if the | |
4555 value is between 0.001 (inclusive) and 10000000.0 | |
4556 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
4557 for 'G'. When no precision is specified superfluous | |
4558 zeroes and '+' signs are removed, except for the zero | |
4559 immediately after the decimal point. Thus 10000000.0 | |
4560 results in 1.0e7. | |
4561 | |
4562 *printf-%* | |
449 | 4563 % A '%' is written. No argument is converted. The |
4564 complete conversion specification is "%%". | |
452 | 4565 |
1668 | 4566 When a Number argument is expected a String argument is also |
4567 accepted and automatically converted. | |
4568 When a Float or String argument is expected a Number argument | |
4569 is also accepted and automatically converted. | |
4570 Any other argument type results in an error message. | |
449 | 4571 |
459 | 4572 *E766* *E767* |
449 | 4573 The number of {exprN} arguments must exactly match the number |
4574 of "%" items. If there are not sufficient or too many | |
452 | 4575 arguments an error is given. Up to 18 arguments can be used. |
449 | 4576 |
4577 | |
667 | 4578 pumvisible() *pumvisible()* |
4579 Returns non-zero when the popup menu is visible, zero | |
4580 otherwise. See |ins-completion-menu|. | |
712 | 4581 This can be used to avoid some things that would remove the |
4582 popup menu. | |
7 | 4583 |
114 | 4584 *E726* *E727* |
99 | 4585 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 4586 Returns a |List| with Numbers: |
99 | 4587 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
4588 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
4589 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
4590 {max}] (increasing {expr} with {stride} each time, not | |
4591 producing a value past {max}). | |
336 | 4592 When the maximum is one before the start the result is an |
4593 empty list. When the maximum is more than one before the | |
4594 start this is an error. | |
99 | 4595 Examples: > |
856 | 4596 range(4) " [0, 1, 2, 3] |
99 | 4597 range(2, 4) " [2, 3, 4] |
4598 range(2, 9, 3) " [2, 5, 8] | |
856 | 4599 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 4600 range(0) " [] |
4601 range(2, 0) " error! | |
99 | 4602 < |
158 | 4603 *readfile()* |
168 | 4604 readfile({fname} [, {binary} [, {max}]]) |
685 | 4605 Read file {fname} and return a |List|, each line of the file |
4606 as an item. Lines broken at NL characters. Macintosh files | |
158 | 4607 separated with CR will result in a single long line (unless a |
4608 NL appears somewhere). | |
2513
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
4609 All NUL characters are replaced with a NL character. |
158 | 4610 When {binary} is equal to "b" binary mode is used: |
4611 - When the last line ends in a NL an extra empty list item is | |
4612 added. | |
4613 - No CR characters are removed. | |
4614 Otherwise: | |
4615 - CR characters that appear before a NL are removed. | |
4616 - Whether the last line ends in a NL or not does not matter. | |
2513
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
4617 - When 'encoding' is Unicode any UTF-8 byte order mark is |
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
4618 removed from the text. |
168 | 4619 When {max} is given this specifies the maximum number of lines |
4620 to be read. Useful if you only want to check the first ten | |
4621 lines of a file: > | |
4622 :for line in readfile(fname, '', 10) | |
4623 : if line =~ 'Date' | echo line | endif | |
4624 :endfor | |
233 | 4625 < When {max} is negative -{max} lines from the end of the file |
4626 are returned, or as many as there are. | |
4627 When {max} is zero the result is an empty list. | |
168 | 4628 Note that without {max} the whole file is read into memory. |
4629 Also note that there is no recognition of encoding. Read a | |
4630 file into a buffer if you need to. | |
158 | 4631 When the file can't be opened an error message is given and |
4632 the result is an empty list. | |
4633 Also see |writefile()|. | |
4634 | |
794 | 4635 reltime([{start} [, {end}]]) *reltime()* |
4636 Return an item that represents a time value. The format of | |
4637 the item depends on the system. It can be passed to | |
4638 |reltimestr()| to convert it to a string. | |
4639 Without an argument it returns the current time. | |
4640 With one argument is returns the time passed since the time | |
4641 specified in the argument. | |
843 | 4642 With two arguments it returns the time passed between {start} |
794 | 4643 and {end}. |
4644 The {start} and {end} arguments must be values returned by | |
4645 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4646 {only available when compiled with the |+reltime| feature} |
794 | 4647 |
4648 reltimestr({time}) *reltimestr()* | |
4649 Return a String that represents the time value of {time}. | |
4650 This is the number of seconds, a dot and the number of | |
4651 microseconds. Example: > | |
4652 let start = reltime() | |
4653 call MyFunction() | |
4654 echo reltimestr(reltime(start)) | |
4655 < Note that overhead for the commands will be added to the time. | |
4656 The accuracy depends on the system. | |
1156 | 4657 Leading spaces are used to make the string align nicely. You |
4658 can use split() to remove it. > | |
4659 echo split(reltimestr(reltime(start)))[0] | |
4660 < Also see |profiling|. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4661 {only available when compiled with the |+reltime| feature} |
794 | 4662 |
7 | 4663 *remote_expr()* *E449* |
4664 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 4665 Send the {string} to {server}. The string is sent as an |
7 | 4666 expression and the result is returned after evaluation. |
714 | 4667 The result must be a String or a |List|. A |List| is turned |
4668 into a String by joining the items with a line break in | |
4669 between (not at the end), like with join(expr, "\n"). | |
7 | 4670 If {idvar} is present, it is taken as the name of a |
4671 variable and a {serverid} for later use with | |
4672 remote_read() is stored there. | |
4673 See also |clientserver| |RemoteReply|. | |
4674 This function is not available in the |sandbox|. | |
4675 {only available when compiled with the |+clientserver| feature} | |
4676 Note: Any errors will cause a local error message to be issued | |
4677 and the result will be the empty string. | |
4678 Examples: > | |
4679 :echo remote_expr("gvim", "2+2") | |
4680 :echo remote_expr("gvim1", "b:current_syntax") | |
4681 < | |
4682 | |
4683 remote_foreground({server}) *remote_foreground()* | |
4684 Move the Vim server with the name {server} to the foreground. | |
4685 This works like: > | |
4686 remote_expr({server}, "foreground()") | |
4687 < Except that on Win32 systems the client does the work, to work | |
4688 around the problem that the OS doesn't always allow the server | |
4689 to bring itself to the foreground. | |
574 | 4690 Note: This does not restore the window if it was minimized, |
4691 like foreground() does. | |
7 | 4692 This function is not available in the |sandbox|. |
4693 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
4694 Win32 console version} | |
4695 | |
4696 | |
4697 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
4698 Returns a positive number if there are available strings | |
4699 from {serverid}. Copies any reply string into the variable | |
1621 | 4700 {retvar} if specified. {retvar} must be a string with the |
7 | 4701 name of a variable. |
4702 Returns zero if none are available. | |
4703 Returns -1 if something is wrong. | |
4704 See also |clientserver|. | |
4705 This function is not available in the |sandbox|. | |
4706 {only available when compiled with the |+clientserver| feature} | |
4707 Examples: > | |
4708 :let repl = "" | |
4709 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
4710 | |
4711 remote_read({serverid}) *remote_read()* | |
4712 Return the oldest available reply from {serverid} and consume | |
4713 it. It blocks until a reply is available. | |
4714 See also |clientserver|. | |
4715 This function is not available in the |sandbox|. | |
4716 {only available when compiled with the |+clientserver| feature} | |
4717 Example: > | |
4718 :echo remote_read(id) | |
4719 < | |
4720 *remote_send()* *E241* | |
4721 remote_send({server}, {string} [, {idvar}]) | |
1621 | 4722 Send the {string} to {server}. The string is sent as input |
22 | 4723 keys and the function returns immediately. At the Vim server |
4724 the keys are not mapped |:map|. | |
667 | 4725 If {idvar} is present, it is taken as the name of a variable |
4726 and a {serverid} for later use with remote_read() is stored | |
4727 there. | |
7 | 4728 See also |clientserver| |RemoteReply|. |
4729 This function is not available in the |sandbox|. | |
4730 {only available when compiled with the |+clientserver| feature} | |
4731 Note: Any errors will be reported in the server and may mess | |
4732 up the display. | |
4733 Examples: > | |
4734 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
4735 \ remote_read(serverid) | |
4736 | |
4737 :autocmd NONE RemoteReply * | |
4738 \ echo remote_read(expand("<amatch>")) | |
4739 :echo remote_send("gvim", ":sleep 10 | echo ". | |
4740 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 4741 < |
79 | 4742 remove({list}, {idx} [, {end}]) *remove()* |
685 | 4743 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
|
4744 return the item. |
79 | 4745 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4746 return a List with these items. When {idx} points to the same |
79 | 4747 item as {end} a list with one item is returned. When {end} |
4748 points to an item before {idx} this is an error. | |
4749 See |list-index| for possible values of {idx} and {end}. | |
55 | 4750 Example: > |
4751 :echo "last item: " . remove(mylist, -1) | |
79 | 4752 :call remove(mylist, 0, 9) |
99 | 4753 remove({dict}, {key}) |
4754 Remove the entry from {dict} with key {key}. Example: > | |
4755 :echo "removed " . remove(dict, "one") | |
4756 < If there is no {key} in {dict} this is an error. | |
4757 | |
4758 Use |delete()| to remove a file. | |
55 | 4759 |
7 | 4760 rename({from}, {to}) *rename()* |
4761 Rename the file by the name {from} to the name {to}. This | |
4762 should also work to move files across file systems. The | |
4763 result is a Number, which is 0 if the file was renamed | |
4764 successfully, and non-zero when the renaming failed. | |
1851 | 4765 NOTE: If {to} exists it is overwritten without warning. |
7 | 4766 This function is not available in the |sandbox|. |
4767 | |
18 | 4768 repeat({expr}, {count}) *repeat()* |
4769 Repeat {expr} {count} times and return the concatenated | |
4770 result. Example: > | |
843 | 4771 :let separator = repeat('-', 80) |
18 | 4772 < When {count} is zero or negative the result is empty. |
685 | 4773 When {expr} is a |List| the result is {expr} concatenated |
1621 | 4774 {count} times. Example: > |
79 | 4775 :let longlist = repeat(['a', 'b'], 3) |
4776 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 4777 |
82 | 4778 |
7 | 4779 resolve({filename}) *resolve()* *E655* |
4780 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
4781 returns the path the shortcut points to in a simplified form. | |
4782 On Unix, repeat resolving symbolic links in all path | |
4783 components of {filename} and return the simplified result. | |
4784 To cope with link cycles, resolving of symbolic links is | |
4785 stopped after 100 iterations. | |
4786 On other systems, return the simplified {filename}. | |
4787 The simplification step is done as by |simplify()|. | |
4788 resolve() keeps a leading path component specifying the | |
4789 current directory (provided the result is still a relative | |
4790 path name) and also keeps a trailing path separator. | |
4791 | |
82 | 4792 *reverse()* |
1621 | 4793 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 4794 {list}. |
4795 If you want a list to remain unmodified make a copy first: > | |
4796 :let revlist = reverse(copy(mylist)) | |
4797 | |
1621 | 4798 round({expr}) *round()* |
1668 | 4799 Round off {expr} to the nearest integral value and return it |
1621 | 4800 as a |Float|. If {expr} lies halfway between two integral |
4801 values, then use the larger one (away from zero). | |
4802 {expr} must evaluate to a |Float| or a |Number|. | |
4803 Examples: > | |
4804 echo round(0.456) | |
4805 < 0.0 > | |
4806 echo round(4.5) | |
4807 < 5.0 > | |
4808 echo round(-4.5) | |
4809 < -5.0 | |
4810 {only available when compiled with the |+float| feature} | |
4811 | |
4812 | |
1496 | 4813 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 4814 Search for regexp pattern {pattern}. The search starts at the |
119 | 4815 cursor position (you can use |cursor()| to set it). |
707 | 4816 |
7 | 4817 {flags} is a String, which can contain these character flags: |
4818 'b' search backward instead of forward | |
1621 | 4819 'c' accept a match at the cursor position |
712 | 4820 'e' move to the End of the match |
20 | 4821 'n' do Not move the cursor |
712 | 4822 'p' return number of matching sub-pattern (see below) |
4823 's' set the ' mark at the previous location of the cursor | |
7 | 4824 'w' wrap around the end of the file |
4825 'W' don't wrap around the end of the file | |
4826 If neither 'w' or 'W' is given, the 'wrapscan' option applies. | |
4827 | |
444 | 4828 If the 's' flag is supplied, the ' mark is set, only if the |
4829 cursor is moved. The 's' flag cannot be combined with the 'n' | |
4830 flag. | |
4831 | |
1156 | 4832 'ignorecase', 'smartcase' and 'magic' are used. |
4833 | |
692 | 4834 When the {stopline} argument is given then the search stops |
4835 after searching this line. This is useful to restrict the | |
4836 search to a range of lines. Examples: > | |
4837 let match = search('(', 'b', line("w0")) | |
4838 let end = search('END', '', line("w$")) | |
4839 < When {stopline} is used and it is not zero this also implies | |
4840 that the search does not wrap around the end of the file. | |
1496 | 4841 A zero value is equal to not giving the argument. |
4842 | |
4843 When the {timeout} argument is given the search stops when | |
1621 | 4844 more than this many milli seconds have passed. Thus when |
1496 | 4845 {timeout} is 500 the search stops after half a second. |
4846 The value must not be negative. A zero value is like not | |
4847 giving the argument. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4848 {only available when compiled with the |+reltime| feature} |
692 | 4849 |
712 | 4850 If there is no match a 0 is returned and the cursor doesn't |
4851 move. No error message is given. | |
714 | 4852 When a match has been found its line number is returned. |
4853 *search()-sub-match* | |
4854 With the 'p' flag the returned value is one more than the | |
4855 first sub-match in \(\). One if none of them matched but the | |
4856 whole pattern did match. | |
712 | 4857 To get the column number too use |searchpos()|. |
4858 | |
20 | 4859 The cursor will be positioned at the match, unless the 'n' |
707 | 4860 flag is used. |
7 | 4861 |
4862 Example (goes over all files in the argument list): > | |
4863 :let n = 1 | |
4864 :while n <= argc() " loop over all files in arglist | |
4865 : exe "argument " . n | |
4866 : " start at the last char in the file and wrap for the | |
4867 : " first search to find match at start of file | |
4868 : normal G$ | |
4869 : let flags = "w" | |
4870 : while search("foo", flags) > 0 | |
1621 | 4871 : s/foo/bar/g |
7 | 4872 : let flags = "W" |
4873 : endwhile | |
4874 : update " write the file if modified | |
4875 : let n = n + 1 | |
4876 :endwhile | |
4877 < | |
712 | 4878 Example for using some flags: > |
4879 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
4880 < This will search for the keywords "if", "else", and "endif" | |
4881 under or after the cursor. Because of the 'p' flag, it | |
4882 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
4883 if the search fails. With the cursor on the first word of the | |
4884 line: | |
4885 if (foo == 0) | let foo = foo + 1 | endif ~ | |
4886 the function returns 1. Without the 'c' flag, the function | |
4887 finds the "endif" and returns 3. The same thing happens | |
4888 without the 'e' flag if the cursor is on the "f" of "if". | |
4889 The 'n' flag tells the function not to move the cursor. | |
4890 | |
504 | 4891 |
523 | 4892 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
4893 Search for the declaration of {name}. | |
856 | 4894 |
523 | 4895 With a non-zero {global} argument it works like |gD|, find |
4896 first match in the file. Otherwise it works like |gd|, find | |
4897 first match in the function. | |
4898 | |
4899 With a non-zero {thisblock} argument matches in a {} block | |
4900 that ends before the cursor position are ignored. Avoids | |
4901 finding variable declarations only valid in another scope. | |
4902 | |
504 | 4903 Moves the cursor to the found match. |
4904 Returns zero for success, non-zero for failure. | |
4905 Example: > | |
4906 if searchdecl('myvar') == 0 | |
4907 echo getline('.') | |
4908 endif | |
4909 < | |
7 | 4910 *searchpair()* |
1496 | 4911 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
4912 [, {stopline} [, {timeout}]]]]) | |
7 | 4913 Search for the match of a nested start-end pair. This can be |
4914 used to find the "endif" that matches an "if", while other | |
4915 if/endif pairs in between are ignored. | |
677 | 4916 The search starts at the cursor. The default is to search |
4917 forward, include 'b' in {flags} to search backward. | |
4918 If a match is found, the cursor is positioned at it and the | |
4919 line number is returned. If no match is found 0 or -1 is | |
4920 returned and the cursor doesn't move. No error message is | |
4921 given. | |
7 | 4922 |
4923 {start}, {middle} and {end} are patterns, see |pattern|. They | |
4924 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
4925 {middle} is not empty, it is found when searching from either | |
4926 direction, but only when not in a nested start-end pair. A | |
4927 typical use is: > | |
4928 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
4929 < By leaving {middle} empty the "else" is skipped. | |
4930 | |
712 | 4931 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
4932 |search()|. Additionally: | |
7 | 4933 'r' Repeat until no more matches found; will find the |
1621 | 4934 outer pair. Implies the 'W' flag. |
4935 'm' Return number of matches instead of line number with | |
712 | 4936 the match; will be > 1 when 'r' is used. |
1621 | 4937 Note: it's nearly always a good idea to use the 'W' flag, to |
4938 avoid wrapping around the end of the file. | |
7 | 4939 |
4940 When a match for {start}, {middle} or {end} is found, the | |
4941 {skip} expression is evaluated with the cursor positioned on | |
4942 the start of the match. It should return non-zero if this | |
4943 match is to be skipped. E.g., because it is inside a comment | |
4944 or a string. | |
4945 When {skip} is omitted or empty, every match is accepted. | |
4946 When evaluating {skip} causes an error the search is aborted | |
4947 and -1 returned. | |
4948 | |
1496 | 4949 For {stopline} and {timeout} see |search()|. |
692 | 4950 |
7 | 4951 The value of 'ignorecase' is used. 'magic' is ignored, the |
4952 patterns are used like it's on. | |
4953 | |
4954 The search starts exactly at the cursor. A match with | |
4955 {start}, {middle} or {end} at the next character, in the | |
4956 direction of searching, is the first one found. Example: > | |
4957 if 1 | |
4958 if 2 | |
4959 endif 2 | |
4960 endif 1 | |
4961 < When starting at the "if 2", with the cursor on the "i", and | |
4962 searching forwards, the "endif 2" is found. When starting on | |
4963 the character just before the "if 2", the "endif 1" will be | |
1621 | 4964 found. That's because the "if 2" will be found first, and |
7 | 4965 then this is considered to be a nested if/endif from "if 2" to |
4966 "endif 2". | |
4967 When searching backwards and {end} is more than one character, | |
4968 it may be useful to put "\zs" at the end of the pattern, so | |
4969 that when the cursor is inside a match with the end it finds | |
4970 the matching start. | |
4971 | |
4972 Example, to find the "endif" command in a Vim script: > | |
4973 | |
4974 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
4975 \ 'getline(".") =~ "^\\s*\""') | |
4976 | |
4977 < The cursor must be at or after the "if" for which a match is | |
4978 to be found. Note that single-quote strings are used to avoid | |
4979 having to double the backslashes. The skip expression only | |
4980 catches comments at the start of a line, not after a command. | |
4981 Also, a word "en" or "if" halfway a line is considered a | |
4982 match. | |
4983 Another example, to search for the matching "{" of a "}": > | |
4984 | |
4985 :echo searchpair('{', '', '}', 'bW') | |
4986 | |
4987 < This works when the cursor is at or before the "}" for which a | |
4988 match is to be found. To reject matches that syntax | |
4989 highlighting recognized as strings: > | |
4990 | |
4991 :echo searchpair('{', '', '}', 'bW', | |
4992 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
4993 < | |
667 | 4994 *searchpairpos()* |
1496 | 4995 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
4996 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4997 Same as |searchpair()|, but returns a |List| with the line and |
685 | 4998 column position of the match. The first element of the |List| |
4999 is the line number and the second element is the byte index of | |
667 | 5000 the column position of the match. If no match is found, |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5001 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5002 |
667 | 5003 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
5004 < | |
5005 See |match-parens| for a bigger and more useful example. | |
5006 | |
1496 | 5007 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 5008 Same as |search()|, but returns a |List| with the line and |
685 | 5009 column position of the match. The first element of the |List| |
5010 is the line number and the second element is the byte index of | |
5011 the column position of the match. If no match is found, | |
5012 returns [0, 0]. | |
714 | 5013 Example: > |
5014 :let [lnum, col] = searchpos('mypattern', 'n') | |
5015 | |
5016 < When the 'p' flag is given then there is an extra item with | |
5017 the sub-pattern match number |search()-sub-match|. Example: > | |
5018 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
5019 < In this example "submatch" is 2 when a lowercase letter is | |
5020 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
5021 | |
7 | 5022 server2client( {clientid}, {string}) *server2client()* |
5023 Send a reply string to {clientid}. The most recent {clientid} | |
5024 that sent a string can be retrieved with expand("<client>"). | |
5025 {only available when compiled with the |+clientserver| feature} | |
5026 Note: | |
5027 This id has to be stored before the next command can be | |
236 | 5028 received. I.e. before returning from the received command and |
7 | 5029 before calling any commands that waits for input. |
5030 See also |clientserver|. | |
5031 Example: > | |
5032 :echo server2client(expand("<client>"), "HELLO") | |
5033 < | |
5034 serverlist() *serverlist()* | |
5035 Return a list of available server names, one per line. | |
5036 When there are no servers or the information is not available | |
5037 an empty string is returned. See also |clientserver|. | |
5038 {only available when compiled with the |+clientserver| feature} | |
5039 Example: > | |
5040 :echo serverlist() | |
5041 < | |
5042 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
5043 Set option or local variable {varname} in buffer {expr} to | |
5044 {val}. | |
5045 This also works for a global or local window option, but it | |
5046 doesn't work for a global or local window variable. | |
5047 For a local window option the global value is unchanged. | |
5048 For the use of {expr}, see |bufname()| above. | |
5049 Note that the variable name without "b:" must be used. | |
5050 Examples: > | |
5051 :call setbufvar(1, "&mod", 1) | |
5052 :call setbufvar("todo", "myvar", "foobar") | |
5053 < This function is not available in the |sandbox|. | |
5054 | |
5055 setcmdpos({pos}) *setcmdpos()* | |
5056 Set the cursor position in the command line to byte position | |
1621 | 5057 {pos}. The first position is 1. |
7 | 5058 Use |getcmdpos()| to obtain the current position. |
5059 Only works while editing the command line, thus you must use | |
99 | 5060 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
5061 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
5062 set after the command line is set to the expression. For | |
5063 |c_CTRL-R_=| it is set after evaluating the expression but | |
5064 before inserting the resulting text. | |
7 | 5065 When the number is too big the cursor is put at the end of the |
5066 line. A number smaller than one has undefined results. | |
5067 Returns 0 when successful, 1 when not editing the command | |
5068 line. | |
5069 | |
1621 | 5070 setline({lnum}, {text}) *setline()* |
5071 Set line {lnum} of the current buffer to {text}. | |
236 | 5072 {lnum} is used like with |getline()|. |
1621 | 5073 When {lnum} is just below the last line the {text} will be |
282 | 5074 added as a new line. |
236 | 5075 If this succeeds, 0 is returned. If this fails (most likely |
5076 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 5077 :call setline(5, strftime("%c")) |
1621 | 5078 < When {text} is a |List| then line {lnum} and following lines |
282 | 5079 will be set to the items in the list. Example: > |
5080 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
5081 < This is equivalent to: > | |
5082 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']] | |
5083 : call setline(n, l) | |
5084 :endfor | |
7 | 5085 < Note: The '[ and '] marks are not set. |
5086 | |
647 | 5087 setloclist({nr}, {list} [, {action}]) *setloclist()* |
5088 Create or replace or add to the location list for window {nr}. | |
5089 When {nr} is zero the current window is used. For a location | |
648 | 5090 list window, the displayed location list is modified. For an |
5091 invalid window number {nr}, -1 is returned. | |
1326 | 5092 Otherwise, same as |setqflist()|. |
5093 Also see |location-list|. | |
5094 | |
5095 setmatches({list}) *setmatches()* | |
5096 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 5097 if successful, otherwise -1. All current matches are cleared |
1326 | 5098 before the list is restored. See example for |getmatches()|. |
230 | 5099 |
707 | 5100 *setpos()* |
5101 setpos({expr}, {list}) | |
5102 Set the position for {expr}. Possible values: | |
5103 . the cursor | |
5104 'x mark x | |
5105 | |
5106 {list} must be a |List| with four numbers: | |
5107 [bufnum, lnum, col, off] | |
5108 | |
1621 | 5109 "bufnum" is the buffer number. Zero can be used for the |
856 | 5110 current buffer. Setting the cursor is only possible for |
707 | 5111 the current buffer. To set a mark in another buffer you can |
5112 use the |bufnr()| function to turn a file name into a buffer | |
5113 number. | |
798 | 5114 Does not change the jumplist. |
707 | 5115 |
5116 "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
|
5117 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
|
5118 smaller than 1 then 1 is used. |
707 | 5119 |
5120 The "off" number is only used when 'virtualedit' is set. Then | |
5121 it is the offset in screen columns from the start of the | |
1266 | 5122 character. E.g., a position within a <Tab> or after the last |
707 | 5123 character. |
5124 | |
1533 | 5125 Returns 0 when the position could be set, -1 otherwise. |
5126 An error message is given if {expr} is invalid. | |
5127 | |
707 | 5128 Also see |getpos()| |
5129 | |
1156 | 5130 This does not restore the preferred column for moving |
5131 vertically. See |winrestview()| for that. | |
5132 | |
707 | 5133 |
277 | 5134 setqflist({list} [, {action}]) *setqflist()* |
647 | 5135 Create or replace or add to the quickfix list using the items |
5136 in {list}. Each item in {list} is a dictionary. | |
5137 Non-dictionary items in {list} are ignored. Each dictionary | |
5138 item can contain the following entries: | |
230 | 5139 |
1065 | 5140 bufnr buffer number; must be the number of a valid |
1621 | 5141 buffer |
1065 | 5142 filename name of a file; only used when "bufnr" is not |
1621 | 5143 present or it is invalid. |
230 | 5144 lnum line number in the file |
233 | 5145 pattern search pattern used to locate the error |
230 | 5146 col column number |
233 | 5147 vcol when non-zero: "col" is visual column |
856 | 5148 when zero: "col" is byte index |
233 | 5149 nr error number |
230 | 5150 text description of the error |
233 | 5151 type single-character error type, 'E', 'W', etc. |
5152 | |
5153 The "col", "vcol", "nr", "type" and "text" entries are | |
5154 optional. Either "lnum" or "pattern" entry can be used to | |
5155 locate a matching error line. | |
1065 | 5156 If the "filename" and "bufnr" entries are not present or |
5157 neither the "lnum" or "pattern" entries are present, then the | |
5158 item will not be handled as an error line. | |
230 | 5159 If both "pattern" and "lnum" are present then "pattern" will |
5160 be used. | |
2152 | 5161 If you supply an empty {list}, the quickfix list will be |
5162 cleared. | |
1065 | 5163 Note that the list is not exactly the same as what |
5164 |getqflist()| returns. | |
230 | 5165 |
277 | 5166 If {action} is set to 'a', then the items from {list} are |
5167 added to the existing quickfix list. If there is no existing | |
5168 list, then a new list is created. If {action} is set to 'r', | |
5169 then the items from the current quickfix list are replaced | |
5170 with the items from {list}. If {action} is not present or is | |
5171 set to ' ', then a new list is created. | |
5172 | |
230 | 5173 Returns zero for success, -1 for failure. |
5174 | |
5175 This function can be used to create a quickfix list | |
5176 independent of the 'errorformat' setting. Use a command like | |
5177 ":cc 1" to jump to the first position. | |
5178 | |
5179 | |
7 | 5180 *setreg()* |
5181 setreg({regname}, {value} [,{options}]) | |
5182 Set the register {regname} to {value}. | |
5183 If {options} contains "a" or {regname} is upper case, | |
5184 then the value is appended. | |
2423 | 5185 {options} can also contain a register type specification: |
7 | 5186 "c" or "v" |characterwise| mode |
5187 "l" or "V" |linewise| mode | |
5188 "b" or "<CTRL-V>" |blockwise-visual| mode | |
5189 If a number immediately follows "b" or "<CTRL-V>" then this is | |
5190 used as the width of the selection - if it is not specified | |
5191 then the width of the block is set to the number of characters | |
1266 | 5192 in the longest line (counting a <Tab> as 1 character). |
7 | 5193 |
5194 If {options} contains no register settings, then the default | |
5195 is to use character mode unless {value} ends in a <NL>. | |
5196 Setting the '=' register is not possible. | |
5197 Returns zero for success, non-zero for failure. | |
5198 | |
5199 Examples: > | |
5200 :call setreg(v:register, @*) | |
5201 :call setreg('*', @%, 'ac') | |
5202 :call setreg('a', "1\n2\n3", 'b5') | |
5203 | |
5204 < This example shows using the functions to save and restore a | |
5205 register. > | |
282 | 5206 :let var_a = getreg('a', 1) |
7 | 5207 :let var_amode = getregtype('a') |
5208 .... | |
5209 :call setreg('a', var_a, var_amode) | |
5210 | |
5211 < You can also change the type of a register by appending | |
5212 nothing: > | |
5213 :call setreg('a', '', 'al') | |
5214 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5215 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5216 Set tab-local variable {varname} to {val} in tab page {tabnr}. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5217 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5218 Note that the variable name without "t:" must be used. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5219 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5220 Vim briefly goes to the tab page {tabnr}, this may trigger |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5221 TabLeave and TabEnter autocommands. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5222 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5223 |
831 | 5224 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
5225 Set option or local variable {varname} in window {winnr} to | |
5226 {val}. | |
5227 Tabs are numbered starting with one. For the current tabpage | |
5228 use |setwinvar()|. | |
5229 When {winnr} is zero the current window is used. | |
7 | 5230 This also works for a global or local buffer option, but it |
5231 doesn't work for a global or local buffer variable. | |
5232 For a local buffer option the global value is unchanged. | |
5233 Note that the variable name without "w:" must be used. | |
831 | 5234 Vim briefly goes to the tab page {tabnr}, this may trigger |
5235 TabLeave and TabEnter autocommands. | |
5236 Examples: > | |
5237 :call settabwinvar(1, 1, "&list", 0) | |
5238 :call settabwinvar(3, 2, "myvar", "foobar") | |
5239 < This function is not available in the |sandbox|. | |
5240 | |
5241 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
5242 Like |settabwinvar()| for the current tab page. | |
7 | 5243 Examples: > |
5244 :call setwinvar(1, "&list", 0) | |
5245 :call setwinvar(2, "myvar", "foobar") | |
5246 | |
1661 | 5247 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5248 Escape {string} for use as a shell command argument. |
985 | 5249 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 5250 will enclose {string} in double quotes and double all double |
985 | 5251 quotes within {string}. |
5252 For other systems, it will enclose {string} in single quotes | |
5253 and replace all "'" with "'\''". | |
1661 | 5254 When the {special} argument is present and it's a non-zero |
5255 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 5256 items such as "!", "%", "#" and "<cword>" will be preceded by |
5257 a backslash. This backslash will be removed again by the |:!| | |
1661 | 5258 command. |
1698 | 5259 The "!" character will be escaped (again with a |non-zero-arg| |
5260 {special}) when 'shell' contains "csh" in the tail. That is | |
5261 because for csh and tcsh "!" is used for history replacement | |
5262 even when inside single quotes. | |
5263 The <NL> character is also escaped. With a |non-zero-arg| | |
5264 {special} and 'shell' containing "csh" in the tail it's | |
5265 escaped a second time. | |
1661 | 5266 Example of use with a |:!| command: > |
5267 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
5268 < This results in a directory listing for the file under the | |
5269 cursor. Example of use with |system()|: > | |
5270 :call system("chmod +w -- " . shellescape(expand("%"))) | |
985 | 5271 |
5272 | |
7 | 5273 simplify({filename}) *simplify()* |
5274 Simplify the file name as much as possible without changing | |
5275 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
5276 Unix) are not resolved. If the first path component in | |
5277 {filename} designates the current directory, this will be | |
5278 valid for the result as well. A trailing path separator is | |
5279 not removed either. | |
5280 Example: > | |
5281 simplify("./dir/.././/file/") == "./file/" | |
5282 < Note: The combination "dir/.." is only removed if "dir" is | |
5283 a searchable directory or does not exist. On Unix, it is also | |
5284 removed when "dir" is a symbolic link within the same | |
5285 directory. In order to resolve all the involved symbolic | |
5286 links before simplifying the path name, use |resolve()|. | |
5287 | |
82 | 5288 |
1621 | 5289 sin({expr}) *sin()* |
5290 Return the sine of {expr}, measured in radians, as a |Float|. | |
5291 {expr} must evaluate to a |Float| or a |Number|. | |
5292 Examples: > | |
5293 :echo sin(100) | |
5294 < -0.506366 > | |
5295 :echo sin(-4.01) | |
5296 < 0.763301 | |
5297 {only available when compiled with the |+float| feature} | |
5298 | |
5299 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5300 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5301 Return the hyperbolic sine of {expr} as a |Float| in the range |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5302 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5303 {expr} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5304 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5305 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5306 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5307 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5308 < -1.026517 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5309 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5310 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5311 |
2902 | 5312 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
82 | 5313 Sort the items in {list} in-place. Returns {list}. If you |
5314 want a list to remain unmodified make a copy first: > | |
5315 :let sortedlist = sort(copy(mylist)) | |
5316 < Uses the string representation of each item to sort on. | |
692 | 5317 Numbers sort after Strings, |Lists| after Numbers. |
282 | 5318 For sorting text in the current buffer use |:sort|. |
82 | 5319 When {func} is given and it is one then case is ignored. |
2902 | 5320 {dict} is for functions with the "dict" attribute. It will be |
5321 used to set the local variable "self". |Dictionary-function| | |
685 | 5322 When {func} is a |Funcref| or a function name, this function |
5323 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
|
5324 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
|
5325 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
|
5326 smaller if the first one sorts before the second one. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5327 Example: > |
82 | 5328 func MyCompare(i1, i2) |
5329 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
5330 endfunc | |
5331 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5332 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5333 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5334 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5335 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5336 endfunc |
344 | 5337 < |
374 | 5338 *soundfold()* |
5339 soundfold({word}) | |
5340 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 5341 language in 'spelllang' for the current window that supports |
375 | 5342 soundfolding. 'spell' must be set. When no sound folding is |
5343 possible the {word} is returned unmodified. | |
374 | 5344 This can be used for making spelling suggestions. Note that |
5345 the method can be quite slow. | |
5346 | |
344 | 5347 *spellbadword()* |
532 | 5348 spellbadword([{sentence}]) |
5349 Without argument: The result is the badly spelled word under | |
5350 or after the cursor. The cursor is moved to the start of the | |
5351 bad word. When no bad word is found in the cursor line the | |
5352 result is an empty string and the cursor doesn't move. | |
5353 | |
5354 With argument: The result is the first word in {sentence} that | |
5355 is badly spelled. If there are no spelling mistakes the | |
5356 result is an empty string. | |
5357 | |
5358 The return value is a list with two items: | |
5359 - The badly spelled word or an empty string. | |
5360 - The type of the spelling error: | |
856 | 5361 "bad" spelling mistake |
532 | 5362 "rare" rare word |
5363 "local" word only valid in another region | |
5364 "caps" word should start with Capital | |
5365 Example: > | |
5366 echo spellbadword("the quik brown fox") | |
5367 < ['quik', 'bad'] ~ | |
5368 | |
5369 The spelling information for the current window is used. The | |
5370 'spell' option must be set and the value of 'spelllang' is | |
5371 used. | |
344 | 5372 |
5373 *spellsuggest()* | |
537 | 5374 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 5375 Return a |List| with spelling suggestions to replace {word}. |
344 | 5376 When {max} is given up to this number of suggestions are |
5377 returned. Otherwise up to 25 suggestions are returned. | |
5378 | |
537 | 5379 When the {capital} argument is given and it's non-zero only |
5380 suggestions with a leading capital will be given. Use this | |
5381 after a match with 'spellcapcheck'. | |
5382 | |
344 | 5383 {word} can be a badly spelled word followed by other text. |
5384 This allows for joining two words that were split. The | |
359 | 5385 suggestions also include the following text, thus you can |
5386 replace a line. | |
5387 | |
5388 {word} may also be a good word. Similar words will then be | |
537 | 5389 returned. {word} itself is not included in the suggestions, |
5390 although it may appear capitalized. | |
344 | 5391 |
5392 The spelling information for the current window is used. The | |
375 | 5393 'spell' option must be set and the values of 'spelllang' and |
5394 'spellsuggest' are used. | |
344 | 5395 |
82 | 5396 |
282 | 5397 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 5398 Make a |List| out of {expr}. When {pattern} is omitted or |
5399 empty each white-separated sequence of characters becomes an | |
5400 item. | |
82 | 5401 Otherwise the string is split where {pattern} matches, |
282 | 5402 removing the matched characters. |
5403 When the first or last item is empty it is omitted, unless the | |
5404 {keepempty} argument is given and it's non-zero. | |
293 | 5405 Other empty items are kept when {pattern} matches at least one |
5406 character or when {keepempty} is non-zero. | |
82 | 5407 Example: > |
95 | 5408 :let words = split(getline('.'), '\W\+') |
282 | 5409 < To split a string in individual characters: > |
236 | 5410 :for c in split(mystring, '\zs') |
258 | 5411 < If you want to keep the separator you can also use '\zs': > |
5412 :echo split('abc:def:ghi', ':\zs') | |
5413 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 5414 Splitting a table where the first element can be empty: > |
5415 :let items = split(line, ':', 1) | |
5416 < The opposite function is |join()|. | |
82 | 5417 |
5418 | |
1621 | 5419 sqrt({expr}) *sqrt()* |
5420 Return the non-negative square root of Float {expr} as a | |
5421 |Float|. | |
5422 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
5423 is negative the result is NaN (Not a Number). | |
5424 Examples: > | |
5425 :echo sqrt(100) | |
5426 < 10.0 > | |
5427 :echo sqrt(-4.01) | |
5428 < nan | |
1668 | 5429 "nan" may be different, it depends on system libraries. |
1621 | 5430 {only available when compiled with the |+float| feature} |
5431 | |
5432 | |
5433 str2float( {expr}) *str2float()* | |
5434 Convert String {expr} to a Float. This mostly works the same | |
5435 as when using a floating point number in an expression, see | |
5436 |floating-point-format|. But it's a bit more permissive. | |
5437 E.g., "1e40" is accepted, while in an expression you need to | |
5438 write "1.0e40". | |
5439 Text after the number is silently ignored. | |
5440 The decimal point is always '.', no matter what the locale is | |
5441 set to. A comma ends the number: "12,345.67" is converted to | |
5442 12.0. You can strip out thousands separators with | |
5443 |substitute()|: > | |
5444 let f = str2float(substitute(text, ',', '', 'g')) | |
5445 < {only available when compiled with the |+float| feature} | |
5446 | |
5447 | |
782 | 5448 str2nr( {expr} [, {base}]) *str2nr()* |
5449 Convert string {expr} to a number. | |
5450 {base} is the conversion base, it can be 8, 10 or 16. | |
5451 When {base} is omitted base 10 is used. This also means that | |
5452 a leading zero doesn't cause octal conversion to be used, as | |
5453 with the default String to Number conversion. | |
5454 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
5455 different base the result will be zero. | |
5456 Text after the number is silently ignored. | |
856 | 5457 |
782 | 5458 |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5459 strchars({expr}) *strchars()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5460 The result is a Number, which is the number of characters |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5461 String {expr} occupies. Composing characters are counted |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5462 separately. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5463 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5464 |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5465 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5466 The result is a Number, which is the number of display cells |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5467 String {expr} occupies on the screen. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5468 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5469 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5470 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5471 The option settings of the current window are used. This |
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5472 matters for anything that's displayed differently, such as |
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5473 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5474 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5475 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5476 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5477 |
7 | 5478 strftime({format} [, {time}]) *strftime()* |
5479 The result is a String, which is a formatted date and time, as | |
5480 specified by the {format} string. The given {time} is used, | |
5481 or the current time if no time is given. The accepted | |
5482 {format} depends on your system, thus this is not portable! | |
5483 See the manual page of the C function strftime() for the | |
5484 format. The maximum length of the result is 80 characters. | |
5485 See also |localtime()| and |getftime()|. | |
5486 The language can be changed with the |:language| command. | |
5487 Examples: > | |
5488 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
5489 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
5490 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
5491 :echo strftime("%H:%M") 11:55 | |
5492 :echo strftime("%c", getftime("file.c")) | |
5493 Show mod time of file.c. | |
82 | 5494 < Not available on all systems. To check use: > |
5495 :if exists("*strftime") | |
5496 | |
133 | 5497 stridx({haystack}, {needle} [, {start}]) *stridx()* |
5498 The result is a Number, which gives the byte index in | |
5499 {haystack} of the first occurrence of the String {needle}. | |
140 | 5500 If {start} is specified, the search starts at index {start}. |
5501 This can be used to find a second match: > | |
2662 | 5502 :let colon1 = stridx(line, ":") |
5503 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 5504 < The search is done case-sensitive. |
205 | 5505 For pattern searches use |match()|. |
133 | 5506 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 5507 See also |strridx()|. |
5508 Examples: > | |
7 | 5509 :echo stridx("An Example", "Example") 3 |
5510 :echo stridx("Starting point", "Start") 0 | |
5511 :echo stridx("Starting point", "start") -1 | |
856 | 5512 < *strstr()* *strchr()* |
170 | 5513 stridx() works similar to the C function strstr(). When used |
5514 with a single character it works similar to strchr(). | |
5515 | |
55 | 5516 *string()* |
95 | 5517 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 5518 Float, String or a composition of them, then the result can be |
5519 parsed back with |eval()|. | |
55 | 5520 {expr} type result ~ |
99 | 5521 String 'string' |
95 | 5522 Number 123 |
1621 | 5523 Float 123.123456 or 1.123456e8 |
99 | 5524 Funcref function('name') |
95 | 5525 List [item, item] |
323 | 5526 Dictionary {key: value, key: value} |
99 | 5527 Note that in String values the ' character is doubled. |
1156 | 5528 Also see |strtrans()|. |
55 | 5529 |
7 | 5530 *strlen()* |
5531 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 5532 {expr} in bytes. |
5533 If you want to count the number of multi-byte characters (not | |
5534 counting composing characters) use something like this: > | |
7 | 5535 |
5536 :let len = strlen(substitute(str, ".", "x", "g")) | |
502 | 5537 < |
55 | 5538 If the argument is a Number it is first converted to a String. |
5539 For other types an error is given. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5540 Also see |len()|, |strchars()|, |strdisplaywidth()| and |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5541 |strwidth()|. |
7 | 5542 |
5543 strpart({src}, {start}[, {len}]) *strpart()* | |
5544 The result is a String, which is part of {src}, starting from | |
574 | 5545 byte {start}, with the byte length {len}. |
7 | 5546 When non-existing bytes are included, this doesn't result in |
5547 an error, the bytes are simply omitted. | |
5548 If {len} is missing, the copy continues from {start} till the | |
5549 end of the {src}. > | |
5550 strpart("abcdefg", 3, 2) == "de" | |
5551 strpart("abcdefg", -2, 4) == "ab" | |
5552 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 5553 strpart("abcdefg", 3) == "defg" |
7 | 5554 < Note: To get the first character, {start} must be 0. For |
5555 example, to get three bytes under and after the cursor: > | |
823 | 5556 strpart(getline("."), col(".") - 1, 3) |
7 | 5557 < |
140 | 5558 strridx({haystack}, {needle} [, {start}]) *strridx()* |
5559 The result is a Number, which gives the byte index in | |
5560 {haystack} of the last occurrence of the String {needle}. | |
5561 When {start} is specified, matches beyond this index are | |
5562 ignored. This can be used to find a match before a previous | |
5563 match: > | |
5564 :let lastcomma = strridx(line, ",") | |
5565 :let comma2 = strridx(line, ",", lastcomma - 1) | |
5566 < The search is done case-sensitive. | |
133 | 5567 For pattern searches use |match()|. |
5568 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 5569 If the {needle} is empty the length of {haystack} is returned. |
236 | 5570 See also |stridx()|. Examples: > |
7 | 5571 :echo strridx("an angry armadillo", "an") 3 |
856 | 5572 < *strrchr()* |
170 | 5573 When used with a single character it works similar to the C |
5574 function strrchr(). | |
5575 | |
7 | 5576 strtrans({expr}) *strtrans()* |
5577 The result is a String, which is {expr} with all unprintable | |
5578 characters translated into printable characters |'isprint'|. | |
5579 Like they are shown in a window. Example: > | |
5580 echo strtrans(@a) | |
5581 < This displays a newline in register a as "^@" instead of | |
5582 starting a new line. | |
5583 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5584 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5585 The result is a Number, which is the number of display cells |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5586 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5587 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5588 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5589 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5590 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5591 |
7 | 5592 submatch({nr}) *submatch()* |
2908 | 5593 Only for an expression in a |:substitute| command or |
5594 substitute() function. | |
5595 Returns the {nr}'th submatch of the matched text. When {nr} | |
5596 is 0 the whole matched text is returned. | |
5597 Also see |sub-replace-expression|. | |
7 | 5598 Example: > |
5599 :s/\d\+/\=submatch(0) + 1/ | |
5600 < This finds the first number in the line and adds one to it. | |
5601 A line break is included as a newline character. | |
5602 | |
5603 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
5604 The result is a String, which is a copy of {expr}, in which | |
2908 | 5605 the first match of {pat} is replaced with {sub}. |
5606 When {flags} is "g", all matches of {pat} in {expr} are | |
5607 replaced. Otherwise {flags} should be "". | |
5608 | |
5609 This works like the ":substitute" command (without any flags). | |
5610 But the matching with {pat} is always done like the 'magic' | |
5611 option is set and 'cpoptions' is empty (to make scripts | |
5612 portable). 'ignorecase' is still relevant. 'smartcase' is | |
5613 not used. See |string-match| for how {pat} is used. | |
5614 | |
5615 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 5616 Note that some codes in {sub} have a special meaning |
1621 | 5617 |sub-replace-special|. For example, to replace something with |
7 | 5618 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 5619 |
7 | 5620 When {pat} does not match in {expr}, {expr} is returned |
5621 unmodified. | |
2908 | 5622 |
7 | 5623 Example: > |
5624 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
5625 < This removes the last component of the 'path' option. > | |
5626 :echo substitute("testing", ".*", "\\U\\0", "") | |
5627 < results in "TESTING". | |
2908 | 5628 |
5629 When {sub} starts with "\=", the remainder is interpreted as | |
5630 an expression. See |sub-replace-expression|. Example: > | |
2833 | 5631 :echo substitute(s, '%\(\x\x\)', |
5632 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 5633 |
32 | 5634 synID({lnum}, {col}, {trans}) *synID()* |
7 | 5635 The result is a Number, which is the syntax ID at the position |
32 | 5636 {lnum} and {col} in the current window. |
7 | 5637 The syntax ID can be used with |synIDattr()| and |
5638 |synIDtrans()| to obtain syntax information about text. | |
419 | 5639 |
32 | 5640 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 5641 line. 'synmaxcol' applies, in a longer line zero is returned. |
5642 | |
7 | 5643 When {trans} is non-zero, transparent items are reduced to the |
1621 | 5644 item that they reveal. This is useful when wanting to know |
7 | 5645 the effective color. When {trans} is zero, the transparent |
5646 item is returned. This is useful when wanting to know which | |
5647 syntax item is effective (e.g. inside parens). | |
5648 Warning: This function can be very slow. Best speed is | |
5649 obtained by going through the file in forward direction. | |
5650 | |
5651 Example (echoes the name of the syntax item under the cursor): > | |
5652 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
5653 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
5654 |
7 | 5655 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
5656 The result is a String, which is the {what} attribute of | |
5657 syntax ID {synID}. This can be used to obtain information | |
5658 about a syntax item. | |
5659 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 5660 for that mode. When {mode} is omitted, or an invalid value is |
7 | 5661 used, the attributes for the currently active highlighting are |
5662 used (GUI, cterm or term). | |
5663 Use synIDtrans() to follow linked highlight groups. | |
5664 {what} result | |
5665 "name" the name of the syntax item | |
5666 "fg" foreground color (GUI: color name used to set | |
5667 the color, cterm: color number as a string, | |
5668 term: empty string) | |
1755 | 5669 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5670 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5671 |highlight-font| |
1755 | 5672 "sp" special color (as with "fg") |highlight-guisp| |
7 | 5673 "fg#" like "fg", but for the GUI and the GUI is |
5674 running the name in "#RRGGBB" form | |
5675 "bg#" like "fg#" for "bg" | |
1755 | 5676 "sp#" like "fg#" for "sp" |
7 | 5677 "bold" "1" if bold |
5678 "italic" "1" if italic | |
5679 "reverse" "1" if reverse | |
5680 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5681 "standout" "1" if standout |
7 | 5682 "underline" "1" if underlined |
205 | 5683 "undercurl" "1" if undercurled |
7 | 5684 |
5685 Example (echoes the color of the syntax item under the | |
5686 cursor): > | |
5687 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
5688 < | |
5689 synIDtrans({synID}) *synIDtrans()* | |
5690 The result is a Number, which is the translated syntax ID of | |
5691 {synID}. This is the syntax group ID of what is being used to | |
5692 highlight the character. Highlight links given with | |
5693 ":highlight link" are followed. | |
5694 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5695 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5696 The result is a List. The first item in the list is 0 if the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5697 character at the position {lnum} and {col} is not part of a |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5698 concealable region, 1 if it is. The second item in the list is |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5699 a string. If the first item is 1, the second item contains the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5700 text which will be displayed in place of the concealed text, |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5701 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5702 and final item in the list is a unique number representing the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5703 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5704 beginning of a new concealable region if there are two |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5705 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5706 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5707 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5708 |
1500 | 5709 synstack({lnum}, {col}) *synstack()* |
5710 Return a |List|, which is the stack of syntax items at the | |
5711 position {lnum} and {col} in the current window. Each item in | |
5712 the List is an ID like what |synID()| returns. | |
5713 The first item in the List is the outer region, following are | |
5714 items contained in that one. The last one is what |synID()| | |
5715 returns, unless not the whole item is highlighted or it is a | |
5716 transparent item. | |
5717 This function is useful for debugging a syntax file. | |
5718 Example that shows the syntax stack under the cursor: > | |
5719 for id in synstack(line("."), col(".")) | |
5720 echo synIDattr(id, "name") | |
5721 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5722 < When the position specified with {lnum} and {col} is invalid |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5723 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5724 character in a line and the first column in an empty line are |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5725 valid positions. |
1500 | 5726 |
24 | 5727 system({expr} [, {input}]) *system()* *E677* |
5728 Get the output of the shell command {expr}. | |
5729 When {input} is given, this string is written to a file and | |
5730 passed as stdin to the command. The string is written as-is, | |
5731 you need to take care of using the correct line separators | |
170 | 5732 yourself. Pipes are not used. |
1661 | 5733 Note: Use |shellescape()| to escape special characters in a |
5734 command argument. Newlines in {expr} may cause the command to | |
5735 fail. The characters in 'shellquote' and 'shellxquote' may | |
5736 also cause trouble. | |
7 | 5737 This is not to be used for interactive commands. |
1661 | 5738 |
7 | 5739 The result is a String. Example: > |
1661 | 5740 :let files = system("ls " . shellescape(expand('%:h'))) |
7 | 5741 |
5742 < To make the result more system-independent, the shell output | |
5743 is filtered to replace <CR> with <NL> for Macintosh, and | |
5744 <CR><NL> with <NL> for DOS-like systems. | |
5745 The command executed is constructed using several options: | |
5746 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
5747 ({tmp} is an automatically generated file name). | |
5748 For Unix and OS/2 braces are put around {expr} to allow for | |
5749 concatenated commands. | |
5750 | |
794 | 5751 The command will be executed in "cooked" mode, so that a |
5752 CTRL-C will interrupt the command (on Unix at least). | |
5753 | |
7 | 5754 The resulting error code can be found in |v:shell_error|. |
5755 This function will fail in |restricted-mode|. | |
625 | 5756 |
5757 Note that any wrong value in the options mentioned above may | |
5758 make the function fail. It has also been reported to fail | |
5759 when using a security agent application. | |
7 | 5760 Unlike ":!cmd" there is no automatic check for changed files. |
5761 Use |:checktime| to force a check. | |
5762 | |
205 | 5763 |
677 | 5764 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 5765 The result is a |List|, where each item is the number of the |
677 | 5766 buffer associated with each window in the current tab page. |
5767 {arg} specifies the number of tab page to be used. When | |
5768 omitted the current tab page is used. | |
5769 When {arg} is invalid the number zero is returned. | |
5770 To get a list of all buffers in all tabs use this: > | |
5771 tablist = [] | |
5772 for i in range(tabpagenr('$')) | |
5773 call extend(tablist, tabpagebuflist(i + 1)) | |
5774 endfor | |
5775 < Note that a buffer may appear in more than one window. | |
5776 | |
5777 | |
5778 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 5779 The result is a Number, which is the number of the current |
5780 tab page. The first tab page has number 1. | |
5781 When the optional argument is "$", the number of the last tab | |
5782 page is returned (the tab page count). | |
5783 The number can be used with the |:tab| command. | |
5784 | |
5785 | |
677 | 5786 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5787 Like |winnr()| but for tab page {tabarg}. |
677 | 5788 {tabarg} specifies the number of tab page to be used. |
5789 {arg} is used like with |winnr()|: | |
5790 - When omitted the current window number is returned. This is | |
5791 the window which will be used when going to this tab page. | |
5792 - When "$" the number of windows is returned. | |
5793 - When "#" the previous window nr is returned. | |
5794 Useful examples: > | |
5795 tabpagewinnr(1) " current window of tab page 1 | |
5796 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
5797 < When {tabarg} is invalid zero is returned. | |
5798 | |
805 | 5799 *tagfiles()* |
5800 tagfiles() Returns a |List| with the file names used to search for tags | |
5801 for the current buffer. This is the 'tags' option expanded. | |
5802 | |
5803 | |
205 | 5804 taglist({expr}) *taglist()* |
5805 Returns a list of tags matching the regular expression {expr}. | |
438 | 5806 Each list item is a dictionary with at least the following |
5807 entries: | |
648 | 5808 name Name of the tag. |
5809 filename Name of the file where the tag is | |
1156 | 5810 defined. It is either relative to the |
5811 current directory or a full path. | |
205 | 5812 cmd Ex command used to locate the tag in |
5813 the file. | |
648 | 5814 kind Type of the tag. The value for this |
205 | 5815 entry depends on the language specific |
1156 | 5816 kind values. Only available when |
5817 using a tags file generated by | |
5818 Exuberant ctags or hdrtag. | |
648 | 5819 static A file specific tag. Refer to |
205 | 5820 |static-tag| for more information. |
1156 | 5821 More entries may be present, depending on the content of the |
5822 tags file: access, implementation, inherits and signature. | |
5823 Refer to the ctags documentation for information about these | |
5824 fields. For C code the fields "struct", "class" and "enum" | |
5825 may appear, they give the name of the entity the tag is | |
5826 contained in. | |
452 | 5827 |
216 | 5828 The ex-command 'cmd' can be either an ex search pattern, a |
5829 line number or a line number followed by a byte number. | |
205 | 5830 |
5831 If there are no matching tags, then an empty list is returned. | |
5832 | |
5833 To get an exact tag match, the anchors '^' and '$' should be | |
5834 used in {expr}. Refer to |tag-regexp| for more information | |
5835 about the tag search regular expression pattern. | |
5836 | |
5837 Refer to |'tags'| for information about how the tags file is | |
5838 located by Vim. Refer to |tags-file-format| for the format of | |
5839 the tags file generated by the different ctags tools. | |
5840 | |
7 | 5841 tempname() *tempname()* *temp-file-name* |
5842 The result is a String, which is the name of a file that | |
1621 | 5843 doesn't exist. It can be used for a temporary file. The name |
7 | 5844 is different for at least 26 consecutive calls. Example: > |
5845 :let tmpfile = tempname() | |
5846 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5847 < For Unix, the file will be in a private directory |tempfile|. |
7 | 5848 For MS-Windows forward slashes are used when the 'shellslash' |
5849 option is set or when 'shellcmdflag' starts with '-'. | |
5850 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5851 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5852 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5853 Return the tangent of {expr}, measured in radians, as a |Float| |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5854 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5855 {expr} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5856 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5857 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5858 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5859 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5860 < -1.181502 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5861 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5862 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5863 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5864 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5865 Return the hyperbolic tangent of {expr} as a |Float| in the |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5866 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5867 {expr} must evaluate to a |Float| or a |Number|. |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5868 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5869 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5870 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5871 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5872 < -0.761594 |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5873 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5874 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5875 |
7 | 5876 tolower({expr}) *tolower()* |
5877 The result is a copy of the String given, with all uppercase | |
5878 characters turned into lowercase (just like applying |gu| to | |
5879 the string). | |
5880 | |
5881 toupper({expr}) *toupper()* | |
5882 The result is a copy of the String given, with all lowercase | |
5883 characters turned into uppercase (just like applying |gU| to | |
5884 the string). | |
5885 | |
15 | 5886 tr({src}, {fromstr}, {tostr}) *tr()* |
5887 The result is a copy of the {src} string with all characters | |
5888 which appear in {fromstr} replaced by the character in that | |
5889 position in the {tostr} string. Thus the first character in | |
5890 {fromstr} is translated into the first character in {tostr} | |
5891 and so on. Exactly like the unix "tr" command. | |
5892 This code also deals with multibyte characters properly. | |
5893 | |
5894 Examples: > | |
5895 echo tr("hello there", "ht", "HT") | |
5896 < returns "Hello THere" > | |
5897 echo tr("<blob>", "<>", "{}") | |
5898 < returns "{blob}" | |
5899 | |
1621 | 5900 trunc({expr}) *trunc()* |
1668 | 5901 Return the largest integral value with magnitude less than or |
1621 | 5902 equal to {expr} as a |Float| (truncate towards zero). |
5903 {expr} must evaluate to a |Float| or a |Number|. | |
5904 Examples: > | |
5905 echo trunc(1.456) | |
5906 < 1.0 > | |
5907 echo trunc(-5.456) | |
5908 < -5.0 > | |
5909 echo trunc(4.0) | |
5910 < 4.0 | |
5911 {only available when compiled with the |+float| feature} | |
5912 | |
87 | 5913 *type()* |
5914 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 5915 Number: 0 |
5916 String: 1 | |
5917 Funcref: 2 | |
5918 List: 3 | |
5919 Dictionary: 4 | |
1621 | 5920 Float: 5 |
153 | 5921 To avoid the magic numbers it should be used this way: > |
87 | 5922 :if type(myvar) == type(0) |
5923 :if type(myvar) == type("") | |
5924 :if type(myvar) == type(function("tr")) | |
5925 :if type(myvar) == type([]) | |
153 | 5926 :if type(myvar) == type({}) |
1621 | 5927 :if type(myvar) == type(0.0) |
7 | 5928 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5929 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5930 Return the name of the undo file that would be used for a file |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5931 with name {name} when writing. This uses the 'undodir' |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5932 option, finding directories that exist. It does not check if |
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
5933 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5934 {name} is always expanded to the full path, since that is what |
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5935 is used internally. |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5936 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5937 When compiled without the +persistent_undo option this always |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5938 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5939 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5940 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5941 Return the current state of the undo tree in a dictionary with |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5942 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5943 "seq_last" The highest undo sequence number used. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5944 "seq_cur" The sequence number of the current position in |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5945 the undo tree. This differs from "seq_last" |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5946 when some changes were undone. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5947 "time_cur" Time last used for |:earlier| and related |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5948 commands. Use |strftime()| to convert to |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5949 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5950 "save_last" Number of the last file write. Zero when no |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5951 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
5952 "save_cur" Number of the current position in the undo |
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
5953 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5954 "synced" Non-zero when the last undo block was synced. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5955 This happens when waiting from input from the |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5956 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5957 "entries" A list of dictionaries with information about |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5958 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5959 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5960 The first item in the "entries" list is the oldest undo item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5961 Each List item is a Dictionary with these items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5962 "seq" Undo sequence number. Same as what appears in |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5963 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5964 "time" Timestamp when the change happened. Use |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5965 |strftime()| to convert to something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5966 "newhead" Only appears in the item that is the last one |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5967 that was added. This marks the last change |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5968 and where further changes will be added. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5969 "curhead" Only appears in the item that is the last one |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5970 that was undone. This marks the current |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5971 position in the undo tree, the block that will |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5972 be used by a redo command. When nothing was |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5973 undone after the last change this item will |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5974 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5975 "save" Only appears on the last block before a file |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5976 write. The number is the write count. The |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5977 first write has number 1, the last one the |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5978 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5979 "alt" Alternate entry. This is again a List of undo |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5980 blocks. Each item may again have an "alt" |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5981 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5982 |
140 | 5983 values({dict}) *values()* |
1621 | 5984 Return a |List| with all the values of {dict}. The |List| is |
685 | 5985 in arbitrary order. |
140 | 5986 |
5987 | |
7 | 5988 virtcol({expr}) *virtcol()* |
5989 The result is a Number, which is the screen column of the file | |
5990 position given with {expr}. That is, the last screen position | |
5991 occupied by the character at that position, when the screen | |
5992 would be of unlimited width. When there is a <Tab> at the | |
5993 position, the returned Number will be the column at the end of | |
5994 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
5995 set to 8, it returns 8. | |
1317 | 5996 For the byte position use |col()|. |
5997 For the use of {expr} see |col()|. | |
5998 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 5999 "off" is the offset in screen columns from the start of the |
1266 | 6000 character. E.g., a position within a <Tab> or after the last |
2965 | 6001 character. When "off" is omitted zero is used. |
7 | 6002 When Virtual editing is active in the current mode, a position |
6003 beyond the end of the line can be returned. |'virtualedit'| | |
6004 The accepted positions are: | |
6005 . the cursor position | |
6006 $ the end of the cursor line (the result is the | |
6007 number of displayed characters in the cursor line | |
6008 plus one) | |
6009 'x position of mark x (if the mark is not set, 0 is | |
6010 returned) | |
6011 Note that only marks in the current file can be used. | |
6012 Examples: > | |
6013 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
6014 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 6015 virtcol("'t") with text " there", with 't at 'h', returns 6 |
6016 < The first column is 1. 0 is returned for an error. | |
1156 | 6017 A more advanced example that echoes the maximum length of |
6018 all lines: > | |
6019 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
6020 | |
7 | 6021 |
6022 visualmode([expr]) *visualmode()* | |
6023 The result is a String, which describes the last Visual mode | |
856 | 6024 used in the current buffer. Initially it returns an empty |
6025 string, but once Visual mode has been used, it returns "v", | |
6026 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
6027 character-wise, line-wise, or block-wise Visual mode | |
6028 respectively. | |
7 | 6029 Example: > |
6030 :exe "normal " . visualmode() | |
6031 < This enters the same Visual mode as before. It is also useful | |
6032 in scripts if you wish to act differently depending on the | |
6033 Visual mode that was used. | |
1621 | 6034 If Visual mode is active, use |mode()| to get the Visual mode |
6035 (e.g., in a |:vmap|). | |
1661 | 6036 *non-zero-arg* |
6037 If [expr] is supplied and it evaluates to a non-zero Number or | |
6038 a non-empty String, then the Visual mode will be cleared and | |
1621 | 6039 the old value is returned. Note that " " and "0" are also |
1661 | 6040 non-empty strings, thus cause the mode to be cleared. A List, |
6041 Dictionary or Float is not a Number or String, thus does not | |
6042 cause the mode to be cleared. | |
7 | 6043 |
6044 *winbufnr()* | |
6045 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 6046 associated with window {nr}. When {nr} is zero, the number of |
7 | 6047 the buffer in the current window is returned. When window |
6048 {nr} doesn't exist, -1 is returned. | |
6049 Example: > | |
6050 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
6051 < | |
6052 *wincol()* | |
6053 wincol() The result is a Number, which is the virtual column of the | |
6054 cursor in the window. This is counting screen cells from the | |
6055 left side of the window. The leftmost column is one. | |
6056 | |
6057 winheight({nr}) *winheight()* | |
6058 The result is a Number, which is the height of window {nr}. | |
6059 When {nr} is zero, the height of the current window is | |
6060 returned. When window {nr} doesn't exist, -1 is returned. | |
6061 An existing window always has a height of zero or more. | |
6062 Examples: > | |
6063 :echo "The current window has " . winheight(0) . " lines." | |
6064 < | |
6065 *winline()* | |
6066 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 6067 in the window. This is counting screen lines from the top of |
7 | 6068 the window. The first line is one. |
531 | 6069 If the cursor was moved the view on the file will be updated |
6070 first, this may cause a scroll. | |
7 | 6071 |
6072 *winnr()* | |
20 | 6073 winnr([{arg}]) The result is a Number, which is the number of the current |
6074 window. The top window has number 1. | |
6075 When the optional argument is "$", the number of the | |
674 | 6076 last window is returned (the window count). |
20 | 6077 When the optional argument is "#", the number of the last |
6078 accessed window is returned (where |CTRL-W_p| goes to). | |
1156 | 6079 If there is no previous window or it is in another tab page 0 |
6080 is returned. | |
20 | 6081 The number can be used with |CTRL-W_w| and ":wincmd w" |
6082 |:wincmd|. | |
1156 | 6083 Also see |tabpagewinnr()|. |
7 | 6084 |
6085 *winrestcmd()* | |
6086 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
6087 the current window sizes. Only works properly when no windows | |
712 | 6088 are opened or closed and the current window and tab page is |
6089 unchanged. | |
7 | 6090 Example: > |
6091 :let cmd = winrestcmd() | |
6092 :call MessWithWindowSizes() | |
6093 :exe cmd | |
712 | 6094 < |
6095 *winrestview()* | |
6096 winrestview({dict}) | |
6097 Uses the |Dictionary| returned by |winsaveview()| to restore | |
6098 the view of the current window. | |
6099 If you have changed the values the result is unpredictable. | |
6100 If the window size changed the result won't be the same. | |
6101 | |
6102 *winsaveview()* | |
6103 winsaveview() Returns a |Dictionary| that contains information to restore | |
6104 the view of the current window. Use |winrestview()| to | |
6105 restore the view. | |
6106 This is useful if you have a mapping that jumps around in the | |
6107 buffer and you want to go back to the original view. | |
6108 This does not save fold information. Use the 'foldenable' | |
798 | 6109 option to temporarily switch off folding, so that folds are |
6110 not opened when moving around. | |
712 | 6111 The return value includes: |
6112 lnum cursor line number | |
6113 col cursor column | |
6114 coladd cursor column offset for 'virtualedit' | |
6115 curswant column for vertical movement | |
6116 topline first line in the window | |
6117 topfill filler lines, only in diff mode | |
6118 leftcol first column displayed | |
6119 skipcol columns skipped | |
6120 Note that no option values are saved. | |
6121 | |
7 | 6122 |
6123 winwidth({nr}) *winwidth()* | |
6124 The result is a Number, which is the width of window {nr}. | |
6125 When {nr} is zero, the width of the current window is | |
6126 returned. When window {nr} doesn't exist, -1 is returned. | |
6127 An existing window always has a width of zero or more. | |
6128 Examples: > | |
6129 :echo "The current window has " . winwidth(0) . " columns." | |
6130 :if winwidth(0) <= 50 | |
6131 : exe "normal 50\<C-W>|" | |
6132 :endif | |
6133 < | |
158 | 6134 *writefile()* |
6135 writefile({list}, {fname} [, {binary}]) | |
685 | 6136 Write |List| {list} to file {fname}. Each list item is |
158 | 6137 separated with a NL. Each list item must be a String or |
6138 Number. | |
6139 When {binary} is equal to "b" binary mode is used: There will | |
6140 not be a NL after the last list item. An empty item at the | |
6141 end does cause the last line in the file to end in a NL. | |
6142 All NL characters are replaced with a NUL character. | |
6143 Inserting CR characters needs to be done before passing {list} | |
6144 to writefile(). | |
6145 An existing file is overwritten, if possible. | |
6146 When the write fails -1 is returned, otherwise 0. There is an | |
6147 error message if the file can't be created or when writing | |
6148 fails. | |
6149 Also see |readfile()|. | |
6150 To copy a file byte for byte: > | |
6151 :let fl = readfile("foo", "b") | |
6152 :call writefile(fl, "foocopy", "b") | |
3214 | 6153 |
6154 | |
6155 xor({expr}, {expr}) *xor()* | |
6156 Bitwise XOR on the two arguments. The arguments are converted | |
6157 to a number. A List, Dict or Float argument causes an error. | |
6158 Example: > | |
6159 :let bits = xor(bits, 0x80) | |
3256 | 6160 < |
3214 | 6161 |
7 | 6162 |
6163 *feature-list* | |
6164 There are three types of features: | |
6165 1. Features that are only supported when they have been enabled when Vim | |
6166 was compiled |+feature-list|. Example: > | |
6167 :if has("cindent") | |
6168 2. Features that are only supported when certain conditions have been met. | |
6169 Example: > | |
6170 :if has("gui_running") | |
6171 < *has-patch* | |
6172 3. Included patches. First check |v:version| for the version of Vim. | |
6173 Then the "patch123" feature means that patch 123 has been included for | |
6174 this version. Example (checking version 6.2.148 or later): > | |
6175 :if v:version > 602 || v:version == 602 && has("patch148") | |
1156 | 6176 < Note that it's possible for patch 147 to be omitted even though 148 is |
6177 included. | |
7 | 6178 |
6179 all_builtin_terms Compiled with all builtin terminals enabled. | |
6180 amiga Amiga version of Vim. | |
6181 arabic Compiled with Arabic support |Arabic|. | |
6182 arp Compiled with ARP support (Amiga). | |
613 | 6183 autocmd Compiled with autocommand support. |autocommand| |
7 | 6184 balloon_eval Compiled with |balloon-eval| support. |
435 | 6185 balloon_multiline GUI supports multiline balloons. |
7 | 6186 beos BeOS version of Vim. |
6187 browse Compiled with |:browse| support, and browse() will | |
6188 work. | |
6189 builtin_terms Compiled with some builtin terminals. | |
6190 byte_offset Compiled with support for 'o' in 'statusline' | |
6191 cindent Compiled with 'cindent' support. | |
6192 clientserver Compiled with remote invocation support |clientserver|. | |
6193 clipboard Compiled with 'clipboard' support. | |
6194 cmdline_compl Compiled with |cmdline-completion| support. | |
6195 cmdline_hist Compiled with |cmdline-history| support. | |
6196 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
6197 comments Compiled with |'comments'| support. | |
2681 | 6198 compatible Compiled to be very Vi compatible. |
7 | 6199 cryptv Compiled with encryption support |encryption|. |
6200 cscope Compiled with |cscope| support. | |
6201 debug Compiled with "DEBUG" defined. | |
6202 dialog_con Compiled with console dialog support. | |
6203 dialog_gui Compiled with GUI dialog support. | |
6204 diff Compiled with |vimdiff| and 'diff' support. | |
6205 digraphs Compiled with support for digraphs. | |
6206 dnd Compiled with support for the "~ register |quote_~|. | |
2681 | 6207 dos16 16 bits DOS version of Vim. |
7 | 6208 dos32 32 bits DOS (DJGPP) version of Vim. |
6209 ebcdic Compiled on a machine with ebcdic character set. | |
6210 emacs_tags Compiled with support for Emacs tags. | |
6211 eval Compiled with expression evaluation support. Always | |
6212 true, of course! | |
6213 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
6214 extra_search Compiled with support for |'incsearch'| and | |
6215 |'hlsearch'| | |
6216 farsi Compiled with Farsi support |farsi|. | |
6217 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 6218 filterpipe When 'shelltemp' is off pipes are used for shell |
6219 read/write/filter commands | |
7 | 6220 find_in_path Compiled with support for include file searches |
6221 |+find_in_path|. | |
1621 | 6222 float Compiled with support for |Float|. |
7 | 6223 fname_case Case in file names matters (for Amiga, MS-DOS, and |
6224 Windows this is not present). | |
6225 folding Compiled with |folding| support. | |
6226 footer Compiled with GUI footer support. |gui-footer| | |
6227 fork Compiled to use fork()/exec() instead of system(). | |
6228 gettext Compiled with message translation |multi-lang| | |
6229 gui Compiled with GUI enabled. | |
6230 gui_athena Compiled with Athena GUI. | |
2681 | 6231 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 6232 gui_gtk Compiled with GTK+ GUI (any version). |
6233 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
6234 gui_mac Compiled with Macintosh GUI. | |
6235 gui_motif Compiled with Motif GUI. | |
6236 gui_photon Compiled with Photon GUI. | |
2681 | 6237 gui_running Vim is running in the GUI, or it will start soon. |
7 | 6238 gui_win32 Compiled with MS Windows Win32 GUI. |
6239 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
6240 hangul_input Compiled with Hangul input support. |hangul| | |
6241 iconv Can use iconv() for conversion. | |
6242 insert_expand Compiled with support for CTRL-X expansion commands in | |
6243 Insert mode. | |
6244 jumplist Compiled with |jumplist| support. | |
6245 keymap Compiled with 'keymap' support. | |
6246 langmap Compiled with 'langmap' support. | |
6247 libcall Compiled with |libcall()| support. | |
6248 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak' | |
6249 support. | |
6250 lispindent Compiled with support for lisp indenting. | |
6251 listcmds Compiled with commands for the buffer list |:files| | |
6252 and the argument list |arglist|. | |
6253 localmap Compiled with local mappings and abbr. |:map-local| | |
2320
966a5609669e
Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
6254 lua Compiled with Lua interface |Lua|. |
7 | 6255 mac Macintosh version of Vim. |
6256 macunix Macintosh version of Vim, using Unix files (OS-X). | |
6257 menu Compiled with support for |:menu|. | |
6258 mksession Compiled with support for |:mksession|. | |
6259 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
6260 mouse Compiled with support mouse. | |
6261 mouse_dec Compiled with support for Dec terminal mouse. | |
6262 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
6263 mouse_netterm Compiled with support for netterm mouse. | |
6264 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 6265 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3224 | 6266 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 6267 mouse_xterm Compiled with support for xterm mouse. |
2681 | 6268 mouseshape Compiled with support for 'mouseshape'. |
1768 | 6269 multi_byte Compiled with support for 'encoding' |
6270 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 6271 multi_byte_ime Compiled with support for IME input method. |
6272 multi_lang Compiled with support for multiple languages. | |
14 | 6273 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 6274 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 6275 netbeans_intg Compiled with support for |netbeans|. |
6276 ole Compiled with OLE automation support for Win32. | |
6277 os2 OS/2 version of Vim. | |
6278 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
6279 perl Compiled with Perl interface. | |
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
6280 persistent_undo Compiled with support for persistent undo history. |
7 | 6281 postscript Compiled with PostScript file printing. |
6282 printer Compiled with |:hardcopy| support. | |
170 | 6283 profile Compiled with |:profile| support. |
2826 | 6284 python Compiled with Python 2.x interface. |has-python| |
6285 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 6286 qnx QNX version of Vim. |
6287 quickfix Compiled with |quickfix| support. | |
857 | 6288 reltime Compiled with |reltime()| support. |
7 | 6289 rightleft Compiled with 'rightleft' support. |
6290 ruby Compiled with Ruby interface |ruby|. | |
6291 scrollbind Compiled with 'scrollbind' support. | |
6292 showcmd Compiled with 'showcmd' support. | |
6293 signs Compiled with |:sign| support. | |
6294 smartindent Compiled with 'smartindent' support. | |
9 | 6295 sniff Compiled with SNiFF interface support. |
2681 | 6296 spell Compiled with spell checking support |spell|. |
1989 | 6297 startuptime Compiled with |--startuptime| support. |
7 | 6298 statusline Compiled with support for 'statusline', 'rulerformat' |
6299 and special formats of 'titlestring' and 'iconstring'. | |
6300 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 6301 syntax Compiled with syntax highlighting support |syntax|. |
7 | 6302 syntax_items There are active syntax highlighting items for the |
6303 current buffer. | |
6304 system Compiled to use system() instead of fork()/exec(). | |
6305 tag_binary Compiled with binary searching in tags files | |
6306 |tag-binary-search|. | |
6307 tag_old_static Compiled with support for old static tags | |
6308 |tag-old-static|. | |
6309 tag_any_white Compiled with support for any white characters in tags | |
6310 files |tag-any-white|. | |
6311 tcl Compiled with Tcl interface. | |
6312 terminfo Compiled with terminfo instead of termcap. | |
6313 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
6314 textobjects Compiled with support for |text-objects|. | |
6315 tgetent Compiled with tgetent support, able to use a termcap | |
6316 or terminfo file. | |
6317 title Compiled with window title support |'title'|. | |
6318 toolbar Compiled with support for |gui-toolbar|. | |
6319 unix Unix version of Vim. | |
6320 user_commands User-defined commands. | |
2681 | 6321 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 6322 vim_starting True while initial source'ing takes place. |startup| |
2681 | 6323 viminfo Compiled with viminfo support. |
7 | 6324 virtualedit Compiled with 'virtualedit' option. |
6325 visual Compiled with Visual mode. | |
6326 visualextra Compiled with extra Visual mode commands. | |
6327 |blockwise-operators|. | |
6328 vms VMS version of Vim. | |
6329 vreplace Compiled with |gR| and |gr| commands. | |
6330 wildignore Compiled with 'wildignore' option. | |
6331 wildmenu Compiled with 'wildmenu' option. | |
6332 win16 Win16 version of Vim (MS-Windows 3.1). | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
6333 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or |
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
6334 64 bits) |
2681 | 6335 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 6336 win64 Win64 version of Vim (MS-Windows 64 bit). |
6337 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 6338 winaltkeys Compiled with 'winaltkeys' option. |
6339 windows Compiled with support for more than one window. | |
7 | 6340 writebackup Compiled with 'writebackup' default on. |
6341 xfontset Compiled with X fontset support |xfontset|. | |
6342 xim Compiled with X input method support |xim|. | |
3256 | 6343 xpm_w32 Compiled with pixmap support for Win32. |
7 | 6344 xsmp Compiled with X session management support. |
6345 xsmp_interact Compiled with interactive X session management support. | |
6346 xterm_clipboard Compiled with support for xterm clipboard. | |
6347 xterm_save Compiled with support for saving and restoring the | |
6348 xterm screen. | |
6349 x11 Compiled with X11 support. | |
6350 | |
6351 *string-match* | |
6352 Matching a pattern in a String | |
6353 | |
6354 A regexp pattern as explained at |pattern| is normally used to find a match in | |
6355 the buffer lines. When a pattern is used to find a match in a String, almost | |
6356 everything works in the same way. The difference is that a String is handled | |
6357 like it is one line. When it contains a "\n" character, this is not seen as a | |
6358 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
6359 with ".". Example: > | |
6360 :let a = "aaaa\nxxxx" | |
6361 :echo matchstr(a, "..\n..") | |
6362 aa | |
6363 xx | |
6364 :echo matchstr(a, "a.x") | |
6365 a | |
6366 x | |
6367 | |
6368 Don't forget that "^" will only match at the first character of the String and | |
6369 "$" at the last character of the string. They don't match after or before a | |
6370 "\n". | |
6371 | |
6372 ============================================================================== | |
6373 5. Defining functions *user-functions* | |
6374 | |
6375 New functions can be defined. These can be called just like builtin | |
6376 functions. The function executes a sequence of Ex commands. Normal mode | |
6377 commands can be executed with the |:normal| command. | |
6378 | |
6379 The function name must start with an uppercase letter, to avoid confusion with | |
6380 builtin functions. To prevent from using the same name in different scripts | |
6381 avoid obvious, short names. A good habit is to start the function name with | |
6382 the name of the script, e.g., "HTMLcolor()". | |
6383 | |
504 | 6384 It's also possible to use curly braces, see |curly-braces-names|. And the |
6385 |autoload| facility is useful to define a function only when it's called. | |
7 | 6386 |
6387 *local-function* | |
6388 A function local to a script must start with "s:". A local script function | |
6389 can only be called from within the script and from functions, user commands | |
6390 and autocommands defined in the script. It is also possible to call the | |
1698 | 6391 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 6392 instead of "s:" when the mapping is expanded outside of the script. |
6393 | |
6394 *:fu* *:function* *E128* *E129* *E123* | |
6395 :fu[nction] List all functions and their arguments. | |
6396 | |
6397 :fu[nction] {name} List function {name}. | |
685 | 6398 {name} can also be a |Dictionary| entry that is a |
6399 |Funcref|: > | |
114 | 6400 :function dict.init |
504 | 6401 |
6402 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
6403 Example that lists all functions ending with "File": > | |
6404 :function /File$ | |
482 | 6405 < |
6406 *:function-verbose* | |
6407 When 'verbose' is non-zero, listing a function will also display where it was | |
6408 last defined. Example: > | |
6409 | |
6410 :verbose function SetFileTypeSH | |
6411 function SetFileTypeSH(name) | |
6412 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
6413 < | |
484 | 6414 See |:verbose-cmd| for more information. |
482 | 6415 |
3153 | 6416 *E124* *E125* *E853* |
102 | 6417 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 6418 Define a new function by the name {name}. The name |
6419 must be made of alphanumeric characters and '_', and | |
6420 must start with a capital or "s:" (see above). | |
114 | 6421 |
685 | 6422 {name} can also be a |Dictionary| entry that is a |
6423 |Funcref|: > | |
114 | 6424 :function dict.init(arg) |
1621 | 6425 < "dict" must be an existing dictionary. The entry |
114 | 6426 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 6427 is required to overwrite an existing function. The |
114 | 6428 result is a |Funcref| to a numbered function. The |
6429 function can only be used with a |Funcref| and will be | |
6430 deleted if there are no more references to it. | |
7 | 6431 *E127* *E122* |
6432 When a function by this name already exists and [!] is | |
6433 not used an error message is given. When [!] is used, | |
6434 an existing function is silently replaced. Unless it | |
6435 is currently being executed, that is an error. | |
133 | 6436 |
6437 For the {arguments} see |function-argument|. | |
6438 | |
7 | 6439 *a:firstline* *a:lastline* |
6440 When the [range] argument is added, the function is | |
6441 expected to take care of a range itself. The range is | |
6442 passed as "a:firstline" and "a:lastline". If [range] | |
6443 is excluded, ":{range}call" will call the function for | |
6444 each line in the range, with the cursor on the start | |
6445 of each line. See |function-range-example|. | |
114 | 6446 |
7 | 6447 When the [abort] argument is added, the function will |
6448 abort as soon as an error is detected. | |
114 | 6449 |
102 | 6450 When the [dict] argument is added, the function must |
1621 | 6451 be invoked through an entry in a |Dictionary|. The |
102 | 6452 local variable "self" will then be set to the |
6453 dictionary. See |Dictionary-function|. | |
7 | 6454 |
1621 | 6455 *function-search-undo* |
653 | 6456 The last used search pattern and the redo command "." |
1621 | 6457 will not be changed by the function. This also |
6458 implies that the effect of |:nohlsearch| is undone | |
6459 when the function returns. | |
653 | 6460 |
7 | 6461 *:endf* *:endfunction* *E126* *E193* |
6462 :endf[unction] The end of a function definition. Must be on a line | |
6463 by its own, without other commands. | |
6464 | |
6465 *:delf* *:delfunction* *E130* *E131* | |
6466 :delf[unction] {name} Delete function {name}. | |
685 | 6467 {name} can also be a |Dictionary| entry that is a |
6468 |Funcref|: > | |
114 | 6469 :delfunc dict.init |
1621 | 6470 < This will remove the "init" entry from "dict". The |
114 | 6471 function is deleted if there are no more references to |
6472 it. | |
7 | 6473 *:retu* *:return* *E133* |
6474 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
6475 evaluated and returned as the result of the function. | |
6476 If "[expr]" is not given, the number 0 is returned. | |
6477 When a function ends without an explicit ":return", | |
6478 the number 0 is returned. | |
6479 Note that there is no check for unreachable lines, | |
6480 thus there is no warning if commands follow ":return". | |
6481 | |
6482 If the ":return" is used after a |:try| but before the | |
6483 matching |:finally| (if present), the commands | |
6484 following the ":finally" up to the matching |:endtry| | |
6485 are executed first. This process applies to all | |
6486 nested ":try"s inside the function. The function | |
6487 returns at the outermost ":endtry". | |
6488 | |
133 | 6489 *function-argument* *a:var* |
1621 | 6490 An argument can be defined by giving its name. In the function this can then |
133 | 6491 be used as "a:name" ("a:" for argument). |
1156 | 6492 *a:0* *a:1* *a:000* *E740* *...* |
133 | 6493 Up to 20 arguments can be given, separated by commas. After the named |
6494 arguments an argument "..." can be specified, which means that more arguments | |
6495 may optionally be following. In the function the extra arguments can be used | |
6496 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 6497 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
6498 that "a:1" is the same as "a:000[0]". | |
148 | 6499 *E742* |
6500 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 6501 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 6502 Thus you can pass a |List| to a function and have the function add an item to |
6503 it. If you want to make sure the function cannot change a |List| or | |
6504 |Dictionary| use |:lockvar|. | |
133 | 6505 |
6506 When not using "...", the number of arguments in a function call must be equal | |
6507 to the number of named arguments. When using "...", the number of arguments | |
6508 may be larger. | |
6509 | |
6510 It is also possible to define a function without any arguments. You must | |
6511 still supply the () then. The body of the function follows in the next lines, | |
6512 until the matching |:endfunction|. It is allowed to define another function | |
6513 inside a function body. | |
6514 | |
6515 *local-variables* | |
7 | 6516 Inside a function variables can be used. These are local variables, which |
6517 will disappear when the function returns. Global variables need to be | |
6518 accessed with "g:". | |
6519 | |
6520 Example: > | |
6521 :function Table(title, ...) | |
6522 : echohl Title | |
6523 : echo a:title | |
6524 : echohl None | |
140 | 6525 : echo a:0 . " items:" |
6526 : for s in a:000 | |
6527 : echon ' ' . s | |
6528 : endfor | |
7 | 6529 :endfunction |
6530 | |
6531 This function can then be called with: > | |
140 | 6532 call Table("Table", "line1", "line2") |
6533 call Table("Empty Table") | |
7 | 6534 |
1156 | 6535 To return more than one value, return a |List|: > |
6536 :function Compute(n1, n2) | |
7 | 6537 : if a:n2 == 0 |
1156 | 6538 : return ["fail", 0] |
7 | 6539 : endif |
1156 | 6540 : return ["ok", a:n1 / a:n2] |
7 | 6541 :endfunction |
6542 | |
6543 This function can then be called with: > | |
1156 | 6544 :let [success, div] = Compute(102, 6) |
7 | 6545 :if success == "ok" |
6546 : echo div | |
6547 :endif | |
1156 | 6548 < |
786 | 6549 *:cal* *:call* *E107* *E117* |
7 | 6550 :[range]cal[l] {name}([arguments]) |
6551 Call a function. The name of the function and its arguments | |
6552 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 6553 used. The returned value is discarded. |
7 | 6554 Without a range and for functions that accept a range, the |
6555 function is called once. When a range is given the cursor is | |
6556 positioned at the start of the first line before executing the | |
6557 function. | |
6558 When a range is given and the function doesn't handle it | |
6559 itself, the function is executed for each line in the range, | |
6560 with the cursor in the first column of that line. The cursor | |
6561 is left at the last line (possibly moved by the last function | |
1621 | 6562 call). The arguments are re-evaluated for each line. Thus |
7 | 6563 this works: |
6564 *function-range-example* > | |
6565 :function Mynumber(arg) | |
6566 : echo line(".") . " " . a:arg | |
6567 :endfunction | |
6568 :1,5call Mynumber(getline(".")) | |
6569 < | |
6570 The "a:firstline" and "a:lastline" are defined anyway, they | |
6571 can be used to do something different at the start or end of | |
6572 the range. | |
6573 | |
6574 Example of a function that handles the range itself: > | |
6575 | |
6576 :function Cont() range | |
6577 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
6578 :endfunction | |
6579 :4,8call Cont() | |
6580 < | |
6581 This function inserts the continuation character "\" in front | |
6582 of all the lines in the range, except the first one. | |
6583 | |
1156 | 6584 When the function returns a composite value it can be further |
6585 dereferenced, but the range will not be used then. Example: > | |
6586 :4,8call GetDict().method() | |
6587 < Here GetDict() gets the range but method() does not. | |
6588 | |
7 | 6589 *E132* |
6590 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
6591 option. | |
6592 | |
161 | 6593 |
6594 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 6595 *autoload-functions* |
6596 When using many or large functions, it's possible to automatically define them | |
161 | 6597 only when they are used. There are two methods: with an autocommand and with |
6598 the "autoload" directory in 'runtimepath'. | |
6599 | |
6600 | |
6601 Using an autocommand ~ | |
6602 | |
170 | 6603 This is introduced in the user manual, section |41.14|. |
6604 | |
161 | 6605 The autocommand is useful if you have a plugin that is a long Vim script file. |
6606 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 6607 That makes Vim startup faster. The autocommand should then load the same file |
161 | 6608 again, setting a variable to skip the |:finish| command. |
6609 | |
6610 Use the FuncUndefined autocommand event with a pattern that matches the | |
6611 function(s) to be defined. Example: > | |
7 | 6612 |
6613 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
6614 | |
6615 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
6616 "BufNet". Also see |FuncUndefined|. | |
6617 | |
161 | 6618 |
6619 Using an autoload script ~ | |
168 | 6620 *autoload* *E746* |
170 | 6621 This is introduced in the user manual, section |41.15|. |
6622 | |
161 | 6623 Using a script in the "autoload" directory is simpler, but requires using |
6624 exactly the right file name. A function that can be autoloaded has a name | |
6625 like this: > | |
6626 | |
270 | 6627 :call filename#funcname() |
161 | 6628 |
6629 When such a function is called, and it is not defined yet, Vim will search the | |
6630 "autoload" directories in 'runtimepath' for a script file called | |
6631 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
6632 then define the function like this: > | |
6633 | |
270 | 6634 function filename#funcname() |
161 | 6635 echo "Done!" |
6636 endfunction | |
6637 | |
530 | 6638 The file name and the name used before the # in the function must match |
161 | 6639 exactly, and the defined function must have the name exactly as it will be |
6640 called. | |
6641 | |
270 | 6642 It is possible to use subdirectories. Every # in the function name works like |
6643 a path separator. Thus when calling a function: > | |
6644 | |
6645 :call foo#bar#func() | |
161 | 6646 |
6647 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
6648 | |
168 | 6649 This also works when reading a variable that has not been set yet: > |
6650 | |
270 | 6651 :let l = foo#bar#lvar |
168 | 6652 |
557 | 6653 However, when the autoload script was already loaded it won't be loaded again |
6654 for an unknown variable. | |
6655 | |
168 | 6656 When assigning a value to such a variable nothing special happens. This can |
6657 be used to pass settings to the autoload script before it's loaded: > | |
6658 | |
270 | 6659 :let foo#bar#toggle = 1 |
6660 :call foo#bar#func() | |
168 | 6661 |
164 | 6662 Note that when you make a mistake and call a function that is supposed to be |
6663 defined in an autoload script, but the script doesn't actually define the | |
6664 function, the script will be sourced every time you try to call the function. | |
168 | 6665 And you will get an error message every time. |
6666 | |
6667 Also note that if you have two script files, and one calls a function in the | |
1621 | 6668 other and vice versa, before the used function is defined, it won't work. |
168 | 6669 Avoid using the autoload functionality at the toplevel. |
161 | 6670 |
794 | 6671 Hint: If you distribute a bunch of scripts you can pack them together with the |
6672 |vimball| utility. Also read the user manual |distribute-script|. | |
6673 | |
7 | 6674 ============================================================================== |
6675 6. Curly braces names *curly-braces-names* | |
6676 | |
6677 Wherever you can use a variable, you can use a "curly braces name" variable. | |
6678 This is a regular variable name with one or more expressions wrapped in braces | |
6679 {} like this: > | |
6680 my_{adjective}_variable | |
6681 | |
6682 When Vim encounters this, it evaluates the expression inside the braces, puts | |
6683 that in place of the expression, and re-interprets the whole as a variable | |
6684 name. So in the above example, if the variable "adjective" was set to | |
6685 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
6686 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
6687 | |
6688 One application for this is to create a set of variables governed by an option | |
1621 | 6689 value. For example, the statement > |
7 | 6690 echo my_{&background}_message |
6691 | |
6692 would output the contents of "my_dark_message" or "my_light_message" depending | |
6693 on the current value of 'background'. | |
6694 | |
6695 You can use multiple brace pairs: > | |
6696 echo my_{adverb}_{adjective}_message | |
6697 ..or even nest them: > | |
6698 echo my_{ad{end_of_word}}_message | |
6699 where "end_of_word" is either "verb" or "jective". | |
6700 | |
6701 However, the expression inside the braces must evaluate to a valid single | |
236 | 6702 variable name, e.g. this is invalid: > |
7 | 6703 :let foo='a + b' |
6704 :echo c{foo}d | |
6705 .. since the result of expansion is "ca + bd", which is not a variable name. | |
6706 | |
6707 *curly-braces-function-names* | |
6708 You can call and define functions by an evaluated name in a similar way. | |
6709 Example: > | |
6710 :let func_end='whizz' | |
6711 :call my_func_{func_end}(parameter) | |
6712 | |
6713 This would call the function "my_func_whizz(parameter)". | |
6714 | |
6715 ============================================================================== | |
6716 7. Commands *expression-commands* | |
6717 | |
6718 :let {var-name} = {expr1} *:let* *E18* | |
6719 Set internal variable {var-name} to the result of the | |
6720 expression {expr1}. The variable will get the type | |
6721 from the {expr}. If {var-name} didn't exist yet, it | |
6722 is created. | |
6723 | |
85 | 6724 :let {var-name}[{idx}] = {expr1} *E689* |
6725 Set a list item to the result of the expression | |
6726 {expr1}. {var-name} must refer to a list and {idx} | |
6727 must be a valid index in that list. For nested list | |
6728 the index can be repeated. | |
1621 | 6729 This cannot be used to add an item to a |List|. |
6730 This cannot be used to set a byte in a String. You | |
6731 can do that like this: > | |
6732 :let var = var[0:2] . 'X' . var[4:] | |
6733 < | |
114 | 6734 *E711* *E719* |
6735 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 6736 Set a sequence of items in a |List| to the result of |
6737 the expression {expr1}, which must be a list with the | |
87 | 6738 correct number of items. |
6739 {idx1} can be omitted, zero is used instead. | |
6740 {idx2} can be omitted, meaning the end of the list. | |
6741 When the selected range of items is partly past the | |
6742 end of the list, items will be added. | |
6743 | |
153 | 6744 *:let+=* *:let-=* *:let.=* *E734* |
114 | 6745 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
6746 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
6747 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
6748 These fail if {var} was not set yet and when the type | |
6749 of {var} and {expr1} don't fit the operator. | |
6750 | |
6751 | |
7 | 6752 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
6753 Set environment variable {env-name} to the result of | |
6754 the expression {expr1}. The type is always String. | |
114 | 6755 :let ${env-name} .= {expr1} |
6756 Append {expr1} to the environment variable {env-name}. | |
6757 If the environment variable didn't exist yet this | |
6758 works like "=". | |
7 | 6759 |
6760 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
6761 Write the result of the expression {expr1} in register | |
6762 {reg-name}. {reg-name} must be a single letter, and | |
6763 must be the name of a writable register (see | |
6764 |registers|). "@@" can be used for the unnamed | |
6765 register, "@/" for the search pattern. | |
6766 If the result of {expr1} ends in a <CR> or <NL>, the | |
6767 register will be linewise, otherwise it will be set to | |
6768 characterwise. | |
6769 This can be used to clear the last search pattern: > | |
6770 :let @/ = "" | |
6771 < This is different from searching for an empty string, | |
6772 that would match everywhere. | |
6773 | |
114 | 6774 :let @{reg-name} .= {expr1} |
1621 | 6775 Append {expr1} to register {reg-name}. If the |
114 | 6776 register was empty it's like setting it to {expr1}. |
6777 | |
1156 | 6778 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 6779 Set option {option-name} to the result of the |
68 | 6780 expression {expr1}. A String or Number value is |
6781 always converted to the type of the option. | |
7 | 6782 For an option local to a window or buffer the effect |
6783 is just like using the |:set| command: both the local | |
555 | 6784 value and the global value are changed. |
68 | 6785 Example: > |
6786 :let &path = &path . ',/usr/local/include' | |
7 | 6787 |
114 | 6788 :let &{option-name} .= {expr1} |
6789 For a string option: Append {expr1} to the value. | |
6790 Does not insert a comma like |:set+=|. | |
6791 | |
6792 :let &{option-name} += {expr1} | |
6793 :let &{option-name} -= {expr1} | |
6794 For a number or boolean option: Add or subtract | |
6795 {expr1}. | |
6796 | |
7 | 6797 :let &l:{option-name} = {expr1} |
114 | 6798 :let &l:{option-name} .= {expr1} |
6799 :let &l:{option-name} += {expr1} | |
6800 :let &l:{option-name} -= {expr1} | |
7 | 6801 Like above, but only set the local value of an option |
6802 (if there is one). Works like |:setlocal|. | |
6803 | |
6804 :let &g:{option-name} = {expr1} | |
114 | 6805 :let &g:{option-name} .= {expr1} |
6806 :let &g:{option-name} += {expr1} | |
6807 :let &g:{option-name} -= {expr1} | |
7 | 6808 Like above, but only set the global value of an option |
6809 (if there is one). Works like |:setglobal|. | |
6810 | |
85 | 6811 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 6812 {expr1} must evaluate to a |List|. The first item in |
68 | 6813 the list is assigned to {name1}, the second item to |
6814 {name2}, etc. | |
6815 The number of names must match the number of items in | |
685 | 6816 the |List|. |
68 | 6817 Each name can be one of the items of the ":let" |
6818 command as mentioned above. | |
6819 Example: > | |
6820 :let [s, item] = GetItem(s) | |
114 | 6821 < Detail: {expr1} is evaluated first, then the |
6822 assignments are done in sequence. This matters if | |
6823 {name2} depends on {name1}. Example: > | |
6824 :let x = [0, 1] | |
6825 :let i = 0 | |
6826 :let [i, x[i]] = [1, 2] | |
6827 :echo x | |
6828 < The result is [0, 2]. | |
6829 | |
6830 :let [{name1}, {name2}, ...] .= {expr1} | |
6831 :let [{name1}, {name2}, ...] += {expr1} | |
6832 :let [{name1}, {name2}, ...] -= {expr1} | |
6833 Like above, but append/add/subtract the value for each | |
685 | 6834 |List| item. |
68 | 6835 |
6836 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 6837 Like |:let-unpack| above, but the |List| may have more |
114 | 6838 items than there are names. A list of the remaining |
6839 items is assigned to {lastname}. If there are no | |
6840 remaining items {lastname} is set to an empty list. | |
68 | 6841 Example: > |
6842 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
6843 < | |
114 | 6844 :let [{name}, ..., ; {lastname}] .= {expr1} |
6845 :let [{name}, ..., ; {lastname}] += {expr1} | |
6846 :let [{name}, ..., ; {lastname}] -= {expr1} | |
6847 Like above, but append/add/subtract the value for each | |
685 | 6848 |List| item. |
2596 | 6849 |
6850 *E121* | |
1621 | 6851 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 6852 variable names may be given. Special names recognized |
6853 here: *E738* | |
777 | 6854 g: global variables |
6855 b: local buffer variables | |
6856 w: local window variables | |
819 | 6857 t: local tab page variables |
777 | 6858 s: script-local variables |
6859 l: local function variables | |
123 | 6860 v: Vim variables. |
7 | 6861 |
55 | 6862 :let List the values of all variables. The type of the |
6863 variable is indicated before the value: | |
6864 <nothing> String | |
6865 # Number | |
856 | 6866 * Funcref |
7 | 6867 |
148 | 6868 |
1156 | 6869 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 6870 Remove the internal variable {name}. Several variable |
6871 names can be given, they are all removed. The name | |
685 | 6872 may also be a |List| or |Dictionary| item. |
7 | 6873 With [!] no error message is given for non-existing |
6874 variables. | |
685 | 6875 One or more items from a |List| can be removed: > |
108 | 6876 :unlet list[3] " remove fourth item |
6877 :unlet list[3:] " remove fourth item to last | |
685 | 6878 < One item from a |Dictionary| can be removed at a time: > |
108 | 6879 :unlet dict['two'] |
6880 :unlet dict.two | |
1668 | 6881 < This is especially useful to clean up used global |
6882 variables and script-local variables (these are not | |
6883 deleted when the script ends). Function-local | |
6884 variables are automatically deleted when the function | |
6885 ends. | |
7 | 6886 |
148 | 6887 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
6888 Lock the internal variable {name}. Locking means that | |
6889 it can no longer be changed (until it is unlocked). | |
6890 A locked variable can be deleted: > | |
6891 :lockvar v | |
6892 :let v = 'asdf' " fails! | |
6893 :unlet v | |
6894 < *E741* | |
6895 If you try to change a locked variable you get an | |
6896 error message: "E741: Value of {name} is locked" | |
6897 | |
685 | 6898 [depth] is relevant when locking a |List| or |
6899 |Dictionary|. It specifies how deep the locking goes: | |
6900 1 Lock the |List| or |Dictionary| itself, | |
148 | 6901 cannot add or remove items, but can |
6902 still change their values. | |
6903 2 Also lock the values, cannot change | |
685 | 6904 the items. If an item is a |List| or |
6905 |Dictionary|, cannot add or remove | |
148 | 6906 items, but can still change the |
6907 values. | |
685 | 6908 3 Like 2 but for the |List| / |
6909 |Dictionary| in the |List| / | |
6910 |Dictionary|, one level deeper. | |
6911 The default [depth] is 2, thus when {name} is a |List| | |
6912 or |Dictionary| the values cannot be changed. | |
148 | 6913 *E743* |
6914 For unlimited depth use [!] and omit [depth]. | |
6915 However, there is a maximum depth of 100 to catch | |
6916 loops. | |
6917 | |
685 | 6918 Note that when two variables refer to the same |List| |
6919 and you lock one of them, the |List| will also be | |
819 | 6920 locked when used through the other variable. |
6921 Example: > | |
148 | 6922 :let l = [0, 1, 2, 3] |
6923 :let cl = l | |
6924 :lockvar l | |
6925 :let cl[1] = 99 " won't work! | |
6926 < You may want to make a copy of a list to avoid this. | |
6927 See |deepcopy()|. | |
6928 | |
6929 | |
6930 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
6931 Unlock the internal variable {name}. Does the | |
6932 opposite of |:lockvar|. | |
6933 | |
6934 | |
7 | 6935 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
6936 :en[dif] Execute the commands until the next matching ":else" | |
6937 or ":endif" if {expr1} evaluates to non-zero. | |
6938 | |
6939 From Vim version 4.5 until 5.0, every Ex command in | |
6940 between the ":if" and ":endif" is ignored. These two | |
6941 commands were just to allow for future expansions in a | |
6942 backwards compatible way. Nesting was allowed. Note | |
6943 that any ":else" or ":elseif" was ignored, the "else" | |
6944 part was not executed either. | |
6945 | |
6946 You can use this to remain compatible with older | |
6947 versions: > | |
6948 :if version >= 500 | |
6949 : version-5-specific-commands | |
6950 :endif | |
6951 < The commands still need to be parsed to find the | |
6952 "endif". Sometimes an older Vim has a problem with a | |
6953 new command. For example, ":silent" is recognized as | |
6954 a ":substitute" command. In that case ":execute" can | |
6955 avoid problems: > | |
6956 :if version >= 600 | |
6957 : execute "silent 1,$delete" | |
6958 :endif | |
6959 < | |
6960 NOTE: The ":append" and ":insert" commands don't work | |
6961 properly in between ":if" and ":endif". | |
6962 | |
6963 *:else* *:el* *E581* *E583* | |
6964 :el[se] Execute the commands until the next matching ":else" | |
6965 or ":endif" if they previously were not being | |
6966 executed. | |
6967 | |
6968 *:elseif* *:elsei* *E582* *E584* | |
6969 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
6970 is no extra ":endif". | |
6971 | |
6972 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 6973 *E170* *E585* *E588* *E733* |
7 | 6974 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
6975 as long as {expr1} evaluates to non-zero. | |
6976 When an error is detected from a command inside the | |
6977 loop, execution continues after the "endwhile". | |
75 | 6978 Example: > |
6979 :let lnum = 1 | |
6980 :while lnum <= line("$") | |
6981 :call FixLine(lnum) | |
6982 :let lnum = lnum + 1 | |
6983 :endwhile | |
6984 < | |
7 | 6985 NOTE: The ":append" and ":insert" commands don't work |
99 | 6986 properly inside a ":while" and ":for" loop. |
75 | 6987 |
114 | 6988 :for {var} in {list} *:for* *E690* *E732* |
75 | 6989 :endfo[r] *:endfo* *:endfor* |
6990 Repeat the commands between ":for" and ":endfor" for | |
158 | 6991 each item in {list}. Variable {var} is set to the |
79 | 6992 value of each item. |
6993 When an error is detected for a command inside the | |
75 | 6994 loop, execution continues after the "endfor". |
464 | 6995 Changing {list} inside the loop affects what items are |
6996 used. Make a copy if this is unwanted: > | |
79 | 6997 :for item in copy(mylist) |
6998 < When not making a copy, Vim stores a reference to the | |
6999 next item in the list, before executing the commands | |
1621 | 7000 with the current item. Thus the current item can be |
79 | 7001 removed without effect. Removing any later item means |
7002 it will not be found. Thus the following example | |
7003 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7004 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7005 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7006 endfor |
87 | 7007 < Note that reordering the list (e.g., with sort() or |
7008 reverse()) may have unexpected effects. | |
7009 Note that the type of each list item should be | |
75 | 7010 identical to avoid errors for the type of {var} |
7011 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7012 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7013 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7014 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7015 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7016 endfor |
75 | 7017 |
7018 :for [{var1}, {var2}, ...] in {listlist} | |
7019 :endfo[r] | |
7020 Like ":for" above, but each item in {listlist} must be | |
7021 a list, of which each item is assigned to {var1}, | |
7022 {var2}, etc. Example: > | |
7023 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
7024 :echo getline(lnum)[col] | |
7025 :endfor | |
7026 < | |
7 | 7027 *:continue* *:con* *E586* |
75 | 7028 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
7029 to the start of the loop. | |
7030 If it is used after a |:try| inside the loop but | |
7031 before the matching |:finally| (if present), the | |
7032 commands following the ":finally" up to the matching | |
7033 |:endtry| are executed first. This process applies to | |
7034 all nested ":try"s inside the loop. The outermost | |
7035 ":endtry" then jumps back to the start of the loop. | |
7 | 7036 |
7037 *:break* *:brea* *E587* | |
75 | 7038 :brea[k] When used inside a ":while" or ":for" loop, skips to |
7039 the command after the matching ":endwhile" or | |
7040 ":endfor". | |
7041 If it is used after a |:try| inside the loop but | |
7042 before the matching |:finally| (if present), the | |
7043 commands following the ":finally" up to the matching | |
7044 |:endtry| are executed first. This process applies to | |
7045 all nested ":try"s inside the loop. The outermost | |
7046 ":endtry" then jumps to the command after the loop. | |
7 | 7047 |
7048 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
7049 :endt[ry] Change the error handling for the commands between | |
7050 ":try" and ":endtry" including everything being | |
7051 executed across ":source" commands, function calls, | |
7052 or autocommand invocations. | |
7053 | |
7054 When an error or interrupt is detected and there is | |
7055 a |:finally| command following, execution continues | |
7056 after the ":finally". Otherwise, or when the | |
7057 ":endtry" is reached thereafter, the next | |
7058 (dynamically) surrounding ":try" is checked for | |
7059 a corresponding ":finally" etc. Then the script | |
7060 processing is terminated. (Whether a function | |
7061 definition has an "abort" argument does not matter.) | |
7062 Example: > | |
7063 :try | edit too much | finally | echo "cleanup" | endtry | |
7064 :echo "impossible" " not reached, script terminated above | |
7065 < | |
7066 Moreover, an error or interrupt (dynamically) inside | |
7067 ":try" and ":endtry" is converted to an exception. It | |
7068 can be caught as if it were thrown by a |:throw| | |
7069 command (see |:catch|). In this case, the script | |
7070 processing is not terminated. | |
7071 | |
7072 The value "Vim:Interrupt" is used for an interrupt | |
7073 exception. An error in a Vim command is converted | |
7074 to a value of the form "Vim({command}):{errmsg}", | |
7075 other errors are converted to a value of the form | |
7076 "Vim:{errmsg}". {command} is the full command name, | |
7077 and {errmsg} is the message that is displayed if the | |
7078 error exception is not caught, always beginning with | |
7079 the error number. | |
7080 Examples: > | |
7081 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
7082 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
7083 < | |
7084 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7085 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 7086 |:finally|, or |:endtry| that belongs to the same |
7087 |:try| as the ":catch" are executed when an exception | |
7088 matching {pattern} is being thrown and has not yet | |
7089 been caught by a previous ":catch". Otherwise, these | |
7090 commands are skipped. | |
7091 When {pattern} is omitted all errors are caught. | |
7092 Examples: > | |
7093 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
7094 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
7095 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
7096 :catch /^Vim(write):/ " catch all errors in :write | |
7097 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
7098 :catch /my-exception/ " catch user exception | |
7099 :catch /.*/ " catch everything | |
7100 :catch " same as /.*/ | |
7101 < | |
7102 Another character can be used instead of / around the | |
7103 {pattern}, so long as it does not have a special | |
7104 meaning (e.g., '|' or '"') and doesn't occur inside | |
7105 {pattern}. | |
7106 NOTE: It is not reliable to ":catch" the TEXT of | |
7107 an error message because it may vary in different | |
7108 locales. | |
7109 | |
7110 *:fina* *:finally* *E606* *E607* | |
7111 :fina[lly] The following commands until the matching |:endtry| | |
7112 are executed whenever the part between the matching | |
7113 |:try| and the ":finally" is left: either by falling | |
7114 through to the ":finally" or by a |:continue|, | |
7115 |:break|, |:finish|, or |:return|, or by an error or | |
7116 interrupt or exception (see |:throw|). | |
7117 | |
7118 *:th* *:throw* *E608* | |
7119 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
7120 If the ":throw" is used after a |:try| but before the | |
7121 first corresponding |:catch|, commands are skipped | |
7122 until the first ":catch" matching {expr1} is reached. | |
7123 If there is no such ":catch" or if the ":throw" is | |
7124 used after a ":catch" but before the |:finally|, the | |
7125 commands following the ":finally" (if present) up to | |
7126 the matching |:endtry| are executed. If the ":throw" | |
7127 is after the ":finally", commands up to the ":endtry" | |
7128 are skipped. At the ":endtry", this process applies | |
7129 again for the next dynamically surrounding ":try" | |
7130 (which may be found in a calling function or sourcing | |
7131 script), until a matching ":catch" has been found. | |
7132 If the exception is not caught, the command processing | |
7133 is terminated. | |
7134 Example: > | |
7135 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 7136 < Note that "catch" may need to be on a separate line |
7137 for when an error causes the parsing to skip the whole | |
7138 line and not see the "|" that separates the commands. | |
7 | 7139 |
7140 *:ec* *:echo* | |
7141 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
7142 first {expr1} starts on a new line. | |
7143 Also see |:comment|. | |
7144 Use "\n" to start a new line. Use "\r" to move the | |
7145 cursor to the first column. | |
7146 Uses the highlighting set by the |:echohl| command. | |
7147 Cannot be followed by a comment. | |
7148 Example: > | |
7149 :echo "the value of 'shell' is" &shell | |
1156 | 7150 < *:echo-redraw* |
7151 A later redraw may make the message disappear again. | |
7152 And since Vim mostly postpones redrawing until it's | |
7153 finished with a sequence of commands this happens | |
7154 quite often. To avoid that a command from before the | |
7155 ":echo" causes a redraw afterwards (redraws are often | |
7156 postponed until you type something), force a redraw | |
7157 with the |:redraw| command. Example: > | |
7 | 7158 :new | redraw | echo "there is a new window" |
7159 < | |
7160 *:echon* | |
7161 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
7162 |:comment|. | |
7163 Uses the highlighting set by the |:echohl| command. | |
7164 Cannot be followed by a comment. | |
7165 Example: > | |
7166 :echon "the value of 'shell' is " &shell | |
7167 < | |
7168 Note the difference between using ":echo", which is a | |
7169 Vim command, and ":!echo", which is an external shell | |
7170 command: > | |
7171 :!echo % --> filename | |
7172 < The arguments of ":!" are expanded, see |:_%|. > | |
7173 :!echo "%" --> filename or "filename" | |
7174 < Like the previous example. Whether you see the double | |
7175 quotes or not depends on your 'shell'. > | |
7176 :echo % --> nothing | |
7177 < The '%' is an illegal character in an expression. > | |
7178 :echo "%" --> % | |
7179 < This just echoes the '%' character. > | |
7180 :echo expand("%") --> filename | |
7181 < This calls the expand() function to expand the '%'. | |
7182 | |
7183 *:echoh* *:echohl* | |
7184 :echoh[l] {name} Use the highlight group {name} for the following | |
7185 |:echo|, |:echon| and |:echomsg| commands. Also used | |
7186 for the |input()| prompt. Example: > | |
7187 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
7188 < Don't forget to set the group back to "None", | |
7189 otherwise all following echo's will be highlighted. | |
7190 | |
7191 *:echom* *:echomsg* | |
7192 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
7193 message in the |message-history|. | |
7194 Spaces are placed between the arguments as with the | |
7195 |:echo| command. But unprintable characters are | |
7196 displayed, not interpreted. | |
1156 | 7197 The parsing works slightly different from |:echo|, |
7198 more like |:execute|. All the expressions are first | |
7199 evaluated and concatenated before echoing anything. | |
7200 The expressions must evaluate to a Number or String, a | |
7201 Dictionary or List causes an error. | |
7 | 7202 Uses the highlighting set by the |:echohl| command. |
7203 Example: > | |
7204 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 7205 < See |:echo-redraw| to avoid the message disappearing |
7206 when the screen is redrawn. | |
7 | 7207 *:echoe* *:echoerr* |
7208 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
7209 message in the |message-history|. When used in a | |
7210 script or function the line number will be added. | |
7211 Spaces are placed between the arguments as with the | |
1621 | 7212 :echo command. When used inside a try conditional, |
7 | 7213 the message is raised as an error exception instead |
7214 (see |try-echoerr|). | |
7215 Example: > | |
7216 :echoerr "This script just failed!" | |
7217 < If you just want a highlighted message use |:echohl|. | |
7218 And to get a beep: > | |
7219 :exe "normal \<Esc>" | |
7220 < | |
7221 *:exe* *:execute* | |
7222 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 7223 of {expr1} as an Ex command. |
7224 Multiple arguments are concatenated, with a space in | |
7225 between. To avoid the extra space use the "." | |
7226 operator to concatenate strings into one argument. | |
7227 {expr1} is used as the processed command, command line | |
7228 editing keys are not recognized. | |
7 | 7229 Cannot be followed by a comment. |
7230 Examples: > | |
2152 | 7231 :execute "buffer" nextbuf |
7232 :execute "normal" count . "w" | |
7 | 7233 < |
7234 ":execute" can be used to append a command to commands | |
7235 that don't accept a '|'. Example: > | |
7236 :execute '!ls' | echo "theend" | |
7237 | |
7238 < ":execute" is also a nice way to avoid having to type | |
7239 control characters in a Vim script for a ":normal" | |
7240 command: > | |
7241 :execute "normal ixxx\<Esc>" | |
7242 < This has an <Esc> character, see |expr-string|. | |
7243 | |
1621 | 7244 Be careful to correctly escape special characters in |
7245 file names. The |fnameescape()| function can be used | |
1661 | 7246 for Vim commands, |shellescape()| for |:!| commands. |
7247 Examples: > | |
1621 | 7248 :execute "e " . fnameescape(filename) |
1661 | 7249 :execute "!ls " . shellescape(expand('%:h'), 1) |
1621 | 7250 < |
7 | 7251 Note: The executed string may be any command-line, but |
99 | 7252 you cannot start or end a "while", "for" or "if" |
7253 command. Thus this is illegal: > | |
7 | 7254 :execute 'while i > 5' |
7255 :execute 'echo "test" | break' | |
7256 < | |
7257 It is allowed to have a "while" or "if" command | |
7258 completely in the executed string: > | |
7259 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
7260 < | |
7261 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7262 *:exe-comment* |
7 | 7263 ":execute", ":echo" and ":echon" cannot be followed by |
7264 a comment directly, because they see the '"' as the | |
7265 start of a string. But, you can use '|' followed by a | |
7266 comment. Example: > | |
7267 :echo "foo" | "this is a comment | |
7268 | |
7269 ============================================================================== | |
7270 8. Exception handling *exception-handling* | |
7271 | |
7272 The Vim script language comprises an exception handling feature. This section | |
7273 explains how it can be used in a Vim script. | |
7274 | |
7275 Exceptions may be raised by Vim on an error or on interrupt, see | |
7276 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
7277 exception by using the ":throw" command, see |throw-catch|. | |
7278 | |
7279 | |
7280 TRY CONDITIONALS *try-conditionals* | |
7281 | |
7282 Exceptions can be caught or can cause cleanup code to be executed. You can | |
7283 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
7284 a finally clause (to be executed for cleanup). | |
7285 A try conditional begins with a |:try| command and ends at the matching | |
7286 |:endtry| command. In between, you can use a |:catch| command to start | |
7287 a catch clause, or a |:finally| command to start a finally clause. There may | |
7288 be none or multiple catch clauses, but there is at most one finally clause, | |
7289 which must not be followed by any catch clauses. The lines before the catch | |
7290 clauses and the finally clause is called a try block. > | |
7291 | |
7292 :try | |
1621 | 7293 : ... |
7294 : ... TRY BLOCK | |
7295 : ... | |
7 | 7296 :catch /{pattern}/ |
1621 | 7297 : ... |
7298 : ... CATCH CLAUSE | |
7299 : ... | |
7 | 7300 :catch /{pattern}/ |
1621 | 7301 : ... |
7302 : ... CATCH CLAUSE | |
7303 : ... | |
7 | 7304 :finally |
1621 | 7305 : ... |
7306 : ... FINALLY CLAUSE | |
7307 : ... | |
7 | 7308 :endtry |
7309 | |
7310 The try conditional allows to watch code for exceptions and to take the | |
7311 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
7312 from the try block and also the catch clauses may cause cleanup actions. | |
7313 When no exception is thrown during execution of the try block, the control | |
7314 is transferred to the finally clause, if present. After its execution, the | |
7315 script continues with the line following the ":endtry". | |
7316 When an exception occurs during execution of the try block, the remaining | |
7317 lines in the try block are skipped. The exception is matched against the | |
7318 patterns specified as arguments to the ":catch" commands. The catch clause | |
7319 after the first matching ":catch" is taken, other catch clauses are not | |
7320 executed. The catch clause ends when the next ":catch", ":finally", or | |
7321 ":endtry" command is reached - whatever is first. Then, the finally clause | |
7322 (if present) is executed. When the ":endtry" is reached, the script execution | |
7323 continues in the following line as usual. | |
7324 When an exception that does not match any of the patterns specified by the | |
7325 ":catch" commands is thrown in the try block, the exception is not caught by | |
7326 that try conditional and none of the catch clauses is executed. Only the | |
7327 finally clause, if present, is taken. The exception pends during execution of | |
7328 the finally clause. It is resumed at the ":endtry", so that commands after | |
7329 the ":endtry" are not executed and the exception might be caught elsewhere, | |
7330 see |try-nesting|. | |
7331 When during execution of a catch clause another exception is thrown, the | |
1621 | 7332 remaining lines in that catch clause are not executed. The new exception is |
7 | 7333 not matched against the patterns in any of the ":catch" commands of the same |
7334 try conditional and none of its catch clauses is taken. If there is, however, | |
7335 a finally clause, it is executed, and the exception pends during its | |
7336 execution. The commands following the ":endtry" are not executed. The new | |
7337 exception might, however, be caught elsewhere, see |try-nesting|. | |
7338 When during execution of the finally clause (if present) an exception is | |
1621 | 7339 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 7340 clause has been taken because of an exception from the try block or one of the |
7341 catch clauses, the original (pending) exception is discarded. The commands | |
7342 following the ":endtry" are not executed, and the exception from the finally | |
7343 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
7344 | |
7345 The finally clause is also executed, when a ":break" or ":continue" for | |
7346 a ":while" loop enclosing the complete try conditional is executed from the | |
7347 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
7348 from the try block or a catch clause of a try conditional in a function or | |
7349 sourced script, respectively. The ":break", ":continue", ":return", or | |
7350 ":finish" pends during execution of the finally clause and is resumed when the | |
7351 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
7352 from the finally clause. | |
7353 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
7354 try conditional or when a ":return" or ":finish" is encountered in the finally | |
7355 clause, the rest of the finally clause is skipped, and the ":break", | |
7356 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
7357 clause has been taken because of an exception or an earlier ":break", | |
7358 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
7359 this pending exception or command is discarded. | |
7360 | |
7361 For examples see |throw-catch| and |try-finally|. | |
7362 | |
7363 | |
7364 NESTING OF TRY CONDITIONALS *try-nesting* | |
7365 | |
7366 Try conditionals can be nested arbitrarily. That is, a complete try | |
7367 conditional can be put into the try block, a catch clause, or the finally | |
7368 clause of another try conditional. If the inner try conditional does not | |
7369 catch an exception thrown in its try block or throws a new exception from one | |
7370 of its catch clauses or its finally clause, the outer try conditional is | |
7371 checked according to the rules above. If the inner try conditional is in the | |
7372 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 7373 otherwise only the finally clause is executed. It does not matter for |
7 | 7374 nesting, whether the inner try conditional is directly contained in the outer |
7375 one, or whether the outer one sources a script or calls a function containing | |
7376 the inner try conditional. | |
7377 | |
7378 When none of the active try conditionals catches an exception, just their | |
7379 finally clauses are executed. Thereafter, the script processing terminates. | |
7380 An error message is displayed in case of an uncaught exception explicitly | |
7381 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
7382 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
7383 as usual. | |
7384 | |
7385 For examples see |throw-catch|. | |
7386 | |
7387 | |
7388 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
7389 | |
7390 Exception handling code can get tricky. If you are in doubt what happens, set | |
7391 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
7392 script file. Then you see when an exception is thrown, discarded, caught, or | |
7393 finished. When using a verbosity level of at least 14, things pending in | |
7394 a finally clause are also shown. This information is also given in debug mode | |
7395 (see |debug-scripts|). | |
7396 | |
7397 | |
7398 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
7399 | |
7400 You can throw any number or string as an exception. Use the |:throw| command | |
7401 and pass the value to be thrown as argument: > | |
7402 :throw 4711 | |
7403 :throw "string" | |
7404 < *throw-expression* | |
7405 You can also specify an expression argument. The expression is then evaluated | |
7406 first, and the result is thrown: > | |
7407 :throw 4705 + strlen("string") | |
7408 :throw strpart("strings", 0, 6) | |
7409 | |
7410 An exception might be thrown during evaluation of the argument of the ":throw" | |
7411 command. Unless it is caught there, the expression evaluation is abandoned. | |
7412 The ":throw" command then does not throw a new exception. | |
7413 Example: > | |
7414 | |
7415 :function! Foo(arg) | |
7416 : try | |
7417 : throw a:arg | |
7418 : catch /foo/ | |
7419 : endtry | |
7420 : return 1 | |
7421 :endfunction | |
7422 : | |
7423 :function! Bar() | |
7424 : echo "in Bar" | |
7425 : return 4710 | |
7426 :endfunction | |
7427 : | |
7428 :throw Foo("arrgh") + Bar() | |
7429 | |
7430 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
7431 executed. > | |
7432 :throw Foo("foo") + Bar() | |
7433 however displays "in Bar" and throws 4711. | |
7434 | |
7435 Any other command that takes an expression as argument might also be | |
1621 | 7436 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 7437 exception is then propagated to the caller of the command. |
7438 Example: > | |
7439 | |
7440 :if Foo("arrgh") | |
7441 : echo "then" | |
7442 :else | |
7443 : echo "else" | |
7444 :endif | |
7445 | |
7446 Here neither of "then" or "else" is displayed. | |
7447 | |
7448 *catch-order* | |
7449 Exceptions can be caught by a try conditional with one or more |:catch| | |
7450 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
7451 command can be specified as a pattern argument. The subsequent catch clause | |
7452 gets executed when a matching exception is caught. | |
7453 Example: > | |
7454 | |
7455 :function! Foo(value) | |
7456 : try | |
7457 : throw a:value | |
7458 : catch /^\d\+$/ | |
7459 : echo "Number thrown" | |
7460 : catch /.*/ | |
7461 : echo "String thrown" | |
7462 : endtry | |
7463 :endfunction | |
7464 : | |
7465 :call Foo(0x1267) | |
7466 :call Foo('string') | |
7467 | |
7468 The first call to Foo() displays "Number thrown", the second "String thrown". | |
7469 An exception is matched against the ":catch" commands in the order they are | |
7470 specified. Only the first match counts. So you should place the more | |
7471 specific ":catch" first. The following order does not make sense: > | |
7472 | |
7473 : catch /.*/ | |
7474 : echo "String thrown" | |
7475 : catch /^\d\+$/ | |
7476 : echo "Number thrown" | |
7477 | |
7478 The first ":catch" here matches always, so that the second catch clause is | |
7479 never taken. | |
7480 | |
7481 *throw-variables* | |
7482 If you catch an exception by a general pattern, you may access the exact value | |
7483 in the variable |v:exception|: > | |
7484 | |
7485 : catch /^\d\+$/ | |
7486 : echo "Number thrown. Value is" v:exception | |
7487 | |
7488 You may also be interested where an exception was thrown. This is stored in | |
7489 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
7490 exception most recently caught as long it is not finished. | |
7491 Example: > | |
7492 | |
7493 :function! Caught() | |
7494 : if v:exception != "" | |
7495 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
7496 : else | |
7497 : echo 'Nothing caught' | |
7498 : endif | |
7499 :endfunction | |
7500 : | |
7501 :function! Foo() | |
7502 : try | |
7503 : try | |
7504 : try | |
7505 : throw 4711 | |
7506 : finally | |
7507 : call Caught() | |
7508 : endtry | |
7509 : catch /.*/ | |
7510 : call Caught() | |
7511 : throw "oops" | |
7512 : endtry | |
7513 : catch /.*/ | |
7514 : call Caught() | |
7515 : finally | |
7516 : call Caught() | |
7517 : endtry | |
7518 :endfunction | |
7519 : | |
7520 :call Foo() | |
7521 | |
7522 This displays > | |
7523 | |
7524 Nothing caught | |
7525 Caught "4711" in function Foo, line 4 | |
7526 Caught "oops" in function Foo, line 10 | |
7527 Nothing caught | |
7528 | |
7529 A practical example: The following command ":LineNumber" displays the line | |
7530 number in the script or function where it has been used: > | |
7531 | |
7532 :function! LineNumber() | |
7533 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
7534 :endfunction | |
7535 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
7536 < | |
7537 *try-nested* | |
7538 An exception that is not caught by a try conditional can be caught by | |
7539 a surrounding try conditional: > | |
7540 | |
7541 :try | |
7542 : try | |
7543 : throw "foo" | |
7544 : catch /foobar/ | |
7545 : echo "foobar" | |
7546 : finally | |
7547 : echo "inner finally" | |
7548 : endtry | |
7549 :catch /foo/ | |
7550 : echo "foo" | |
7551 :endtry | |
7552 | |
7553 The inner try conditional does not catch the exception, just its finally | |
7554 clause is executed. The exception is then caught by the outer try | |
7555 conditional. The example displays "inner finally" and then "foo". | |
7556 | |
7557 *throw-from-catch* | |
7558 You can catch an exception and throw a new one to be caught elsewhere from the | |
7559 catch clause: > | |
7560 | |
7561 :function! Foo() | |
7562 : throw "foo" | |
7563 :endfunction | |
7564 : | |
7565 :function! Bar() | |
7566 : try | |
7567 : call Foo() | |
7568 : catch /foo/ | |
7569 : echo "Caught foo, throw bar" | |
7570 : throw "bar" | |
7571 : endtry | |
7572 :endfunction | |
7573 : | |
7574 :try | |
7575 : call Bar() | |
7576 :catch /.*/ | |
7577 : echo "Caught" v:exception | |
7578 :endtry | |
7579 | |
7580 This displays "Caught foo, throw bar" and then "Caught bar". | |
7581 | |
7582 *rethrow* | |
7583 There is no real rethrow in the Vim script language, but you may throw | |
7584 "v:exception" instead: > | |
7585 | |
7586 :function! Bar() | |
7587 : try | |
7588 : call Foo() | |
7589 : catch /.*/ | |
7590 : echo "Rethrow" v:exception | |
7591 : throw v:exception | |
7592 : endtry | |
7593 :endfunction | |
7594 < *try-echoerr* | |
7595 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
7596 exceptions, because it is not possible to fake Vim internal exceptions. | |
7597 Trying so causes an error exception. You should throw your own exception | |
7598 denoting the situation. If you want to cause a Vim error exception containing | |
7599 the original error exception value, you can use the |:echoerr| command: > | |
7600 | |
7601 :try | |
7602 : try | |
7603 : asdf | |
7604 : catch /.*/ | |
7605 : echoerr v:exception | |
7606 : endtry | |
7607 :catch /.*/ | |
7608 : echo v:exception | |
7609 :endtry | |
7610 | |
7611 This code displays | |
7612 | |
1621 | 7613 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 7614 |
7615 | |
7616 CLEANUP CODE *try-finally* | |
7617 | |
7618 Scripts often change global settings and restore them at their end. If the | |
7619 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 7620 an inconsistent state. The same may happen to you in the development phase of |
7 | 7621 a script when an error occurs or you explicitly throw an exception without |
7622 catching it. You can solve these problems by using a try conditional with | |
7623 a finally clause for restoring the settings. Its execution is guaranteed on | |
7624 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
7625 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 7626 to exceptions. When not caught, they terminate the script after the finally |
7 | 7627 clause has been executed.) |
7628 Example: > | |
7629 | |
7630 :try | |
7631 : let s:saved_ts = &ts | |
7632 : set ts=17 | |
7633 : | |
7634 : " Do the hard work here. | |
7635 : | |
7636 :finally | |
7637 : let &ts = s:saved_ts | |
7638 : unlet s:saved_ts | |
7639 :endtry | |
7640 | |
7641 This method should be used locally whenever a function or part of a script | |
7642 changes global settings which need to be restored on failure or normal exit of | |
7643 that function or script part. | |
7644 | |
7645 *break-finally* | |
7646 Cleanup code works also when the try block or a catch clause is left by | |
7647 a ":continue", ":break", ":return", or ":finish". | |
7648 Example: > | |
7649 | |
7650 :let first = 1 | |
7651 :while 1 | |
7652 : try | |
7653 : if first | |
7654 : echo "first" | |
7655 : let first = 0 | |
7656 : continue | |
7657 : else | |
7658 : throw "second" | |
7659 : endif | |
7660 : catch /.*/ | |
7661 : echo v:exception | |
7662 : break | |
7663 : finally | |
7664 : echo "cleanup" | |
7665 : endtry | |
7666 : echo "still in while" | |
7667 :endwhile | |
7668 :echo "end" | |
7669 | |
7670 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
7671 | |
7672 :function! Foo() | |
7673 : try | |
7674 : return 4711 | |
7675 : finally | |
7676 : echo "cleanup\n" | |
7677 : endtry | |
7678 : echo "Foo still active" | |
7679 :endfunction | |
7680 : | |
7681 :echo Foo() "returned by Foo" | |
7682 | |
7683 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 7684 extra ":return" in the finally clause. (Above all, this would override the |
7 | 7685 return value.) |
7686 | |
7687 *except-from-finally* | |
7688 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
7689 a finally clause is possible, but not recommended since it abandons the | |
7690 cleanup actions for the try conditional. But, of course, interrupt and error | |
7691 exceptions might get raised from a finally clause. | |
7692 Example where an error in the finally clause stops an interrupt from | |
7693 working correctly: > | |
7694 | |
7695 :try | |
7696 : try | |
7697 : echo "Press CTRL-C for interrupt" | |
7698 : while 1 | |
7699 : endwhile | |
7700 : finally | |
7701 : unlet novar | |
7702 : endtry | |
7703 :catch /novar/ | |
7704 :endtry | |
7705 :echo "Script still running" | |
7706 :sleep 1 | |
7707 | |
7708 If you need to put commands that could fail into a finally clause, you should | |
7709 think about catching or ignoring the errors in these commands, see | |
7710 |catch-errors| and |ignore-errors|. | |
7711 | |
7712 | |
7713 CATCHING ERRORS *catch-errors* | |
7714 | |
7715 If you want to catch specific errors, you just have to put the code to be | |
7716 watched in a try block and add a catch clause for the error message. The | |
7717 presence of the try conditional causes all errors to be converted to an | |
7718 exception. No message is displayed and |v:errmsg| is not set then. To find | |
7719 the right pattern for the ":catch" command, you have to know how the format of | |
7720 the error exception is. | |
7721 Error exceptions have the following format: > | |
7722 | |
7723 Vim({cmdname}):{errmsg} | |
7724 or > | |
7725 Vim:{errmsg} | |
7726 | |
7727 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 7728 the command name is not known. {errmsg} is the error message usually produced |
7 | 7729 when the error occurs outside try conditionals. It always begins with |
7730 a capital "E", followed by a two or three-digit error number, a colon, and | |
7731 a space. | |
7732 | |
7733 Examples: | |
7734 | |
7735 The command > | |
7736 :unlet novar | |
7737 normally produces the error message > | |
7738 E108: No such variable: "novar" | |
7739 which is converted inside try conditionals to an exception > | |
7740 Vim(unlet):E108: No such variable: "novar" | |
7741 | |
7742 The command > | |
7743 :dwim | |
7744 normally produces the error message > | |
7745 E492: Not an editor command: dwim | |
7746 which is converted inside try conditionals to an exception > | |
7747 Vim:E492: Not an editor command: dwim | |
7748 | |
7749 You can catch all ":unlet" errors by a > | |
7750 :catch /^Vim(unlet):/ | |
7751 or all errors for misspelled command names by a > | |
7752 :catch /^Vim:E492:/ | |
7753 | |
7754 Some error messages may be produced by different commands: > | |
7755 :function nofunc | |
7756 and > | |
7757 :delfunction nofunc | |
7758 both produce the error message > | |
7759 E128: Function name must start with a capital: nofunc | |
7760 which is converted inside try conditionals to an exception > | |
7761 Vim(function):E128: Function name must start with a capital: nofunc | |
7762 or > | |
7763 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
7764 respectively. You can catch the error by its number independently on the | |
7765 command that caused it if you use the following pattern: > | |
7766 :catch /^Vim(\a\+):E128:/ | |
7767 | |
7768 Some commands like > | |
7769 :let x = novar | |
7770 produce multiple error messages, here: > | |
7771 E121: Undefined variable: novar | |
7772 E15: Invalid expression: novar | |
7773 Only the first is used for the exception value, since it is the most specific | |
7774 one (see |except-several-errors|). So you can catch it by > | |
7775 :catch /^Vim(\a\+):E121:/ | |
7776 | |
7777 You can catch all errors related to the name "nofunc" by > | |
7778 :catch /\<nofunc\>/ | |
7779 | |
7780 You can catch all Vim errors in the ":write" and ":read" commands by > | |
7781 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
7782 | |
7783 You can catch all Vim errors by the pattern > | |
7784 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
7785 < | |
7786 *catch-text* | |
7787 NOTE: You should never catch the error message text itself: > | |
7788 :catch /No such variable/ | |
7789 only works in the english locale, but not when the user has selected | |
7790 a different language by the |:language| command. It is however helpful to | |
7791 cite the message text in a comment: > | |
7792 :catch /^Vim(\a\+):E108:/ " No such variable | |
7793 | |
7794 | |
7795 IGNORING ERRORS *ignore-errors* | |
7796 | |
7797 You can ignore errors in a specific Vim command by catching them locally: > | |
7798 | |
7799 :try | |
7800 : write | |
7801 :catch | |
7802 :endtry | |
7803 | |
7804 But you are strongly recommended NOT to use this simple form, since it could | |
7805 catch more than you want. With the ":write" command, some autocommands could | |
7806 be executed and cause errors not related to writing, for instance: > | |
7807 | |
7808 :au BufWritePre * unlet novar | |
7809 | |
7810 There could even be such errors you are not responsible for as a script | |
7811 writer: a user of your script might have defined such autocommands. You would | |
7812 then hide the error from the user. | |
7813 It is much better to use > | |
7814 | |
7815 :try | |
7816 : write | |
7817 :catch /^Vim(write):/ | |
7818 :endtry | |
7819 | |
7820 which only catches real write errors. So catch only what you'd like to ignore | |
7821 intentionally. | |
7822 | |
7823 For a single command that does not cause execution of autocommands, you could | |
7824 even suppress the conversion of errors to exceptions by the ":silent!" | |
7825 command: > | |
7826 :silent! nunmap k | |
7827 This works also when a try conditional is active. | |
7828 | |
7829 | |
7830 CATCHING INTERRUPTS *catch-interrupt* | |
7831 | |
7832 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 7833 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 7834 script is not terminated, then. |
7835 Example: > | |
7836 | |
7837 :function! TASK1() | |
7838 : sleep 10 | |
7839 :endfunction | |
7840 | |
7841 :function! TASK2() | |
7842 : sleep 20 | |
7843 :endfunction | |
7844 | |
7845 :while 1 | |
7846 : let command = input("Type a command: ") | |
7847 : try | |
7848 : if command == "" | |
7849 : continue | |
7850 : elseif command == "END" | |
7851 : break | |
7852 : elseif command == "TASK1" | |
7853 : call TASK1() | |
7854 : elseif command == "TASK2" | |
7855 : call TASK2() | |
7856 : else | |
7857 : echo "\nIllegal command:" command | |
7858 : continue | |
7859 : endif | |
7860 : catch /^Vim:Interrupt$/ | |
7861 : echo "\nCommand interrupted" | |
7862 : " Caught the interrupt. Continue with next prompt. | |
7863 : endtry | |
7864 :endwhile | |
7865 | |
7866 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 7867 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 7868 |
7869 For testing what happens when CTRL-C would be pressed on a specific line in | |
7870 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
7871 command on that line. See |debug-scripts|. | |
7872 | |
7873 | |
7874 CATCHING ALL *catch-all* | |
7875 | |
7876 The commands > | |
7877 | |
7878 :catch /.*/ | |
7879 :catch // | |
7880 :catch | |
7881 | |
7882 catch everything, error exceptions, interrupt exceptions and exceptions | |
7883 explicitly thrown by the |:throw| command. This is useful at the top level of | |
7884 a script in order to catch unexpected things. | |
7885 Example: > | |
7886 | |
7887 :try | |
7888 : | |
7889 : " do the hard work here | |
7890 : | |
7891 :catch /MyException/ | |
7892 : | |
7893 : " handle known problem | |
7894 : | |
7895 :catch /^Vim:Interrupt$/ | |
7896 : echo "Script interrupted" | |
7897 :catch /.*/ | |
7898 : echo "Internal error (" . v:exception . ")" | |
7899 : echo " - occurred at " . v:throwpoint | |
7900 :endtry | |
7901 :" end of script | |
7902 | |
7903 Note: Catching all might catch more things than you want. Thus, you are | |
7904 strongly encouraged to catch only for problems that you can really handle by | |
7905 specifying a pattern argument to the ":catch". | |
7906 Example: Catching all could make it nearly impossible to interrupt a script | |
7907 by pressing CTRL-C: > | |
7908 | |
7909 :while 1 | |
7910 : try | |
7911 : sleep 1 | |
7912 : catch | |
7913 : endtry | |
7914 :endwhile | |
7915 | |
7916 | |
7917 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
7918 | |
7919 Exceptions may be used during execution of autocommands. Example: > | |
7920 | |
7921 :autocmd User x try | |
7922 :autocmd User x throw "Oops!" | |
7923 :autocmd User x catch | |
7924 :autocmd User x echo v:exception | |
7925 :autocmd User x endtry | |
7926 :autocmd User x throw "Arrgh!" | |
7927 :autocmd User x echo "Should not be displayed" | |
7928 : | |
7929 :try | |
7930 : doautocmd User x | |
7931 :catch | |
7932 : echo v:exception | |
7933 :endtry | |
7934 | |
7935 This displays "Oops!" and "Arrgh!". | |
7936 | |
7937 *except-autocmd-Pre* | |
7938 For some commands, autocommands get executed before the main action of the | |
7939 command takes place. If an exception is thrown and not caught in the sequence | |
7940 of autocommands, the sequence and the command that caused its execution are | |
7941 abandoned and the exception is propagated to the caller of the command. | |
7942 Example: > | |
7943 | |
7944 :autocmd BufWritePre * throw "FAIL" | |
7945 :autocmd BufWritePre * echo "Should not be displayed" | |
7946 : | |
7947 :try | |
7948 : write | |
7949 :catch | |
7950 : echo "Caught:" v:exception "from" v:throwpoint | |
7951 :endtry | |
7952 | |
7953 Here, the ":write" command does not write the file currently being edited (as | |
7954 you can see by checking 'modified'), since the exception from the BufWritePre | |
7955 autocommand abandons the ":write". The exception is then caught and the | |
7956 script displays: > | |
7957 | |
7958 Caught: FAIL from BufWrite Auto commands for "*" | |
7959 < | |
7960 *except-autocmd-Post* | |
7961 For some commands, autocommands get executed after the main action of the | |
7962 command has taken place. If this main action fails and the command is inside | |
7963 an active try conditional, the autocommands are skipped and an error exception | |
7964 is thrown that can be caught by the caller of the command. | |
7965 Example: > | |
7966 | |
7967 :autocmd BufWritePost * echo "File successfully written!" | |
7968 : | |
7969 :try | |
7970 : write /i/m/p/o/s/s/i/b/l/e | |
7971 :catch | |
7972 : echo v:exception | |
7973 :endtry | |
7974 | |
7975 This just displays: > | |
7976 | |
7977 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
7978 | |
7979 If you really need to execute the autocommands even when the main action | |
7980 fails, trigger the event from the catch clause. | |
7981 Example: > | |
7982 | |
7983 :autocmd BufWritePre * set noreadonly | |
7984 :autocmd BufWritePost * set readonly | |
7985 : | |
7986 :try | |
7987 : write /i/m/p/o/s/s/i/b/l/e | |
7988 :catch | |
7989 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
7990 :endtry | |
7991 < | |
7992 You can also use ":silent!": > | |
7993 | |
7994 :let x = "ok" | |
7995 :let v:errmsg = "" | |
7996 :autocmd BufWritePost * if v:errmsg != "" | |
7997 :autocmd BufWritePost * let x = "after fail" | |
7998 :autocmd BufWritePost * endif | |
7999 :try | |
8000 : silent! write /i/m/p/o/s/s/i/b/l/e | |
8001 :catch | |
8002 :endtry | |
8003 :echo x | |
8004 | |
8005 This displays "after fail". | |
8006 | |
8007 If the main action of the command does not fail, exceptions from the | |
8008 autocommands will be catchable by the caller of the command: > | |
8009 | |
8010 :autocmd BufWritePost * throw ":-(" | |
8011 :autocmd BufWritePost * echo "Should not be displayed" | |
8012 : | |
8013 :try | |
8014 : write | |
8015 :catch | |
8016 : echo v:exception | |
8017 :endtry | |
8018 < | |
8019 *except-autocmd-Cmd* | |
8020 For some commands, the normal action can be replaced by a sequence of | |
8021 autocommands. Exceptions from that sequence will be catchable by the caller | |
8022 of the command. | |
8023 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 8024 had actually been written when the exception occurred. You need to tell it in |
7 | 8025 some way. > |
8026 | |
8027 :if !exists("cnt") | |
8028 : let cnt = 0 | |
8029 : | |
8030 : autocmd BufWriteCmd * if &modified | |
8031 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
8032 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
8033 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8034 : autocmd BufWriteCmd * endif | |
8035 : autocmd BufWriteCmd * write | set nomodified | |
8036 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
8037 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8038 : autocmd BufWriteCmd * endif | |
8039 : autocmd BufWriteCmd * echo "File successfully written!" | |
8040 : autocmd BufWriteCmd * endif | |
8041 :endif | |
8042 : | |
8043 :try | |
8044 : write | |
8045 :catch /^BufWriteCmdError$/ | |
8046 : if &modified | |
8047 : echo "Error on writing (file contents not changed)" | |
8048 : else | |
8049 : echo "Error after writing" | |
8050 : endif | |
8051 :catch /^Vim(write):/ | |
8052 : echo "Error on writing" | |
8053 :endtry | |
8054 | |
8055 When this script is sourced several times after making changes, it displays | |
8056 first > | |
8057 File successfully written! | |
8058 then > | |
8059 Error on writing (file contents not changed) | |
8060 then > | |
8061 Error after writing | |
8062 etc. | |
8063 | |
8064 *except-autocmd-ill* | |
8065 You cannot spread a try conditional over autocommands for different events. | |
8066 The following code is ill-formed: > | |
8067 | |
8068 :autocmd BufWritePre * try | |
8069 : | |
8070 :autocmd BufWritePost * catch | |
8071 :autocmd BufWritePost * echo v:exception | |
8072 :autocmd BufWritePost * endtry | |
8073 : | |
8074 :write | |
8075 | |
8076 | |
8077 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
8078 | |
8079 Some programming languages allow to use hierarchies of exception classes or to | |
8080 pass additional information with the object of an exception class. You can do | |
8081 similar things in Vim. | |
8082 In order to throw an exception from a hierarchy, just throw the complete | |
8083 class name with the components separated by a colon, for instance throw the | |
8084 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
8085 When you want to pass additional information with your exception class, add | |
8086 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
8087 for an error when writing "myfile". | |
8088 With the appropriate patterns in the ":catch" command, you can catch for | |
8089 base classes or derived classes of your hierarchy. Additional information in | |
8090 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
8091 Example: > | |
8092 | |
8093 :function! CheckRange(a, func) | |
8094 : if a:a < 0 | |
8095 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
8096 : endif | |
8097 :endfunction | |
8098 : | |
8099 :function! Add(a, b) | |
8100 : call CheckRange(a:a, "Add") | |
8101 : call CheckRange(a:b, "Add") | |
8102 : let c = a:a + a:b | |
8103 : if c < 0 | |
8104 : throw "EXCEPT:MATHERR:OVERFLOW" | |
8105 : endif | |
8106 : return c | |
8107 :endfunction | |
8108 : | |
8109 :function! Div(a, b) | |
8110 : call CheckRange(a:a, "Div") | |
8111 : call CheckRange(a:b, "Div") | |
8112 : if (a:b == 0) | |
8113 : throw "EXCEPT:MATHERR:ZERODIV" | |
8114 : endif | |
8115 : return a:a / a:b | |
8116 :endfunction | |
8117 : | |
8118 :function! Write(file) | |
8119 : try | |
1621 | 8120 : execute "write" fnameescape(a:file) |
7 | 8121 : catch /^Vim(write):/ |
8122 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
8123 : endtry | |
8124 :endfunction | |
8125 : | |
8126 :try | |
8127 : | |
8128 : " something with arithmetics and I/O | |
8129 : | |
8130 :catch /^EXCEPT:MATHERR:RANGE/ | |
8131 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
8132 : echo "Range error in" function | |
8133 : | |
8134 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
8135 : echo "Math error" | |
8136 : | |
8137 :catch /^EXCEPT:IO/ | |
8138 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
8139 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
8140 : if file !~ '^/' | |
8141 : let file = dir . "/" . file | |
8142 : endif | |
8143 : echo 'I/O error for "' . file . '"' | |
8144 : | |
8145 :catch /^EXCEPT/ | |
8146 : echo "Unspecified error" | |
8147 : | |
8148 :endtry | |
8149 | |
8150 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
8151 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
8152 exceptions with the "Vim" prefix; they are reserved for Vim. | |
8153 Vim error exceptions are parameterized with the name of the command that | |
8154 failed, if known. See |catch-errors|. | |
8155 | |
8156 | |
8157 PECULIARITIES | |
8158 *except-compat* | |
8159 The exception handling concept requires that the command sequence causing the | |
8160 exception is aborted immediately and control is transferred to finally clauses | |
8161 and/or a catch clause. | |
8162 | |
8163 In the Vim script language there are cases where scripts and functions | |
8164 continue after an error: in functions without the "abort" flag or in a command | |
8165 after ":silent!", control flow goes to the following line, and outside | |
8166 functions, control flow goes to the line following the outermost ":endwhile" | |
8167 or ":endif". On the other hand, errors should be catchable as exceptions | |
8168 (thus, requiring the immediate abortion). | |
8169 | |
8170 This problem has been solved by converting errors to exceptions and using | |
8171 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 8172 conditional is active. This is no restriction since an (error) exception can |
8173 be caught only from an active try conditional. If you want an immediate | |
7 | 8174 termination without catching the error, just use a try conditional without |
8175 catch clause. (You can cause cleanup code being executed before termination | |
8176 by specifying a finally clause.) | |
8177 | |
8178 When no try conditional is active, the usual abortion and continuation | |
8179 behavior is used instead of immediate abortion. This ensures compatibility of | |
8180 scripts written for Vim 6.1 and earlier. | |
8181 | |
8182 However, when sourcing an existing script that does not use exception handling | |
8183 commands (or when calling one of its functions) from inside an active try | |
8184 conditional of a new script, you might change the control flow of the existing | |
8185 script on error. You get the immediate abortion on error and can catch the | |
8186 error in the new script. If however the sourced script suppresses error | |
8187 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 8188 |v:errmsg| if appropriate), its execution path is not changed. The error is |
8189 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 8190 where this happens is for scripts that don't care about errors and produce |
8191 error messages. You probably won't want to use such code from your new | |
8192 scripts. | |
8193 | |
8194 *except-syntax-err* | |
8195 Syntax errors in the exception handling commands are never caught by any of | |
8196 the ":catch" commands of the try conditional they belong to. Its finally | |
8197 clauses, however, is executed. | |
8198 Example: > | |
8199 | |
8200 :try | |
8201 : try | |
8202 : throw 4711 | |
8203 : catch /\(/ | |
8204 : echo "in catch with syntax error" | |
8205 : catch | |
8206 : echo "inner catch-all" | |
8207 : finally | |
8208 : echo "inner finally" | |
8209 : endtry | |
8210 :catch | |
8211 : echo 'outer catch-all caught "' . v:exception . '"' | |
8212 : finally | |
8213 : echo "outer finally" | |
8214 :endtry | |
8215 | |
8216 This displays: > | |
8217 inner finally | |
8218 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
8219 outer finally | |
8220 The original exception is discarded and an error exception is raised, instead. | |
8221 | |
8222 *except-single-line* | |
8223 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
8224 a single line, but then syntax errors may make it difficult to recognize the | |
8225 "catch" line, thus you better avoid this. | |
8226 Example: > | |
8227 :try | unlet! foo # | catch | endtry | |
8228 raises an error exception for the trailing characters after the ":unlet!" | |
8229 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
8230 error exception is discarded and the "E488: Trailing characters" message gets | |
8231 displayed. | |
8232 | |
8233 *except-several-errors* | |
8234 When several errors appear in a single command, the first error message is | |
8235 usually the most specific one and therefor converted to the error exception. | |
8236 Example: > | |
8237 echo novar | |
8238 causes > | |
8239 E121: Undefined variable: novar | |
8240 E15: Invalid expression: novar | |
8241 The value of the error exception inside try conditionals is: > | |
8242 Vim(echo):E121: Undefined variable: novar | |
8243 < *except-syntax-error* | |
8244 But when a syntax error is detected after a normal error in the same command, | |
8245 the syntax error is used for the exception being thrown. | |
8246 Example: > | |
8247 unlet novar # | |
8248 causes > | |
8249 E108: No such variable: "novar" | |
8250 E488: Trailing characters | |
8251 The value of the error exception inside try conditionals is: > | |
8252 Vim(unlet):E488: Trailing characters | |
8253 This is done because the syntax error might change the execution path in a way | |
8254 not intended by the user. Example: > | |
8255 try | |
8256 try | unlet novar # | catch | echo v:exception | endtry | |
8257 catch /.*/ | |
8258 echo "outer catch:" v:exception | |
8259 endtry | |
8260 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
8261 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
8262 | |
8263 ============================================================================== | |
8264 9. Examples *eval-examples* | |
8265 | |
1156 | 8266 Printing in Binary ~ |
7 | 8267 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8268 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 8269 :func Nr2Bin(nr) |
7 | 8270 : let n = a:nr |
8271 : let r = "" | |
8272 : while n | |
1156 | 8273 : let r = '01'[n % 2] . r |
8274 : let n = n / 2 | |
7 | 8275 : endwhile |
8276 : return r | |
8277 :endfunc | |
8278 | |
1156 | 8279 :" The function String2Bin() converts each character in a string to a |
8280 :" binary string, separated with dashes. | |
8281 :func String2Bin(str) | |
7 | 8282 : let out = '' |
1156 | 8283 : for ix in range(strlen(a:str)) |
8284 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
8285 : endfor | |
8286 : return out[1:] | |
7 | 8287 :endfunc |
8288 | |
8289 Example of its use: > | |
1156 | 8290 :echo Nr2Bin(32) |
8291 result: "100000" > | |
8292 :echo String2Bin("32") | |
8293 result: "110011-110010" | |
8294 | |
8295 | |
8296 Sorting lines ~ | |
8297 | |
8298 This example sorts lines with a specific compare function. > | |
8299 | |
8300 :func SortBuffer() | |
8301 : let lines = getline(1, '$') | |
8302 : call sort(lines, function("Strcmp")) | |
8303 : call setline(1, lines) | |
7 | 8304 :endfunction |
8305 | |
1156 | 8306 As a one-liner: > |
8307 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
8308 | |
8309 | |
8310 scanf() replacement ~ | |
7 | 8311 *sscanf* |
8312 There is no sscanf() function in Vim. If you need to extract parts from a | |
8313 line, you can use matchstr() and substitute() to do it. This example shows | |
8314 how to get the file name, line number and column number out of a line like | |
8315 "foobar.txt, 123, 45". > | |
8316 :" Set up the match bit | |
8317 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
8318 :"get the part matching the whole expression | |
8319 :let l = matchstr(line, mx) | |
8320 :"get each item out of the match | |
8321 :let file = substitute(l, mx, '\1', '') | |
8322 :let lnum = substitute(l, mx, '\2', '') | |
8323 :let col = substitute(l, mx, '\3', '') | |
8324 | |
8325 The input is in the variable "line", the results in the variables "file", | |
8326 "lnum" and "col". (idea from Michael Geddes) | |
8327 | |
1156 | 8328 |
8329 getting the scriptnames in a Dictionary ~ | |
8330 *scriptnames-dictionary* | |
8331 The |:scriptnames| command can be used to get a list of all script files that | |
8332 have been sourced. There is no equivalent function or variable for this | |
8333 (because it's rarely needed). In case you need to manipulate the list this | |
8334 code can be used: > | |
8335 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
8336 let scriptnames_output = '' | |
8337 redir => scriptnames_output | |
8338 silent scriptnames | |
8339 redir END | |
8340 | |
1621 | 8341 " Split the output into lines and parse each line. Add an entry to the |
1156 | 8342 " "scripts" dictionary. |
8343 let scripts = {} | |
8344 for line in split(scriptnames_output, "\n") | |
8345 " Only do non-blank lines. | |
8346 if line =~ '\S' | |
8347 " Get the first number in the line. | |
1621 | 8348 let nr = matchstr(line, '\d\+') |
1156 | 8349 " Get the file name, remove the script number " 123: ". |
1621 | 8350 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 8351 " Add an item to the Dictionary |
1621 | 8352 let scripts[nr] = name |
1156 | 8353 endif |
8354 endfor | |
8355 unlet scriptnames_output | |
8356 | |
7 | 8357 ============================================================================== |
8358 10. No +eval feature *no-eval-feature* | |
8359 | |
8360 When the |+eval| feature was disabled at compile time, none of the expression | |
8361 evaluation commands are available. To prevent this from causing Vim scripts | |
8362 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
8363 recognized, though the argument of the ":if" and everything between the ":if" | |
8364 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
8365 only if the commands are at the start of the line. The ":else" command is not | |
8366 recognized. | |
8367 | |
8368 Example of how to avoid executing commands when the |+eval| feature is | |
8369 missing: > | |
8370 | |
8371 :if 1 | |
8372 : echo "Expression evaluation is compiled in" | |
8373 :else | |
8374 : echo "You will _never_ see this message" | |
8375 :endif | |
8376 | |
8377 ============================================================================== | |
8378 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
8379 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8380 The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8381 'foldtext' options may be evaluated in a sandbox. This means that you are |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8382 protected from these expressions having nasty side effects. This gives some |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8383 safety for when these options are set from a modeline. It is also used when |
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8384 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 8385 The sandbox is also used for the |:sandbox| command. |
7 | 8386 |
8387 These items are not allowed in the sandbox: | |
8388 - changing the buffer text | |
8389 - defining or changing mapping, autocommands, functions, user commands | |
8390 - setting certain options (see |option-summary|) | |
1156 | 8391 - setting certain v: variables (see |v:var|) *E794* |
7 | 8392 - executing a shell command |
8393 - reading or writing a file | |
8394 - jumping to another buffer or editing a file | |
625 | 8395 - executing Python, Perl, etc. commands |
29 | 8396 This is not guaranteed 100% secure, but it should block most attacks. |
8397 | |
8398 *:san* *:sandbox* | |
401 | 8399 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 8400 option that may have been set from a modeline, e.g. |
8401 'foldexpr'. | |
8402 | |
634 | 8403 *sandbox-option* |
8404 A few options contain an expression. When this expression is evaluated it may | |
790 | 8405 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 8406 restrictive, thus this only happens when the option was set from an insecure |
8407 location. Insecure in this context are: | |
843 | 8408 - sourcing a .vimrc or .exrc in the current directory |
634 | 8409 - while executing in the sandbox |
8410 - value coming from a modeline | |
8411 | |
8412 Note that when in the sandbox and saving an option value and restoring it, the | |
8413 option will still be marked as it was set in the sandbox. | |
8414 | |
8415 ============================================================================== | |
8416 12. Textlock *textlock* | |
8417 | |
8418 In a few situations it is not allowed to change the text in the buffer, jump | |
8419 to another window and some other things that might confuse or break what Vim | |
8420 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 8421 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 8422 happen any moment the mouse cursor is resting at some position. |
8423 | |
8424 This is not allowed when the textlock is active: | |
8425 - changing the buffer text | |
8426 - jumping to another buffer or window | |
8427 - editing another file | |
8428 - closing a window or quitting Vim | |
8429 - etc. | |
8430 | |
7 | 8431 |
8432 vim:tw=78:ts=8:ft=help:norl: |