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