Mercurial > vim
annotate runtime/doc/eval.txt @ 6909:676906c33768 v7.4.774
patch 7.4.774
Problem: When using the CompleteDone autocommand event it's difficult to
get to the completed items.
Solution: Add the v:completed_items variable. (Shougo Matsu)
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Fri, 10 Jul 2015 17:56:23 +0200 |
parents | 29c328f69aaa |
children | 2def7b25de60 |
rev | line source |
---|---|
6884 | 1 *eval.txt* For Vim version 7.4. Last change: 2015 Jun 26 |
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 |
5340 | 126 can use "g:" but the following name must still start with a capital. You |
819 | 127 cannot have both a Funcref variable and a function with the same name. |
85 | 128 |
114 | 129 A special case is defining a function and directly assigning its Funcref to a |
130 Dictionary entry. Example: > | |
131 :function dict.init() dict | |
132 : let self.val = 0 | |
133 :endfunction | |
134 | |
135 The key of the Dictionary can start with a lower case letter. The actual | |
136 function name is not used here. Also see |numbered-function|. | |
137 | |
138 A Funcref can also be used with the |:call| command: > | |
139 :call Fn() | |
140 :call dict.init() | |
85 | 141 |
142 The name of the referenced function can be obtained with |string()|. > | |
119 | 143 :let func = string(Fn) |
85 | 144 |
145 You can use |call()| to invoke a Funcref and use a list variable for the | |
146 arguments: > | |
119 | 147 :let r = call(Fn, mylist) |
85 | 148 |
149 | |
87 | 150 1.3 Lists ~ |
5814 | 151 *list* *List* *Lists* *E686* |
55 | 152 A List is an ordered sequence of items. An item can be of any type. Items |
1621 | 153 can be accessed by their index number. Items can be added and removed at any |
55 | 154 position in the sequence. |
155 | |
85 | 156 |
157 List creation ~ | |
158 *E696* *E697* | |
55 | 159 A List is created with a comma separated list of items in square brackets. |
85 | 160 Examples: > |
161 :let mylist = [1, two, 3, "four"] | |
162 :let emptylist = [] | |
55 | 163 |
1621 | 164 An item can be any expression. Using a List for an item creates a |
842 | 165 List of Lists: > |
85 | 166 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 167 |
168 An extra comma after the last item is ignored. | |
169 | |
85 | 170 |
171 List index ~ | |
172 *list-index* *E684* | |
55 | 173 An item in the List can be accessed by putting the index in square brackets |
85 | 174 after the List. Indexes are zero-based, thus the first item has index zero. > |
175 :let item = mylist[0] " get the first item: 1 | |
55 | 176 :let item = mylist[2] " get the third item: 3 |
85 | 177 |
87 | 178 When the resulting item is a list this can be repeated: > |
85 | 179 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 180 < |
85 | 181 A negative index is counted from the end. Index -1 refers to the last item in |
182 the List, -2 to the last but one item, etc. > | |
55 | 183 :let last = mylist[-1] " get the last item: "four" |
184 | |
85 | 185 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 186 is not available it returns zero or the default value you specify: > |
85 | 187 :echo get(mylist, idx) |
188 :echo get(mylist, idx, "NONE") | |
189 | |
190 | |
191 List concatenation ~ | |
192 | |
193 Two lists can be concatenated with the "+" operator: > | |
194 :let longlist = mylist + [5, 6] | |
119 | 195 :let mylist += [7, 8] |
85 | 196 |
197 To prepend or append an item turn the item into a list by putting [] around | |
198 it. To change a list in-place see |list-modification| below. | |
199 | |
200 | |
201 Sublist ~ | |
202 | |
55 | 203 A part of the List can be obtained by specifying the first and last index, |
204 separated by a colon in square brackets: > | |
85 | 205 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 206 |
207 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 208 similar to -1. > |
90 | 209 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
210 :let shortlist = mylist[2:2] " List with one item: [3] | |
211 :let otherlist = mylist[:] " make a copy of the List | |
85 | 212 |
842 | 213 If the first index is beyond the last item of the List or the second item is |
214 before the first item, the result is an empty list. There is no error | |
215 message. | |
216 | |
217 If the second index is equal to or greater than the length of the list the | |
218 length minus one is used: > | |
829 | 219 :let mylist = [0, 1, 2, 3] |
220 :echo mylist[2:8] " result: [2, 3] | |
221 | |
270 | 222 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
1621 | 223 using a single letter variable before the ":". Insert a space when needed: |
270 | 224 mylist[s : e]. |
225 | |
85 | 226 |
227 List identity ~ | |
99 | 228 *list-identity* |
85 | 229 When variable "aa" is a list and you assign it to another variable "bb", both |
230 variables refer to the same list. Thus changing the list "aa" will also | |
231 change "bb": > | |
232 :let aa = [1, 2, 3] | |
233 :let bb = aa | |
234 :call add(aa, 4) | |
235 :echo bb | |
114 | 236 < [1, 2, 3, 4] |
85 | 237 |
238 Making a copy of a list is done with the |copy()| function. Using [:] also | |
239 works, as explained above. This creates a shallow copy of the list: Changing | |
87 | 240 a list item in the list will also change the item in the copied list: > |
85 | 241 :let aa = [[1, 'a'], 2, 3] |
242 :let bb = copy(aa) | |
114 | 243 :call add(aa, 4) |
85 | 244 :let aa[0][1] = 'aaa' |
245 :echo aa | |
114 | 246 < [[1, aaa], 2, 3, 4] > |
85 | 247 :echo bb |
114 | 248 < [[1, aaa], 2, 3] |
85 | 249 |
87 | 250 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 251 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 252 |
253 The operator "is" can be used to check if two variables refer to the same | |
114 | 254 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 255 the same value. > |
256 :let alist = [1, 2, 3] | |
257 :let blist = [1, 2, 3] | |
258 :echo alist is blist | |
114 | 259 < 0 > |
87 | 260 :echo alist == blist |
114 | 261 < 1 |
85 | 262 |
323 | 263 Note about comparing lists: Two lists are considered equal if they have the |
264 same length and all items compare equal, as with using "==". There is one | |
388 | 265 exception: When comparing a number with a string they are considered |
266 different. There is no automatic type conversion, as with using "==" on | |
267 variables. Example: > | |
268 echo 4 == "4" | |
323 | 269 < 1 > |
388 | 270 echo [4] == ["4"] |
323 | 271 < 0 |
272 | |
388 | 273 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 274 can compare simple values this way too by putting them in a list: > |
388 | 275 |
276 :let a = 5 | |
277 :let b = "5" | |
1621 | 278 :echo a == b |
388 | 279 < 1 > |
1621 | 280 :echo [a] == [b] |
388 | 281 < 0 |
323 | 282 |
85 | 283 |
284 List unpack ~ | |
285 | |
286 To unpack the items in a list to individual variables, put the variables in | |
287 square brackets, like list items: > | |
288 :let [var1, var2] = mylist | |
289 | |
290 When the number of variables does not match the number of items in the list | |
291 this produces an error. To handle any extra items from the list append ";" | |
292 and a variable name: > | |
293 :let [var1, var2; rest] = mylist | |
294 | |
295 This works like: > | |
296 :let var1 = mylist[0] | |
297 :let var2 = mylist[1] | |
95 | 298 :let rest = mylist[2:] |
85 | 299 |
300 Except that there is no error if there are only two items. "rest" will be an | |
301 empty list then. | |
302 | |
303 | |
304 List modification ~ | |
305 *list-modification* | |
87 | 306 To change a specific item of a list use |:let| this way: > |
85 | 307 :let list[4] = "four" |
308 :let listlist[0][3] = item | |
309 | |
87 | 310 To change part of a list you can specify the first and last item to be |
114 | 311 modified. The value must at least have the number of items in the range: > |
87 | 312 :let list[3:5] = [3, 4, 5] |
313 | |
85 | 314 Adding and removing items from a list is done with functions. Here are a few |
315 examples: > | |
316 :call insert(list, 'a') " prepend item 'a' | |
317 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
318 :call add(list, "new") " append String item | |
114 | 319 :call add(list, [1, 2]) " append a List as one new item |
85 | 320 :call extend(list, [1, 2]) " extend the list with two more items |
321 :let i = remove(list, 3) " remove item 3 | |
108 | 322 :unlet list[3] " idem |
85 | 323 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 324 :unlet list[3 : ] " idem |
114 | 325 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
326 | |
327 Changing the order of items in a list: > | |
87 | 328 :call sort(list) " sort a list alphabetically |
329 :call reverse(list) " reverse the order of items | |
5747 | 330 :call uniq(sort(list)) " sort and remove duplicates |
87 | 331 |
85 | 332 |
333 For loop ~ | |
334 | |
87 | 335 The |:for| loop executes commands for each item in a list. A variable is set |
336 to each item in the list in sequence. Example: > | |
114 | 337 :for item in mylist |
338 : call Doit(item) | |
85 | 339 :endfor |
340 | |
341 This works like: > | |
342 :let index = 0 | |
343 :while index < len(mylist) | |
114 | 344 : let item = mylist[index] |
345 : :call Doit(item) | |
85 | 346 : let index = index + 1 |
347 :endwhile | |
348 | |
349 Note that all items in the list should be of the same type, otherwise this | |
114 | 350 results in error |E706|. To avoid this |:unlet| the variable at the end of |
87 | 351 the loop. |
85 | 352 |
95 | 353 If all you want to do is modify each item in the list then the |map()| |
114 | 354 function will be a simpler method than a for loop. |
95 | 355 |
1621 | 356 Just like the |:let| command, |:for| also accepts a list of variables. This |
85 | 357 requires the argument to be a list of lists. > |
358 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
359 : call Doit(lnum, col) | |
360 :endfor | |
361 | |
362 This works like a |:let| command is done for each list item. Again, the types | |
363 must remain the same to avoid an error. | |
364 | |
114 | 365 It is also possible to put remaining items in a List variable: > |
85 | 366 :for [i, j; rest] in listlist |
367 : call Doit(i, j) | |
368 : if !empty(rest) | |
369 : echo "remainder: " . string(rest) | |
370 : endif | |
371 :endfor | |
372 | |
373 | |
374 List functions ~ | |
114 | 375 *E714* |
85 | 376 Functions that are useful with a List: > |
87 | 377 :let r = call(funcname, list) " call a function with an argument list |
85 | 378 :if empty(list) " check if list is empty |
102 | 379 :let l = len(list) " number of items in list |
380 :let big = max(list) " maximum value in list | |
381 :let small = min(list) " minimum value in list | |
87 | 382 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
383 :let i = index(list, 'x') " index of first 'x' in list | |
85 | 384 :let lines = getline(1, 10) " get ten text lines from buffer |
385 :call append('$', lines) " append text lines in buffer | |
95 | 386 :let list = split("a b c") " create list from items in a string |
387 :let string = join(list, ', ') " create string from list items | |
102 | 388 :let s = string(list) " String representation of list |
389 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
99 | 390 |
258 | 391 Don't forget that a combination of features can make things simple. For |
392 example, to add up all the numbers in a list: > | |
393 :exe 'let sum = ' . join(nrlist, '+') | |
394 | |
99 | 395 |
396 1.4 Dictionaries ~ | |
5814 | 397 *dict* *Dictionaries* *Dictionary* |
99 | 398 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 399 entry can be located with the key. The entries are stored without a specific |
400 ordering. | |
99 | 401 |
402 | |
403 Dictionary creation ~ | |
114 | 404 *E720* *E721* *E722* *E723* |
99 | 405 A Dictionary is created with a comma separated list of entries in curly |
114 | 406 braces. Each entry has a key and a value, separated by a colon. Each key can |
407 only appear once. Examples: > | |
99 | 408 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
409 :let emptydict = {} | |
114 | 410 < *E713* *E716* *E717* |
99 | 411 A key is always a String. You can use a Number, it will be converted to a |
412 String automatically. Thus the String '4' and the number 4 will find the same | |
1621 | 413 entry. Note that the String '04' and the Number 04 are different, since the |
114 | 414 Number will be converted to the String '4'. |
415 | |
1621 | 416 A value can be any expression. Using a Dictionary for a value creates a |
99 | 417 nested Dictionary: > |
418 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
419 | |
420 An extra comma after the last entry is ignored. | |
421 | |
422 | |
423 Accessing entries ~ | |
424 | |
425 The normal way to access an entry is by putting the key in square brackets: > | |
426 :let val = mydict["one"] | |
427 :let mydict["four"] = 4 | |
428 | |
114 | 429 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 430 |
431 For keys that consist entirely of letters, digits and underscore the following | |
432 form can be used |expr-entry|: > | |
433 :let val = mydict.one | |
434 :let mydict.four = 4 | |
435 | |
436 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
437 key lookup can be repeated: > | |
114 | 438 :echo dict.key[idx].key |
99 | 439 |
440 | |
441 Dictionary to List conversion ~ | |
442 | |
1621 | 443 You may want to loop over the entries in a dictionary. For this you need to |
99 | 444 turn the Dictionary into a List and pass it to |:for|. |
445 | |
446 Most often you want to loop over the keys, using the |keys()| function: > | |
447 :for key in keys(mydict) | |
448 : echo key . ': ' . mydict[key] | |
449 :endfor | |
450 | |
451 The List of keys is unsorted. You may want to sort them first: > | |
452 :for key in sort(keys(mydict)) | |
453 | |
454 To loop over the values use the |values()| function: > | |
455 :for v in values(mydict) | |
456 : echo "value: " . v | |
457 :endfor | |
458 | |
459 If you want both the key and the value use the |items()| function. It returns | |
1621 | 460 a List in which each item is a List with two items, the key and the value: > |
1156 | 461 :for [key, value] in items(mydict) |
462 : echo key . ': ' . value | |
99 | 463 :endfor |
464 | |
465 | |
466 Dictionary identity ~ | |
161 | 467 *dict-identity* |
99 | 468 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
469 Dictionary. Otherwise, assignment results in referring to the same | |
470 Dictionary: > | |
471 :let onedict = {'a': 1, 'b': 2} | |
472 :let adict = onedict | |
473 :let adict['a'] = 11 | |
474 :echo onedict['a'] | |
475 11 | |
476 | |
327 | 477 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
478 more info see |list-identity|. | |
99 | 479 |
480 | |
481 Dictionary modification ~ | |
482 *dict-modification* | |
483 To change an already existing entry of a Dictionary, or to add a new entry, | |
484 use |:let| this way: > | |
485 :let dict[4] = "four" | |
486 :let dict['one'] = item | |
487 | |
108 | 488 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
489 Three ways to remove the entry with key "aaa" from dict: > | |
490 :let i = remove(dict, 'aaa') | |
491 :unlet dict.aaa | |
492 :unlet dict['aaa'] | |
99 | 493 |
494 Merging a Dictionary with another is done with |extend()|: > | |
114 | 495 :call extend(adict, bdict) |
496 This extends adict with all entries from bdict. Duplicate keys cause entries | |
497 in adict to be overwritten. An optional third argument can change this. | |
119 | 498 Note that the order of entries in a Dictionary is irrelevant, thus don't |
499 expect ":echo adict" to show the items from bdict after the older entries in | |
500 adict. | |
99 | 501 |
502 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 503 :call filter(dict, 'v:val =~ "x"') |
114 | 504 This removes all entries from "dict" with a value not matching 'x'. |
102 | 505 |
506 | |
507 Dictionary function ~ | |
4159 | 508 *Dictionary-function* *self* *E725* *E862* |
102 | 509 When a function is defined with the "dict" attribute it can be used in a |
1621 | 510 special way with a dictionary. Example: > |
102 | 511 :function Mylen() dict |
114 | 512 : return len(self.data) |
102 | 513 :endfunction |
114 | 514 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
515 :echo mydict.len() | |
102 | 516 |
517 This is like a method in object oriented programming. The entry in the | |
518 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
519 the function was invoked from. | |
520 | |
114 | 521 It is also possible to add a function without the "dict" attribute as a |
522 Funcref to a Dictionary, but the "self" variable is not available then. | |
523 | |
819 | 524 *numbered-function* *anonymous-function* |
102 | 525 To avoid the extra name for the function it can be defined and directly |
526 assigned to a Dictionary in this way: > | |
114 | 527 :let mydict = {'data': [0, 1, 2, 3]} |
6741 | 528 :function mydict.len() |
114 | 529 : return len(self.data) |
102 | 530 :endfunction |
114 | 531 :echo mydict.len() |
532 | |
533 The function will then get a number and the value of dict.len is a |Funcref| | |
1621 | 534 that references this function. The function can only be used through a |
114 | 535 |Funcref|. It will automatically be deleted when there is no |Funcref| |
536 remaining that refers to it. | |
537 | |
538 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 539 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
540 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
|
541 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
|
542 :function {42} |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
543 |
102 | 544 |
545 Functions for Dictionaries ~ | |
114 | 546 *E715* |
547 Functions that can be used with a Dictionary: > | |
102 | 548 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
549 :if empty(dict) " TRUE if dict is empty | |
550 :let l = len(dict) " number of items in dict | |
551 :let big = max(dict) " maximum value in dict | |
552 :let small = min(dict) " minimum value in dict | |
553 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
554 :let s = string(dict) " String representation of dict | |
555 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
99 | 556 |
557 | |
558 1.5 More about variables ~ | |
85 | 559 *more-variables* |
7 | 560 If you need to know the type of a variable or expression, use the |type()| |
561 function. | |
562 | |
563 When the '!' flag is included in the 'viminfo' option, global variables that | |
564 start with an uppercase letter, and don't contain a lowercase letter, are | |
565 stored in the viminfo file |viminfo-file|. | |
566 | |
567 When the 'sessionoptions' option contains "global", global variables that | |
568 start with an uppercase letter and contain at least one lowercase letter are | |
569 stored in the session file |session-file|. | |
570 | |
571 variable name can be stored where ~ | |
572 my_var_6 not | |
573 My_Var_6 session file | |
574 MY_VAR_6 viminfo file | |
575 | |
576 | |
577 It's possible to form a variable name with curly braces, see | |
578 |curly-braces-names|. | |
579 | |
580 ============================================================================== | |
581 2. Expression syntax *expression-syntax* | |
582 | |
583 Expression syntax summary, from least to most significant: | |
584 | |
585 |expr1| expr2 ? expr1 : expr1 if-then-else | |
586 | |
587 |expr2| expr3 || expr3 .. logical OR | |
588 | |
589 |expr3| expr4 && expr4 .. logical AND | |
590 | |
591 |expr4| expr5 == expr5 equal | |
592 expr5 != expr5 not equal | |
593 expr5 > expr5 greater than | |
594 expr5 >= expr5 greater than or equal | |
595 expr5 < expr5 smaller than | |
596 expr5 <= expr5 smaller than or equal | |
597 expr5 =~ expr5 regexp matches | |
598 expr5 !~ expr5 regexp doesn't match | |
599 | |
600 expr5 ==? expr5 equal, ignoring case | |
601 expr5 ==# expr5 equal, match case | |
602 etc. As above, append ? for ignoring case, # for | |
603 matching case | |
604 | |
685 | 605 expr5 is expr5 same |List| instance |
606 expr5 isnot expr5 different |List| instance | |
79 | 607 |
608 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 609 expr6 - expr6 .. number subtraction |
610 expr6 . expr6 .. string concatenation | |
611 | |
612 |expr6| expr7 * expr7 .. number multiplication | |
613 expr7 / expr7 .. number division | |
614 expr7 % expr7 .. number modulo | |
615 | |
616 |expr7| ! expr7 logical NOT | |
617 - expr7 unary minus | |
618 + expr7 unary plus | |
102 | 619 |
685 | 620 |expr8| expr8[expr1] byte of a String or item of a |List| |
621 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
622 expr8.name entry in a |Dictionary| | |
623 expr8(expr1, ...) function call with |Funcref| variable | |
102 | 624 |
625 |expr9| number number constant | |
26 | 626 "string" string constant, backslash is special |
99 | 627 'string' string constant, ' is doubled |
685 | 628 [expr1, ...] |List| |
629 {expr1: expr1, ...} |Dictionary| | |
7 | 630 &option option value |
631 (expr1) nested expression | |
632 variable internal variable | |
633 va{ria}ble internal variable with curly braces | |
634 $VAR environment variable | |
635 @r contents of register 'r' | |
636 function(expr1, ...) function call | |
637 func{ti}on(expr1, ...) function call with curly braces | |
638 | |
639 | |
640 ".." indicates that the operations in this level can be concatenated. | |
641 Example: > | |
642 &nu || &list && &shell == "csh" | |
643 | |
644 All expressions within one level are parsed from left to right. | |
645 | |
646 | |
647 expr1 *expr1* *E109* | |
648 ----- | |
649 | |
650 expr2 ? expr1 : expr1 | |
651 | |
652 The expression before the '?' is evaluated to a number. If it evaluates to | |
653 non-zero, the result is the value of the expression between the '?' and ':', | |
654 otherwise the result is the value of the expression after the ':'. | |
655 Example: > | |
656 :echo lnum == 1 ? "top" : lnum | |
657 | |
658 Since the first expression is an "expr2", it cannot contain another ?:. The | |
659 other two expressions can, thus allow for recursive use of ?:. | |
660 Example: > | |
661 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
662 | |
663 To keep this readable, using |line-continuation| is suggested: > | |
664 :echo lnum == 1 | |
665 :\ ? "top" | |
666 :\ : lnum == 1000 | |
667 :\ ? "last" | |
668 :\ : lnum | |
669 | |
1156 | 670 You should always put a space before the ':', otherwise it can be mistaken for |
671 use in a variable such as "a:1". | |
672 | |
7 | 673 |
674 expr2 and expr3 *expr2* *expr3* | |
675 --------------- | |
676 | |
677 *expr-barbar* *expr-&&* | |
678 The "||" and "&&" operators take one argument on each side. The arguments | |
679 are (converted to) Numbers. The result is: | |
680 | |
681 input output ~ | |
682 n1 n2 n1 || n2 n1 && n2 ~ | |
683 zero zero zero zero | |
684 zero non-zero non-zero zero | |
685 non-zero zero non-zero zero | |
686 non-zero non-zero non-zero non-zero | |
687 | |
688 The operators can be concatenated, for example: > | |
689 | |
690 &nu || &list && &shell == "csh" | |
691 | |
692 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
693 | |
694 &nu || (&list && &shell == "csh") | |
695 | |
696 Once the result is known, the expression "short-circuits", that is, further | |
697 arguments are not evaluated. This is like what happens in C. For example: > | |
698 | |
699 let a = 1 | |
700 echo a || b | |
701 | |
702 This is valid even if there is no variable called "b" because "a" is non-zero, | |
703 so the result must be non-zero. Similarly below: > | |
704 | |
705 echo exists("b") && b == "yes" | |
706 | |
707 This is valid whether "b" has been defined or not. The second clause will | |
708 only be evaluated if "b" has been defined. | |
709 | |
710 | |
711 expr4 *expr4* | |
712 ----- | |
713 | |
714 expr5 {cmp} expr5 | |
715 | |
716 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
717 if it evaluates to true. | |
718 | |
1621 | 719 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 720 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
721 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
722 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
723 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
724 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 725 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
726 *expr-is?* *expr-isnot?* | |
7 | 727 use 'ignorecase' match case ignore case ~ |
728 equal == ==# ==? | |
729 not equal != !=# !=? | |
730 greater than > ># >? | |
731 greater than or equal >= >=# >=? | |
732 smaller than < <# <? | |
733 smaller than or equal <= <=# <=? | |
734 regexp matches =~ =~# =~? | |
735 regexp doesn't match !~ !~# !~? | |
2908 | 736 same instance is is# is? |
737 different instance isnot isnot# isnot? | |
7 | 738 |
739 Examples: | |
740 "abc" ==# "Abc" evaluates to 0 | |
741 "abc" ==? "Abc" evaluates to 1 | |
742 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
743 | |
85 | 744 *E691* *E692* |
685 | 745 A |List| can only be compared with a |List| and only "equal", "not equal" and |
746 "is" can be used. This compares the values of the list, recursively. | |
747 Ignoring case means case is ignored when comparing item values. | |
79 | 748 |
114 | 749 *E735* *E736* |
685 | 750 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
751 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
114 | 752 recursively. Ignoring case means case is ignored when comparing item values. |
753 | |
85 | 754 *E693* *E694* |
685 | 755 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
756 equal" can be used. Case is never ignored. | |
757 | |
2908 | 758 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
759 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
760 of a |List| is different from the original |List|. When using "is" without | |
761 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
762 equivalent to using "not equal". Except that a different type means the | |
763 values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is | |
3830 | 764 false and not an error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match |
2908 | 765 and ignore case. |
79 | 766 |
7 | 767 When comparing a String with a Number, the String is converted to a Number, |
1621 | 768 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
7 | 769 because 'x' converted to a Number is zero. |
770 | |
771 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
772 results in the mathematical difference (comparing byte values), not | |
773 necessarily the alphabetical difference in the local language. | |
774 | |
1621 | 775 When using the operators with a trailing '#', or the short version and |
1156 | 776 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 777 |
778 When using the operators with a trailing '?', or the short version and | |
1156 | 779 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
780 | |
781 'smartcase' is not used. | |
7 | 782 |
783 The "=~" and "!~" operators match the lefthand argument with the righthand | |
784 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
785 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
786 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
787 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
788 single-quote string, see |literal-string|. | |
789 Since a string is considered to be a single line, a multi-line pattern | |
790 (containing \n, backslash-n) will not match. However, a literal NL character | |
791 can be matched like an ordinary character. Examples: | |
792 "foo\nbar" =~ "\n" evaluates to 1 | |
793 "foo\nbar" =~ "\\n" evaluates to 0 | |
794 | |
795 | |
796 expr5 and expr6 *expr5* *expr6* | |
797 --------------- | |
685 | 798 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 799 expr6 - expr6 .. Number subtraction *expr--* |
800 expr6 . expr6 .. String concatenation *expr-.* | |
801 | |
692 | 802 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 803 result is a new list with the two lists Concatenated. |
79 | 804 |
3214 | 805 expr7 * expr7 .. Number multiplication *expr-star* |
806 expr7 / expr7 .. Number division *expr-/* | |
807 expr7 % expr7 .. Number modulo *expr-%* | |
7 | 808 |
809 For all, except ".", Strings are converted to Numbers. | |
3214 | 810 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 811 |
812 Note the difference between "+" and ".": | |
813 "123" + "456" = 579 | |
814 "123" . "456" = "123456" | |
815 | |
1621 | 816 Since '.' has the same precedence as '+' and '-', you need to read: > |
817 1 . 90 + 90.0 | |
818 As: > | |
819 (1 . 90) + 90.0 | |
820 That works, since the String "190" is automatically converted to the Number | |
821 190, which can be added to the Float 90.0. However: > | |
822 1 . 90 * 90.0 | |
823 Should be read as: > | |
824 1 . (90 * 90.0) | |
825 Since '.' has lower precedence than '*'. This does NOT work, since this | |
826 attempts to concatenate a Float and a String. | |
827 | |
828 When dividing a Number by zero the result depends on the value: | |
829 0 / 0 = -0x80000000 (like NaN for Float) | |
830 >0 / 0 = 0x7fffffff (like positive infinity) | |
831 <0 / 0 = -0x7fffffff (like negative infinity) | |
832 (before Vim 7.2 it was always 0x7fffffff) | |
833 | |
7 | 834 When the righthand side of '%' is zero, the result is 0. |
835 | |
685 | 836 None of these work for |Funcref|s. |
79 | 837 |
1621 | 838 . and % do not work for Float. *E804* |
839 | |
7 | 840 |
841 expr7 *expr7* | |
842 ----- | |
843 ! expr7 logical NOT *expr-!* | |
844 - expr7 unary minus *expr-unary--* | |
845 + expr7 unary plus *expr-unary-+* | |
846 | |
847 For '!' non-zero becomes zero, zero becomes one. | |
848 For '-' the sign of the number is changed. | |
849 For '+' the number is unchanged. | |
850 | |
851 A String will be converted to a Number first. | |
852 | |
1621 | 853 These three can be repeated and mixed. Examples: |
7 | 854 !-1 == 0 |
855 !!8 == 1 | |
856 --9 == 9 | |
857 | |
858 | |
859 expr8 *expr8* | |
860 ----- | |
685 | 861 expr8[expr1] item of String or |List| *expr-[]* *E111* |
102 | 862 |
863 If expr8 is a Number or String this results in a String that contains the | |
864 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
|
865 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
866 an alternative. |
55 | 867 |
868 Index zero gives the first character. This is like it works in C. Careful: | |
869 text column numbers start with one! Example, to get the character under the | |
870 cursor: > | |
823 | 871 :let c = getline(".")[col(".") - 1] |
7 | 872 |
873 If the length of the String is less than the index, the result is an empty | |
55 | 874 String. A negative index always results in an empty string (reason: backwards |
875 compatibility). Use [-1:] to get the last byte. | |
876 | |
685 | 877 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 878 for possible index values. If the index is out of range this results in an |
1621 | 879 error. Example: > |
55 | 880 :let item = mylist[-1] " get last item |
881 | |
685 | 882 Generally, if a |List| index is equal to or higher than the length of the |
883 |List|, or more negative than the length of the |List|, this results in an | |
884 error. | |
55 | 885 |
99 | 886 |
102 | 887 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
888 | |
889 If expr8 is a Number or String this results in the substring with the bytes | |
890 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
|
891 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
|
892 |byteidx()| for computing the indexes. |
55 | 893 |
894 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
895 string minus one is used. | |
896 | |
897 A negative number can be used to measure from the end of the string. -1 is | |
898 the last character, -2 the last but one, etc. | |
899 | |
900 If an index goes out of range for the string characters are omitted. If | |
901 expr1b is smaller than expr1a the result is an empty string. | |
902 | |
903 Examples: > | |
904 :let c = name[-1:] " last byte of a string | |
905 :let c = name[-2:-2] " last but one byte of a string | |
906 :let s = line(".")[4:] " from the fifth byte to the end | |
907 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
908 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
909 *sublist* *slice* |
685 | 910 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 911 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 912 just above, except that indexes out of range cause an error. Examples: > |
55 | 913 :let l = mylist[:3] " first four items |
914 :let l = mylist[4:4] " List with one item | |
915 :let l = mylist[:] " shallow copy of a List | |
916 | |
685 | 917 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
918 error. | |
919 | |
920 | |
921 expr8.name entry in a |Dictionary| *expr-entry* | |
922 | |
923 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
924 name will be used as a key in the |Dictionary|. This is just like: | |
925 expr8[name]. | |
99 | 926 |
927 The name must consist of alphanumeric characters, just like a variable name, | |
928 but it may start with a number. Curly braces cannot be used. | |
929 | |
930 There must not be white space before or after the dot. | |
931 | |
932 Examples: > | |
933 :let dict = {"one": 1, 2: "two"} | |
934 :echo dict.one | |
935 :echo dict .2 | |
936 | |
937 Note that the dot is also used for String concatenation. To avoid confusion | |
938 always put spaces around the dot for String concatenation. | |
939 | |
940 | |
685 | 941 expr8(expr1, ...) |Funcref| function call |
102 | 942 |
943 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
944 | |
945 | |
946 | |
947 *expr9* | |
7 | 948 number |
949 ------ | |
3224 | 950 number number constant *expr-number* |
951 *hex-number* *octal-number* | |
7 | 952 |
953 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
954 | |
1621 | 955 *floating-point-format* |
956 Floating point numbers can be written in two forms: | |
957 | |
958 [-+]{N}.{M} | |
6530 | 959 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 960 |
961 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
962 contain digits. | |
963 [-+] means there is an optional plus or minus sign. | |
964 {exp} is the exponent, power of 10. | |
965 Only a decimal point is accepted, not a comma. No matter what the current | |
966 locale is. | |
967 {only when compiled with the |+float| feature} | |
968 | |
969 Examples: | |
970 123.456 | |
971 +0.0001 | |
972 55.0 | |
973 -0.123 | |
974 1.234e03 | |
975 1.0E-6 | |
976 -3.1416e+88 | |
977 | |
978 These are INVALID: | |
979 3. empty {M} | |
980 1e40 missing .{M} | |
981 | |
1698 | 982 *float-pi* *float-e* |
983 A few useful values to copy&paste: > | |
984 :let pi = 3.14159265359 | |
985 :let e = 2.71828182846 | |
986 | |
1621 | 987 Rationale: |
988 Before floating point was introduced, the text "123.456" was interpreted as | |
989 the two numbers "123" and "456", both converted to a string and concatenated, | |
990 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 991 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 992 incompatibility was accepted in favor of being able to use the normal notation |
993 for floating point numbers. | |
994 | |
995 *floating-point-precision* | |
996 The precision and range of floating points numbers depends on what "double" | |
997 means in the library Vim was compiled with. There is no way to change this at | |
998 runtime. | |
999 | |
1000 The default for displaying a |Float| is to use 6 decimal places, like using | |
1001 printf("%g", f). You can select something else when using the |printf()| | |
1002 function. Example: > | |
1003 :echo printf('%.15e', atan(1)) | |
1004 < 7.853981633974483e-01 | |
1005 | |
1006 | |
7 | 1007 |
6884 | 1008 string *string* *String* *expr-string* *E114* |
7 | 1009 ------ |
1010 "string" string constant *expr-quote* | |
1011 | |
1012 Note that double quotes are used. | |
1013 | |
1014 A string constant accepts these special characters: | |
1015 \... three-digit octal number (e.g., "\316") | |
1016 \.. two-digit octal number (must be followed by non-digit) | |
1017 \. one-digit octal number (must be followed by non-digit) | |
1018 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1019 \x. byte specified with one hex number (must be followed by non-hex char) | |
1020 \X.. same as \x.. | |
1021 \X. same as \x. | |
1621 | 1022 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1023 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1024 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1025 \b backspace <BS> |
1026 \e escape <Esc> | |
1027 \f formfeed <FF> | |
1028 \n newline <NL> | |
1029 \r return <CR> | |
1030 \t tab <Tab> | |
1031 \\ backslash | |
1032 \" double quote | |
2152 | 1033 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1034 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1035 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1036 |
1156 | 1037 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1038 encodings. Use "\u00ff" to store character 255 according to the current value | |
1039 of 'encoding'. | |
1040 | |
7 | 1041 Note that "\000" and "\x00" force the end of the string. |
1042 | |
1043 | |
1044 literal-string *literal-string* *E115* | |
1045 --------------- | |
26 | 1046 'string' string constant *expr-'* |
7 | 1047 |
1048 Note that single quotes are used. | |
1049 | |
1621 | 1050 This string is taken as it is. No backslashes are removed or have a special |
99 | 1051 meaning. The only exception is that two quotes stand for one quote. |
26 | 1052 |
1053 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1054 to be doubled. These two commands are equivalent: > |
26 | 1055 if a =~ "\\s*" |
1056 if a =~ '\s*' | |
7 | 1057 |
1058 | |
1059 option *expr-option* *E112* *E113* | |
1060 ------ | |
1061 &option option value, local value if possible | |
1062 &g:option global option value | |
1063 &l:option local option value | |
1064 | |
1065 Examples: > | |
1066 echo "tabstop is " . &tabstop | |
1067 if &insertmode | |
1068 | |
1069 Any option name can be used here. See |options|. When using the local value | |
1070 and there is no buffer-local or window-local value, the global value is used | |
1071 anyway. | |
1072 | |
1073 | |
1156 | 1074 register *expr-register* *@r* |
7 | 1075 -------- |
1076 @r contents of register 'r' | |
1077 | |
1078 The result is the contents of the named register, as a single string. | |
1079 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1080 register use @" or @@. See |registers| for an explanation of the available |
336 | 1081 registers. |
1082 | |
1083 When using the '=' register you get the expression itself, not what it | |
1084 evaluates to. Use |eval()| to evaluate it. | |
7 | 1085 |
1086 | |
1087 nesting *expr-nesting* *E110* | |
1088 ------- | |
1089 (expr1) nested expression | |
1090 | |
1091 | |
1092 environment variable *expr-env* | |
1093 -------------------- | |
1094 $VAR environment variable | |
1095 | |
1096 The String value of any environment variable. When it is not defined, the | |
1097 result is an empty string. | |
1098 *expr-env-expand* | |
1099 Note that there is a difference between using $VAR directly and using | |
1100 expand("$VAR"). Using it directly will only expand environment variables that | |
1101 are known inside the current Vim session. Using expand() will first try using | |
1102 the environment variables known inside the current Vim session. If that | |
1103 fails, a shell will be used to expand the variable. This can be slow, but it | |
1104 does expand all variables that the shell knows about. Example: > | |
6180 | 1105 :echo $shell |
1106 :echo expand("$shell") | |
1107 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1108 variable (if your shell supports it). |
1109 | |
1110 | |
1111 internal variable *expr-variable* | |
1112 ----------------- | |
1113 variable internal variable | |
1114 See below |internal-variables|. | |
1115 | |
1116 | |
170 | 1117 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1118 ------------- |
1119 function(expr1, ...) function call | |
1120 See below |functions|. | |
1121 | |
1122 | |
1123 ============================================================================== | |
2596 | 1124 3. Internal variable *internal-variables* *E461* |
1125 | |
7 | 1126 An internal variable name can be made up of letters, digits and '_'. But it |
1127 cannot start with a digit. It's also possible to use curly braces, see | |
1128 |curly-braces-names|. | |
1129 | |
1130 An internal variable is created with the ":let" command |:let|. | |
87 | 1131 An internal variable is explicitly destroyed with the ":unlet" command |
1132 |:unlet|. | |
1133 Using a name that is not an internal variable or refers to a variable that has | |
1134 been destroyed results in an error. | |
7 | 1135 |
1136 There are several name spaces for variables. Which one is to be used is | |
1137 specified by what is prepended: | |
1138 | |
1139 (nothing) In a function: local to a function; otherwise: global | |
1140 |buffer-variable| b: Local to the current buffer. | |
1141 |window-variable| w: Local to the current window. | |
819 | 1142 |tabpage-variable| t: Local to the current tab page. |
7 | 1143 |global-variable| g: Global. |
1144 |local-variable| l: Local to a function. | |
1145 |script-variable| s: Local to a |:source|'ed Vim script. | |
1146 |function-argument| a: Function argument (only inside a function). | |
5815 | 1147 |vim-variable| v: Global, predefined by Vim. |
7 | 1148 |
685 | 1149 The scope name by itself can be used as a |Dictionary|. For example, to |
1150 delete all script-local variables: > | |
133 | 1151 :for k in keys(s:) |
1152 : unlet s:[k] | |
1153 :endfor | |
1154 < | |
4358 | 1155 *buffer-variable* *b:var* *b:* |
7 | 1156 A variable name that is preceded with "b:" is local to the current buffer. |
1157 Thus you can have several "b:foo" variables, one for each buffer. | |
1158 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1159 |:bdelete|. | |
1160 | |
1161 One local buffer variable is predefined: | |
4264 | 1162 *b:changedtick* *changetick* |
7 | 1163 b:changedtick The total number of changes to the current buffer. It is |
1164 incremented for each change. An undo command is also a change | |
1165 in this case. This can be used to perform an action only when | |
1166 the buffer has changed. Example: > | |
1167 :if my_changedtick != b:changedtick | |
1621 | 1168 : let my_changedtick = b:changedtick |
1169 : call My_Update() | |
7 | 1170 :endif |
1171 < | |
4358 | 1172 *window-variable* *w:var* *w:* |
7 | 1173 A variable name that is preceded with "w:" is local to the current window. It |
1174 is deleted when the window is closed. | |
1175 | |
4437 | 1176 *tabpage-variable* *t:var* *t:* |
819 | 1177 A variable name that is preceded with "t:" is local to the current tab page, |
1178 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
|
1179 without the |+windows| feature} |
819 | 1180 |
4358 | 1181 *global-variable* *g:var* *g:* |
7 | 1182 Inside functions global variables are accessed with "g:". Omitting this will |
1621 | 1183 access a variable local to a function. But "g:" can also be used in any other |
7 | 1184 place if you like. |
1185 | |
4358 | 1186 *local-variable* *l:var* *l:* |
7 | 1187 Inside functions local variables are accessed without prepending anything. |
1156 | 1188 But you can also prepend "l:" if you like. However, without prepending "l:" |
1189 you may run into reserved variable names. For example "count". By itself it | |
1190 refers to "v:count". Using "l:count" you can have a local variable with the | |
1191 same name. | |
7 | 1192 |
1193 *script-variable* *s:var* | |
1194 In a Vim script variables starting with "s:" can be used. They cannot be | |
1195 accessed from outside of the scripts, thus are local to the script. | |
1196 | |
1197 They can be used in: | |
1198 - commands executed while the script is sourced | |
1199 - functions defined in the script | |
1200 - autocommands defined in the script | |
1201 - functions and autocommands defined in functions and autocommands which were | |
1202 defined in the script (recursively) | |
1203 - user defined commands defined in the script | |
1204 Thus not in: | |
1205 - other scripts sourced from this one | |
1206 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1207 - menus |
7 | 1208 - etc. |
1209 | |
1156 | 1210 Script variables can be used to avoid conflicts with global variable names. |
1211 Take this example: > | |
7 | 1212 |
1213 let s:counter = 0 | |
1214 function MyCounter() | |
1215 let s:counter = s:counter + 1 | |
1216 echo s:counter | |
1217 endfunction | |
1218 command Tick call MyCounter() | |
1219 | |
1220 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1221 that script will not be changed, only the "s:counter" in the script where | |
1222 "Tick" was defined is used. | |
1223 | |
1224 Another example that does the same: > | |
1225 | |
1226 let s:counter = 0 | |
1227 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1228 | |
1229 When calling a function and invoking a user-defined command, the context for | |
9 | 1230 script variables is set to the script where the function or command was |
7 | 1231 defined. |
1232 | |
1233 The script variables are also available when a function is defined inside a | |
1234 function that is defined in a script. Example: > | |
1235 | |
1236 let s:counter = 0 | |
1237 function StartCounting(incr) | |
1238 if a:incr | |
1239 function MyCounter() | |
1240 let s:counter = s:counter + 1 | |
1241 endfunction | |
1242 else | |
1243 function MyCounter() | |
1244 let s:counter = s:counter - 1 | |
1245 endfunction | |
1246 endif | |
1247 endfunction | |
1248 | |
1249 This defines the MyCounter() function either for counting up or counting down | |
1250 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1251 called, the s:counter variable will be accessible in MyCounter(). | |
1252 | |
1253 When the same script is sourced again it will use the same script variables. | |
1254 They will remain valid as long as Vim is running. This can be used to | |
1255 maintain a counter: > | |
1256 | |
1257 if !exists("s:counter") | |
1258 let s:counter = 1 | |
1259 echo "script executed for the first time" | |
1260 else | |
1261 let s:counter = s:counter + 1 | |
1262 echo "script executed " . s:counter . " times now" | |
1263 endif | |
1264 | |
1265 Note that this means that filetype plugins don't get a different set of script | |
1266 variables for each buffer. Use local buffer variables instead |b:var|. | |
1267 | |
1268 | |
4358 | 1269 Predefined Vim variables: *vim-variable* *v:var* *v:* |
7 | 1270 |
189 | 1271 *v:beval_col* *beval_col-variable* |
1272 v:beval_col The number of the column, over which the mouse pointer is. | |
1273 This is the byte index in the |v:beval_lnum| line. | |
1274 Only valid while evaluating the 'balloonexpr' option. | |
1275 | |
1276 *v:beval_bufnr* *beval_bufnr-variable* | |
1277 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1278 valid while evaluating the 'balloonexpr' option. | |
1279 | |
1280 *v:beval_lnum* *beval_lnum-variable* | |
1281 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1282 valid while evaluating the 'balloonexpr' option. | |
1283 | |
1284 *v:beval_text* *beval_text-variable* | |
374 | 1285 v:beval_text The text under or after the mouse pointer. Usually a word as |
1286 it is useful for debugging a C program. 'iskeyword' applies, | |
1287 but a dot and "->" before the position is included. When on a | |
1288 ']' the text before it is used, including the matching '[' and | |
189 | 1289 word before it. When on a Visual area within one line the |
1290 highlighted text is used. | |
1291 Only valid while evaluating the 'balloonexpr' option. | |
1292 | |
1293 *v:beval_winnr* *beval_winnr-variable* | |
1294 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1295 valid while evaluating the 'balloonexpr' option. The first |
1296 window has number zero (unlike most other places where a | |
1297 window gets a number). | |
189 | 1298 |
844 | 1299 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1300 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
|
1301 character when using <expr> in an abbreviation |:map-<expr>|. |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
1302 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1303 |
7 | 1304 *v:charconvert_from* *charconvert_from-variable* |
1305 v:charconvert_from | |
1306 The name of the character encoding of a file to be converted. | |
1307 Only valid while evaluating the 'charconvert' option. | |
1308 | |
1309 *v:charconvert_to* *charconvert_to-variable* | |
1310 v:charconvert_to | |
1311 The name of the character encoding of a file after conversion. | |
1312 Only valid while evaluating the 'charconvert' option. | |
1313 | |
1314 *v:cmdarg* *cmdarg-variable* | |
1315 v:cmdarg This variable is used for two purposes: | |
1316 1. The extra arguments given to a file read/write command. | |
1317 Currently these are "++enc=" and "++ff=". This variable is | |
1318 set before an autocommand event for a file read/write | |
1319 command is triggered. There is a leading space to make it | |
1320 possible to append this variable directly after the | |
1621 | 1321 read/write command. Note: The "+cmd" argument isn't |
7 | 1322 included here, because it will be executed anyway. |
1323 2. When printing a PostScript file with ":hardcopy" this is | |
1324 the argument for the ":hardcopy" command. This can be used | |
1325 in 'printexpr'. | |
1326 | |
1327 *v:cmdbang* *cmdbang-variable* | |
1328 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1329 was used the value is 1, otherwise it is 0. Note that this | |
1330 can only be used in autocommands. For user commands |<bang>| | |
1331 can be used. | |
1332 | |
6909 | 1333 *v:completed_item* *completed_item-variable* |
1334 v:completed_item | |
1335 |Dictionary| containing the |complete-items| for the most | |
1336 recently completed word after |CompleteDone|. The | |
1337 |Dictionary| is empty if the completion failed. | |
1338 | |
7 | 1339 *v:count* *count-variable* |
1340 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1341 to get the count before a mapping. Read-only. Example: > |
7 | 1342 :map _x :<C-U>echo "the count is " . v:count<CR> |
1343 < Note: The <C-U> is required to remove the line range that you | |
1344 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1345 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1346 just like what happens in the command, "d6w" for the example. |
667 | 1347 Also used for evaluating the 'formatexpr' option. |
7 | 1348 "count" also works, for backwards compatibility. |
1349 | |
1350 *v:count1* *count1-variable* | |
1351 v:count1 Just like "v:count", but defaults to one when no count is | |
1352 used. | |
1353 | |
1354 *v:ctype* *ctype-variable* | |
1355 v:ctype The current locale setting for characters of the runtime | |
1356 environment. This allows Vim scripts to be aware of the | |
1357 current locale encoding. Technical: it's the value of | |
1358 LC_CTYPE. When not using a locale the value is "C". | |
1359 This variable can not be set directly, use the |:language| | |
1360 command. | |
1361 See |multi-lang|. | |
1362 | |
1363 *v:dying* *dying-variable* | |
1621 | 1364 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1365 one. When multiple signals are caught the number increases. |
1366 Can be used in an autocommand to check if Vim didn't | |
1367 terminate normally. {only works on Unix} | |
1368 Example: > | |
1369 :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
|
1370 < 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
|
1371 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
|
1372 |
7 | 1373 *v:errmsg* *errmsg-variable* |
1374 v:errmsg Last given error message. It's allowed to set this variable. | |
1375 Example: > | |
1376 :let v:errmsg = "" | |
1377 :silent! next | |
1378 :if v:errmsg != "" | |
1379 : ... handle error | |
1380 < "errmsg" also works, for backwards compatibility. | |
1381 | |
1382 *v:exception* *exception-variable* | |
1383 v:exception The value of the exception most recently caught and not | |
1384 finished. See also |v:throwpoint| and |throw-variables|. | |
1385 Example: > | |
1386 :try | |
1387 : throw "oops" | |
1388 :catch /.*/ | |
1389 : echo "caught" v:exception | |
1390 :endtry | |
1391 < Output: "caught oops". | |
1392 | |
179 | 1393 *v:fcs_reason* *fcs_reason-variable* |
1394 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1395 Can be used in an autocommand to decide what to do and/or what | |
1396 to set v:fcs_choice to. Possible values: | |
1397 deleted file no longer exists | |
1398 conflict file contents, mode or timestamp was | |
1399 changed and buffer is modified | |
1400 changed file contents has changed | |
1401 mode mode of file changed | |
1402 time only file timestamp changed | |
1403 | |
1404 *v:fcs_choice* *fcs_choice-variable* | |
1405 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1406 triggered. Can be used in an autocommand to tell Vim what to | |
1407 do with the affected buffer: | |
1408 reload Reload the buffer (does not work if | |
1409 the file was deleted). | |
1410 ask Ask the user what to do, as if there | |
1411 was no autocommand. Except that when | |
1412 only the timestamp changed nothing | |
1413 will happen. | |
1414 <empty> Nothing, the autocommand should do | |
1415 everything that needs to be done. | |
1416 The default is empty. If another (invalid) value is used then | |
1417 Vim behaves like it is empty, there is no warning message. | |
1418 | |
7 | 1419 *v:fname_in* *fname_in-variable* |
579 | 1420 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1421 option used for ~ |
1422 'charconvert' file to be converted | |
1423 'diffexpr' original file | |
1424 'patchexpr' original file | |
1425 'printexpr' file to be printed | |
593 | 1426 And set to the swap file name for |SwapExists|. |
7 | 1427 |
1428 *v:fname_out* *fname_out-variable* | |
1429 v:fname_out The name of the output file. Only valid while | |
1430 evaluating: | |
1431 option used for ~ | |
1432 'charconvert' resulting converted file (*) | |
1433 'diffexpr' output of diff | |
1434 'patchexpr' resulting patched file | |
1435 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1436 file") it will be equal to v:fname_in. When doing conversion |
7 | 1437 for a read command (e.g., ":e file") it will be a temporary |
1438 file and different from v:fname_in. | |
1439 | |
1440 *v:fname_new* *fname_new-variable* | |
1441 v:fname_new The name of the new version of the file. Only valid while | |
1442 evaluating 'diffexpr'. | |
1443 | |
1444 *v:fname_diff* *fname_diff-variable* | |
1445 v:fname_diff The name of the diff (patch) file. Only valid while | |
1446 evaluating 'patchexpr'. | |
1447 | |
1448 *v:folddashes* *folddashes-variable* | |
1449 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1450 fold. | |
29 | 1451 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1452 |
1453 *v:foldlevel* *foldlevel-variable* | |
1454 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1455 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1456 |
1457 *v:foldend* *foldend-variable* | |
1458 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1459 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1460 |
1461 *v:foldstart* *foldstart-variable* | |
1462 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1463 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1464 |
5460 | 1465 *v:hlsearch* *hlsearch-variable* |
6413 | 1466 v:hlsearch Variable that indicates whether search highlighting is on. |
1467 Setting it makes sense only if 'hlsearch' is enabled which | |
1468 requires |+extra_search|. Setting this variable to zero acts | |
1469 the like |:nohlsearch| command, setting it to one acts like > | |
5460 | 1470 let &hlsearch = &hlsearch |
1471 < | |
11 | 1472 *v:insertmode* *insertmode-variable* |
1473 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1474 events. Values: | |
1475 i Insert mode | |
1476 r Replace mode | |
1477 v Virtual Replace mode | |
1478 | |
102 | 1479 *v:key* *key-variable* |
685 | 1480 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1481 evaluating the expression used with |map()| and |filter()|. |
1482 Read-only. | |
1483 | |
7 | 1484 *v:lang* *lang-variable* |
1485 v:lang The current locale setting for messages of the runtime | |
1486 environment. This allows Vim scripts to be aware of the | |
1487 current language. Technical: it's the value of LC_MESSAGES. | |
1488 The value is system dependent. | |
1489 This variable can not be set directly, use the |:language| | |
1490 command. | |
1491 It can be different from |v:ctype| when messages are desired | |
1492 in a different language than what is used for character | |
1493 encoding. See |multi-lang|. | |
1494 | |
1495 *v:lc_time* *lc_time-variable* | |
1496 v:lc_time The current locale setting for time messages of the runtime | |
1497 environment. This allows Vim scripts to be aware of the | |
1498 current language. Technical: it's the value of LC_TIME. | |
1499 This variable can not be set directly, use the |:language| | |
1500 command. See |multi-lang|. | |
1501 | |
1502 *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
|
1503 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
|
1504 '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
|
1505 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
|
1506 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
|
1507 |sandbox|. |
7 | 1508 |
1029 | 1509 *v:mouse_win* *mouse_win-variable* |
1510 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1511 First window has number 1, like with |winnr()|. The value is | |
1512 zero when there was no mouse button click. | |
1513 | |
1514 *v:mouse_lnum* *mouse_lnum-variable* | |
1515 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1516 This is the text line number, not the screen line number. The | |
1517 value is zero when there was no mouse button click. | |
1518 | |
1519 *v:mouse_col* *mouse_col-variable* | |
1520 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1521 This is the screen column number, like with |virtcol()|. The | |
1522 value is zero when there was no mouse button click. | |
1523 | |
1733 | 1524 *v:oldfiles* *oldfiles-variable* |
1525 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1526 startup. These are the files that Vim remembers marks for. | |
1527 The length of the List is limited by the ' argument of the | |
1528 'viminfo' option (default is 100). | |
5618 | 1529 When the |viminfo| file is not used the List is empty. |
1733 | 1530 Also see |:oldfiles| and |c_#<|. |
1531 The List can be modified, but this has no effect on what is | |
1532 stored in the |viminfo| file later. If you use values other | |
1533 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
|
1534 {only when compiled with the |+viminfo| feature} |
1733 | 1535 |
1490 | 1536 *v:operator* *operator-variable* |
1537 v:operator The last operator given in Normal mode. This is a single | |
1538 character except for commands starting with <g> or <z>, | |
1539 in which case it is two characters. Best used alongside | |
1540 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1541 Operator-pending mode and then use the operator, e.g.: > | |
1542 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1543 < The value remains set until another operator is entered, thus | |
1544 don't expect it to be empty. | |
1545 v:operator is not set for |:delete|, |:yank| or other Ex | |
1546 commands. | |
1547 Read-only. | |
1548 | |
7 | 1549 *v:prevcount* *prevcount-variable* |
1550 v:prevcount The count given for the last but one Normal mode command. | |
1551 This is the v:count value of the previous command. Useful if | |
1490 | 1552 you want to cancel Visual or Operator-pending mode and then |
1553 use the count, e.g.: > | |
7 | 1554 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1555 < Read-only. | |
1556 | |
170 | 1557 *v:profiling* *profiling-variable* |
1621 | 1558 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1559 See |profiling|. |
1560 | |
7 | 1561 *v:progname* *progname-variable* |
1562 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 1563 invoked. Allows you to do special initialisations for |view|, |
1564 |evim| etc., or any other name you might symlink to Vim. | |
7 | 1565 Read-only. |
1566 | |
5780 | 1567 *v:progpath* *progpath-variable* |
1568 v:progpath Contains the command with which Vim was invoked, including the | |
1569 path. Useful if you want to message a Vim server using a | |
1570 |--remote-expr|. | |
5782 | 1571 To get the full path use: > |
1572 echo exepath(v:progpath) | |
1573 < NOTE: This does not work when the command is a relative path | |
1574 and the current directory has changed. | |
5780 | 1575 Read-only. |
1576 | |
7 | 1577 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1578 v:register The name of the register in effect for the current normal mode |
3492 | 1579 command (regardless of whether that command actually used a |
1580 register). Or for the currently executing normal mode mapping | |
1581 (use this in custom commands that take a register). | |
1582 If none is supplied it is the default register '"', unless | |
1583 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
1584 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1585 Also see |getreg()| and |setreg()| |
7 | 1586 |
540 | 1587 *v:scrollstart* *scrollstart-variable* |
1588 v:scrollstart String describing the script or function that caused the | |
1589 screen to scroll up. It's only set when it is empty, thus the | |
1590 first reason is remembered. It is set to "Unknown" for a | |
1591 typed command. | |
1592 This can be used to find out why your script causes the | |
1593 hit-enter prompt. | |
1594 | |
7 | 1595 *v:servername* *servername-variable* |
1596 v:servername The resulting registered |x11-clientserver| name if any. | |
1597 Read-only. | |
1598 | |
1621 | 1599 |
1600 v:searchforward *v:searchforward* *searchforward-variable* | |
1601 Search direction: 1 after a forward search, 0 after a | |
1602 backward search. It is reset to forward when directly setting | |
1603 the last search pattern, see |quote/|. | |
1604 Note that the value is restored when returning from a | |
1605 function. |function-search-undo|. | |
1606 Read-write. | |
1607 | |
7 | 1608 *v:shell_error* *shell_error-variable* |
1609 v:shell_error Result of the last shell command. When non-zero, the last | |
1610 shell command had an error. When zero, there was no problem. | |
1611 This only works when the shell returns the error code to Vim. | |
1612 The value -1 is often used when the command could not be | |
1613 executed. Read-only. | |
1614 Example: > | |
1615 :!mv foo bar | |
1616 :if v:shell_error | |
1617 : echo 'could not rename "foo" to "bar"!' | |
1618 :endif | |
1619 < "shell_error" also works, for backwards compatibility. | |
1620 | |
1621 *v:statusmsg* *statusmsg-variable* | |
1622 v:statusmsg Last given status message. It's allowed to set this variable. | |
1623 | |
579 | 1624 *v:swapname* *swapname-variable* |
1625 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1626 the swap file found. Read-only. | |
1627 | |
1628 *v:swapchoice* *swapchoice-variable* | |
1629 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1630 for handling an existing swap file: | |
1631 'o' Open read-only | |
1632 'e' Edit anyway | |
1633 'r' Recover | |
1634 'd' Delete swapfile | |
1635 'q' Quit | |
1636 'a' Abort | |
1621 | 1637 The value should be a single-character string. An empty value |
579 | 1638 results in the user being asked, as would happen when there is |
1639 no SwapExists autocommand. The default is empty. | |
1640 | |
590 | 1641 *v:swapcommand* *swapcommand-variable* |
625 | 1642 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1643 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1644 another Vim open the file and jump to the right place. For |
590 | 1645 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1646 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1647 |
7 | 1648 *v:termresponse* *termresponse-variable* |
1649 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1650 termcap entry. It is set when Vim receives an escape sequence |
7 | 1651 that starts with ESC [ or CSI and ends in a 'c', with only |
1652 digits, ';' and '.' in between. | |
1653 When this option is set, the TermResponse autocommand event is | |
1654 fired, so that you can react to the response from the | |
1655 terminal. | |
1656 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1657 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1658 patch level (since this was introduced in patch 95, it's | |
1659 always 95 or bigger). Pc is always zero. | |
1660 {only when compiled with |+termresponse| feature} | |
1661 | |
1662 *v:this_session* *this_session-variable* | |
1663 v:this_session Full filename of the last loaded or saved session file. See | |
1664 |:mksession|. It is allowed to set this variable. When no | |
1665 session file has been saved, this variable is empty. | |
1666 "this_session" also works, for backwards compatibility. | |
1667 | |
1668 *v:throwpoint* *throwpoint-variable* | |
1669 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1670 finished was thrown. Not set when commands are typed. See |
7 | 1671 also |v:exception| and |throw-variables|. |
1672 Example: > | |
1673 :try | |
1674 : throw "oops" | |
1675 :catch /.*/ | |
1676 : echo "Exception from" v:throwpoint | |
1677 :endtry | |
1678 < Output: "Exception from test.vim, line 2" | |
1679 | |
102 | 1680 *v:val* *val-variable* |
1621 | 1681 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1682 valid while evaluating the expression used with |map()| and |
102 | 1683 |filter()|. Read-only. |
1684 | |
7 | 1685 *v:version* *version-variable* |
1686 v:version Version number of Vim: Major version number times 100 plus | |
1687 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1688 is 501. Read-only. "version" also works, for backwards | |
1689 compatibility. | |
1690 Use |has()| to check if a certain patch was included, e.g.: > | |
5786 | 1691 if has("patch-7.4.123") |
7 | 1692 < Note that patch numbers are specific to the version, thus both |
1693 version 5.0 and 5.1 may have a patch 123, but these are | |
1694 completely different. | |
1695 | |
1696 *v:warningmsg* *warningmsg-variable* | |
1697 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1698 | |
2609 | 1699 *v:windowid* *windowid-variable* |
1700 v:windowid When any X11 based GUI is running or when running in a | |
1701 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1702 set to the window ID. |
1703 When an MS-Windows GUI is running this will be set to the | |
1704 window handle. | |
1705 Otherwise the value is zero. | |
1706 Note: for windows inside Vim use |winnr()|. | |
2609 | 1707 |
7 | 1708 ============================================================================== |
1709 4. Builtin Functions *functions* | |
1710 | |
1711 See |function-list| for a list grouped by what the function is used for. | |
1712 | |
236 | 1713 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1714 |
1715 USAGE RESULT DESCRIPTION ~ | |
1716 | |
1621 | 1717 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
|
1718 acos( {expr}) Float arc cosine of {expr} |
685 | 1719 add( {list}, {item}) List append {item} to |List| {list} |
3214 | 1720 and( {expr}, {expr}) Number bitwise AND |
55 | 1721 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1722 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1723 argc() Number number of files in the argument list |
55 | 1724 argidx() Number current index in the argument list |
5942 | 1725 arglistid( [{winnr}, [ {tabnr}]]) |
1726 Number argument list id | |
7 | 1727 argv( {nr}) String {nr} entry of the argument list |
818 | 1728 argv( ) List the argument list |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1729 asin( {expr}) Float arc sine of {expr} |
1621 | 1730 atan( {expr}) Float arc tangent of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1731 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
7 | 1732 browse( {save}, {title}, {initdir}, {default}) |
1733 String put up a file requester | |
1621 | 1734 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1735 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1736 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1737 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1738 bufname( {expr}) String Name of the buffer {expr} |
1739 bufnr( {expr}) Number Number of the buffer {expr} | |
1740 bufwinnr( {expr}) Number window number of buffer {expr} | |
1741 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1742 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
5413 | 1743 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1744 call( {func}, {arglist} [, {dict}]) |
1745 any call {func} with arguments {arglist} | |
1621 | 1746 ceil( {expr}) Float round {expr} up |
1747 changenr() Number current change number | |
4051 | 1748 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
55 | 1749 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1750 clearmatches() none clear all matches |
7 | 1751 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1752 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1753 complete_add( {expr}) Number add completion match |
1621 | 1754 complete_check() Number check for key typed during completion |
7 | 1755 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1756 Number number of choice picked by user | |
55 | 1757 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1758 cos( {expr}) Float cosine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1759 cosh( {expr}) Float hyperbolic cosine of {expr} |
6259 | 1760 count( {list}, {expr} [, {ic} [, {start}]]) |
95 | 1761 Number count how many {expr} are in {list} |
7 | 1762 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1763 Number checks existence of cscope connection | |
6385 | 1764 cursor( {lnum}, {col} [, {off}]) |
1765 Number move cursor to {lnum}, {col}, {off} | |
703 | 1766 cursor( {list}) Number move cursor to position in {list} |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5618
diff
changeset
|
1767 deepcopy( {expr} [, {noref}]) any make a full copy of {expr} |
7 | 1768 delete( {fname}) Number delete file {fname} |
1769 did_filetype() Number TRUE if FileType autocommand event used | |
55 | 1770 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1771 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
85 | 1772 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1773 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1774 eval( {string}) any evaluate {string} into its value |
55 | 1775 eventhandler( ) Number TRUE if inside an event handler |
7 | 1776 executable( {expr}) Number 1 if executable {expr} exists |
5782 | 1777 exepath( {expr}) String full path of the command {expr} |
7 | 1778 exists( {expr}) Number TRUE if {expr} exists |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1779 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1780 List/Dict insert items of {expr2} into {expr1} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1781 exp( {expr}) Float exponential of {expr} |
3398 | 1782 expand( {expr} [, {nosuf} [, {list}]]) |
1783 any expand special keywords in {expr} | |
1621 | 1784 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1785 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1786 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1787 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1788 {string} is 0 | |
95 | 1789 finddir( {name}[, {path}[, {count}]]) |
824 | 1790 String find directory {name} in {path} |
19 | 1791 findfile( {name}[, {path}[, {count}]]) |
824 | 1792 String find file {name} in {path} |
1621 | 1793 float2nr( {expr}) Number convert Float {expr} to a Number |
1794 floor( {expr}) Float round {expr} down | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1795 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
1586 | 1796 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1797 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1798 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1799 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1800 foldlevel( {lnum}) Number fold level at {lnum} |
55 | 1801 foldtext( ) String line displayed for closed fold |
824 | 1802 foldtextresult( {lnum}) String text for closed fold at {lnum} |
7 | 1803 foreground( ) Number bring the Vim window to the foreground |
55 | 1804 function( {name}) Funcref reference to function {name} |
3224 | 1805 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
82 | 1806 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1807 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1808 getbufline( {expr}, {lnum} [, {end}]) |
1809 List lines {lnum} to {end} of buffer {expr} | |
4157 | 1810 getbufvar( {expr}, {varname} [, {def}]) |
1811 any variable {varname} in buffer {expr} | |
55 | 1812 getchar( [expr]) Number get one character from the user |
1813 getcharmod( ) Number modifiers for the last typed character | |
7 | 1814 getcmdline() String return the current command-line |
1815 getcmdpos() Number return cursor position in command-line | |
6153 | 1816 getcmdtype() String return current command-line type |
1817 getcmdwintype() String return current command-line window type | |
5944 | 1818 getcurpos() List position of the cursor |
7 | 1819 getcwd() String the current working directory |
5944 | 1820 getfontname( [{name}]) String name of font being used |
20 | 1821 getfperm( {fname}) String file permissions of file {fname} |
1822 getfsize( {fname}) Number size in bytes of file {fname} | |
7 | 1823 getftime( {fname}) Number last modification time of file |
20 | 1824 getftype( {fname}) String description of type of file {fname} |
161 | 1825 getline( {lnum}) String line {lnum} of current buffer |
1826 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
|
1827 getloclist( {nr}) List list of location list items |
1326 | 1828 getmatches() List list of current matches |
1548 | 1829 getpid() Number process ID of Vim |
703 | 1830 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1831 getqflist() List list of quickfix items |
5796 | 1832 getreg( [{regname} [, 1 [, {list}]]]) |
1833 String or List contents of register | |
55 | 1834 getregtype( [{regname}]) String type of register |
4157 | 1835 gettabvar( {nr}, {varname} [, {def}]) |
1836 any variable {varname} in tab {nr} or {def} | |
1837 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
831 | 1838 any {name} in {winnr} in tab page {tabnr} |
7 | 1839 getwinposx() Number X coord in pixels of GUI Vim window |
1840 getwinposy() Number Y coord in pixels of GUI Vim window | |
4157 | 1841 getwinvar( {nr}, {varname} [, {def}]) |
1842 any variable {varname} in window {nr} | |
6663 | 1843 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
3398 | 1844 any expand file wildcards in {expr} |
6697 | 1845 glob2regpat( {expr}) String convert a glob pat into a search pat |
6663 | 1846 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
1754 | 1847 String do glob({expr}) for all dirs in {path} |
7 | 1848 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1849 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
1104 | 1850 haslocaldir() Number TRUE if current window executed |:lcd| |
782 | 1851 hasmapto( {what} [, {mode} [, {abbr}]]) |
1852 Number TRUE if mapping to {what} exists | |
7 | 1853 histadd( {history},{item}) String add an item to a history |
1854 histdel( {history} [, {item}]) String remove an item from a history | |
1855 histget( {history} [, {index}]) String get the item {index} from a history | |
1856 histnr( {history}) Number highest index of a history | |
1857 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1858 hlID( {name}) Number syntax ID of highlight group {name} | |
1859 hostname() String name of the machine Vim is running on | |
55 | 1860 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1861 indent( {lnum}) Number indent of line {lnum} | |
95 | 1862 index( {list}, {expr} [, {start} [, {ic}]]) |
1863 Number index in {list} where {expr} appears | |
531 | 1864 input( {prompt} [, {text} [, {completion}]]) |
1865 String get input from the user | |
7 | 1866 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1867 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1868 inputrestore() Number restore typeahead |
1869 inputsave() Number save and clear typeahead | |
7 | 1870 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1871 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
3214 | 1872 invert( {expr}) Number bitwise invert |
7 | 1873 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1874 islocked( {expr}) Number TRUE if {expr} is locked |
685 | 1875 items( {dict}) List key-value pairs in {dict} |
95 | 1876 join( {list} [, {sep}]) String join {list} items into one String |
685 | 1877 keys( {dict}) List keys in {dict} |
55 | 1878 len( {expr}) Number the length of {expr} |
1879 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1880 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1881 line( {expr}) Number line nr of cursor, last line or mark | |
1882 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1883 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1884 localtime() Number current time |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1885 log( {expr}) Float natural logarithm (base e) of {expr} |
1621 | 1886 log10( {expr}) Float logarithm of Float {expr} to base 10 |
3492 | 1887 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
102 | 1888 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
2610 | 1889 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 1890 String or Dict |
1891 rhs of mapping {name} in mode {mode} | |
782 | 1892 mapcheck( {name}[, {mode} [, {abbr}]]) |
1893 String check for mappings matching {name} | |
19 | 1894 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1895 Number position where {pat} matches in {expr} |
1326 | 1896 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
1897 Number highlight {pattern} with {group} | |
5979 | 1898 matchaddpos( {group}, {list}[, {priority}[, {id}]]) |
1899 Number highlight positions with {group} | |
819 | 1900 matcharg( {nr}) List arguments of |:match| |
1326 | 1901 matchdelete( {id}) Number delete match identified by {id} |
19 | 1902 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1903 Number position where {pat} ends in {expr} |
158 | 1904 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
1905 List match and submatches of {pat} in {expr} | |
19 | 1906 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
1907 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1908 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1909 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1910 mkdir( {name} [, {path} [, {prot}]]) |
168 | 1911 Number create directory {name} |
1621 | 1912 mode( [expr]) String current editing mode |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1913 mzeval( {expr}) any evaluate |MzScheme| expression |
7 | 1914 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
4051 | 1915 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
3214 | 1916 or( {expr}, {expr}) Number bitwise OR |
819 | 1917 pathshorten( {expr}) String shorten directory names in a path |
1621 | 1918 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 1919 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 1920 printf( {fmt}, {expr1}...) String format text |
1921 pumvisible() Number whether popup menu is visible | |
3682 | 1922 pyeval( {expr}) any evaluate |Python| expression |
1923 py3eval( {expr}) any evaluate |python3| expression | |
99 | 1924 range( {expr} [, {max} [, {stride}]]) |
1925 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1926 readfile( {fname} [, {binary} [, {max}]]) |
168 | 1927 List get list of lines from file {fname} |
794 | 1928 reltime( [{start} [, {end}]]) List get time value |
1929 reltimestr( {time}) String turn time value into a String | |
7 | 1930 remote_expr( {server}, {string} [, {idvar}]) |
1931 String send expression | |
1932 remote_foreground( {server}) Number bring Vim server to the foreground | |
1933 remote_peek( {serverid} [, {retvar}]) | |
1934 Number check for reply string | |
1935 remote_read( {serverid}) String read reply string | |
1936 remote_send( {server}, {string} [, {idvar}]) | |
1937 String send key sequence | |
79 | 1938 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 1939 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 1940 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
1941 repeat( {expr}, {count}) String repeat {expr} {count} times | |
1942 resolve( {filename}) String get filename a shortcut points to | |
82 | 1943 reverse( {list}) List reverse {list} in-place |
1621 | 1944 round( {expr}) Float round off {expr} |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1945 screenattr( {row}, {col}) Number attribute at screen position |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1946 screenchar( {row}, {col}) Number character at screen position |
3986 | 1947 screencol() Number current cursor column |
1948 screenrow() Number current cursor row | |
1496 | 1949 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1950 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1951 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 1952 Number search for variable declaration |
1496 | 1953 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 1954 Number search for other end of start/end pair |
1496 | 1955 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 1956 List search for other end of start/end pair |
1496 | 1957 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 1958 List search for {pattern} |
7 | 1959 server2client( {clientid}, {string}) |
1960 Number send reply string | |
1961 serverlist() String get a list of available servers | |
1962 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
1963 setcmdpos( {pos}) Number set cursor position in command-line | |
1964 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
647 | 1965 setloclist( {nr}, {list}[, {action}]) |
1966 Number modify location list using {list} | |
1326 | 1967 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1968 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 1969 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 1970 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
|
1971 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
831 | 1972 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
1973 {winnr} in tab page {tabnr} to {val} | |
7 | 1974 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
4126 | 1975 sha256( {string}) String SHA256 checksum of {string} |
1661 | 1976 shellescape( {string} [, {special}]) |
1977 String escape {string} for use as shell | |
985 | 1978 command argument |
3875 | 1979 shiftwidth() Number effective value of 'shiftwidth' |
55 | 1980 simplify( {filename}) String simplify filename as much as possible |
1621 | 1981 sin( {expr}) Float sine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1982 sinh( {expr}) Float hyperbolic sine of {expr} |
2902 | 1983 sort( {list} [, {func} [, {dict}]]) |
1984 List sort {list}, using {func} to compare | |
374 | 1985 soundfold( {word}) String sound-fold {word} |
344 | 1986 spellbadword() String badly spelled word at cursor |
537 | 1987 spellsuggest( {word} [, {max} [, {capital}]]) |
1988 List spelling suggestions | |
282 | 1989 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 1990 List make |List| from {pat} separated {expr} |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1991 sqrt( {expr}) Float square root of {expr} |
1621 | 1992 str2float( {expr}) Float convert String to Float |
1993 str2nr( {expr} [, {base}]) Number convert String to Number | |
6870 | 1994 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
1995 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
7 | 1996 strftime( {format}[, {time}]) String time in specified format |
133 | 1997 stridx( {haystack}, {needle}[, {start}]) |
1998 Number index of {needle} in {haystack} | |
95 | 1999 string( {expr}) String String representation of {expr} value |
7 | 2000 strlen( {expr}) Number length of the String {expr} |
2001 strpart( {src}, {start}[, {len}]) | |
2002 String {len} characters of {src} at {start} | |
140 | 2003 strridx( {haystack}, {needle} [, {start}]) |
2004 Number last index of {needle} in {haystack} | |
7 | 2005 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
|
2006 strwidth( {expr}) Number display cell length of the String {expr} |
5794 | 2007 submatch( {nr}[, {list}]) String or List |
2008 specific match in ":s" or substitute() | |
7 | 2009 substitute( {expr}, {pat}, {sub}, {flags}) |
2010 String all {pat} in {expr} replaced with {sub} | |
32 | 2011 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 2012 synIDattr( {synID}, {what} [, {mode}]) |
2013 String attribute {what} of syntax ID {synID} | |
2014 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2015 synconcealed( {lnum}, {col}) List info about concealing |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2016 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 2017 system( {expr} [, {input}]) String output of shell command/filter {expr} |
5808 | 2018 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
677 | 2019 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
2020 tabpagenr( [{arg}]) Number number of current or last tab page | |
2021 tabpagewinnr( {tabarg}[, {arg}]) | |
2022 Number number of current window in tab page | |
2023 taglist( {expr}) List list of tags matching {expr} | |
1621 | 2024 tagfiles() List tags files used |
7 | 2025 tempname() String name for a temporary file |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2026 tan( {expr}) Float tangent of {expr} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2027 tanh( {expr}) Float hyperbolic tangent of {expr} |
7 | 2028 tolower( {expr}) String the String {expr} switched to lowercase |
2029 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 2030 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
2031 to chars in {tostr} | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2032 trunc( {expr}) Float truncate Float {expr} |
7 | 2033 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
|
2034 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
|
2035 undotree() List undo file tree |
5747 | 2036 uniq( {list} [, {func} [, {dict}]]) |
2037 List remove adjacent duplicates from a list | |
685 | 2038 values( {dict}) List values in {dict} |
7 | 2039 virtcol( {expr}) Number screen column of cursor or mark |
2040 visualmode( [expr]) String last visual mode used | |
4151 | 2041 wildmenumode() Number whether 'wildmenu' mode is active |
7 | 2042 winbufnr( {nr}) Number buffer number of window {nr} |
2043 wincol() Number window column of the cursor | |
2044 winheight( {nr}) Number height of window {nr} | |
2045 winline() Number window line of the cursor | |
674 | 2046 winnr( [{expr}]) Number number of current window |
55 | 2047 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2048 winrestview( {dict}) none restore view of current window |
712 | 2049 winsaveview() Dict save view of current window |
7 | 2050 winwidth( {nr}) Number width of window {nr} |
6341 | 2051 writefile( {list}, {fname} [, {flags}]) |
158 | 2052 Number write list of lines to file {fname} |
3214 | 2053 xor( {expr}, {expr}) Number bitwise XOR |
7 | 2054 |
1621 | 2055 abs({expr}) *abs()* |
2056 Return the absolute value of {expr}. When {expr} evaluates to | |
2057 a |Float| abs() returns a |Float|. When {expr} can be | |
2058 converted to a |Number| abs() returns a |Number|. Otherwise | |
2059 abs() gives an error message and returns -1. | |
2060 Examples: > | |
2061 echo abs(1.456) | |
2062 < 1.456 > | |
2063 echo abs(-5.456) | |
2064 < 5.456 > | |
2065 echo abs(-4) | |
2066 < 4 | |
2067 {only available when compiled with the |+float| feature} | |
2068 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2069 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2070 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2071 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
|
2072 |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
|
2073 {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
|
2074 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2075 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2076 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2077 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2078 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2079 < 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
|
2080 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2081 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2082 |
82 | 2083 add({list}, {expr}) *add()* |
685 | 2084 Append the item {expr} to |List| {list}. Returns the |
2085 resulting |List|. Examples: > | |
82 | 2086 :let alist = add([1, 2, 3], item) |
2087 :call add(mylist, "woodstock") | |
685 | 2088 < Note that when {expr} is a |List| it is appended as a single |
692 | 2089 item. Use |extend()| to concatenate |Lists|. |
85 | 2090 Use |insert()| to add an item at another position. |
55 | 2091 |
82 | 2092 |
3214 | 2093 and({expr}, {expr}) *and()* |
2094 Bitwise AND on the two arguments. The arguments are converted | |
2095 to a number. A List, Dict or Float argument causes an error. | |
2096 Example: > | |
2097 :let flag = and(bits, 0x80) | |
2098 | |
2099 | |
82 | 2100 append({lnum}, {expr}) *append()* |
685 | 2101 When {expr} is a |List|: Append each item of the |List| as a |
2102 text line below line {lnum} in the current buffer. | |
153 | 2103 Otherwise append {expr} as one text line below line {lnum} in |
2104 the current buffer. | |
2105 {lnum} can be zero to insert a line before the first one. | |
82 | 2106 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2107 0 for success. Example: > |
55 | 2108 :let failed = append(line('$'), "# THE END") |
82 | 2109 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2110 < |
7 | 2111 *argc()* |
2112 argc() The result is the number of files in the argument list of the | |
2113 current window. See |arglist|. | |
2114 | |
2115 *argidx()* | |
2116 argidx() The result is the current index in the argument list. 0 is | |
2117 the first file. argc() - 1 is the last one. See |arglist|. | |
2118 | |
5942 | 2119 *arglistid()* |
2120 arglistid([{winnr}, [ {tabnr} ]]) | |
2121 Return the argument list ID. This is a number which | |
2122 identifies the argument list being used. Zero is used for the | |
6153 | 2123 global argument list. See |arglist|. |
2124 Return -1 if the arguments are invalid. | |
5942 | 2125 |
2126 Without arguments use the current window. | |
2127 With {winnr} only use this window in the current tab page. | |
2128 With {winnr} and {tabnr} use the window in the specified tab | |
2129 page. | |
2130 | |
7 | 2131 *argv()* |
818 | 2132 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2133 current window. See |arglist|. "argv(0)" is the first one. |
2134 Example: > | |
2135 :let i = 0 | |
2136 :while i < argc() | |
1621 | 2137 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2138 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2139 : let i = i + 1 | |
2140 :endwhile | |
818 | 2141 < Without the {nr} argument a |List| with the whole |arglist| is |
2142 returned. | |
2143 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2144 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2145 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
|
2146 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
|
2147 {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
|
2148 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2149 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2150 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2151 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2152 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2153 < -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
|
2154 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2155 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2156 |
1621 | 2157 atan({expr}) *atan()* |
2158 Return the principal value of the arc tangent of {expr}, in | |
2159 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2160 {expr} must evaluate to a |Float| or a |Number|. | |
2161 Examples: > | |
2162 :echo atan(100) | |
2163 < 1.560797 > | |
2164 :echo atan(-4.01) | |
2165 < -1.326405 | |
2166 {only available when compiled with the |+float| feature} | |
2167 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2168 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2169 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2170 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
|
2171 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
|
2172 {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
|
2173 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2174 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2175 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2176 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2177 < 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
|
2178 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2179 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2180 |
7 | 2181 *browse()* |
2182 browse({save}, {title}, {initdir}, {default}) | |
2183 Put up a file requester. This only works when "has("browse")" | |
2184 returns non-zero (only in some GUI versions). | |
2185 The input fields are: | |
2186 {save} when non-zero, select file to write | |
2187 {title} title for the requester | |
2188 {initdir} directory to start browsing in | |
2189 {default} default file name | |
2190 When the "Cancel" button is hit, something went wrong, or | |
2191 browsing is not possible, an empty string is returned. | |
2192 | |
29 | 2193 *browsedir()* |
2194 browsedir({title}, {initdir}) | |
2195 Put up a directory requester. This only works when | |
2196 "has("browse")" returns non-zero (only in some GUI versions). | |
2197 On systems where a directory browser is not supported a file | |
2198 browser is used. In that case: select a file in the directory | |
2199 to be used. | |
2200 The input fields are: | |
2201 {title} title for the requester | |
2202 {initdir} directory to start browsing in | |
2203 When the "Cancel" button is hit, something went wrong, or | |
2204 browsing is not possible, an empty string is returned. | |
2205 | |
7 | 2206 bufexists({expr}) *bufexists()* |
2207 The result is a Number, which is non-zero if a buffer called | |
2208 {expr} exists. | |
9 | 2209 If the {expr} argument is a number, buffer numbers are used. |
7 | 2210 If the {expr} argument is a string it must match a buffer name |
9 | 2211 exactly. The name can be: |
2212 - Relative to the current directory. | |
2213 - A full path. | |
1621 | 2214 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2215 - A URL name. |
7 | 2216 Unlisted buffers will be found. |
2217 Note that help files are listed by their short name in the | |
2218 output of |:buffers|, but bufexists() requires using their | |
2219 long name to be able to find them. | |
1621 | 2220 bufexists() may report a buffer exists, but to use the name |
2221 with a |:buffer| command you may need to use |expand()|. Esp | |
2222 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2223 Use "bufexists(0)" to test for the existence of an alternate |
2224 file name. | |
2225 *buffer_exists()* | |
2226 Obsolete name: buffer_exists(). | |
2227 | |
2228 buflisted({expr}) *buflisted()* | |
2229 The result is a Number, which is non-zero if a buffer called | |
2230 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2231 The {expr} argument is used like with |bufexists()|. |
7 | 2232 |
2233 bufloaded({expr}) *bufloaded()* | |
2234 The result is a Number, which is non-zero if a buffer called | |
2235 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2236 The {expr} argument is used like with |bufexists()|. |
7 | 2237 |
2238 bufname({expr}) *bufname()* | |
2239 The result is the name of a buffer, as it is displayed by the | |
2240 ":ls" command. | |
2241 If {expr} is a Number, that buffer number's name is given. | |
2242 Number zero is the alternate buffer for the current window. | |
2243 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2244 with the buffer names. This is always done like 'magic' is |
7 | 2245 set and 'cpoptions' is empty. When there is more than one |
2246 match an empty string is returned. | |
2247 "" or "%" can be used for the current buffer, "#" for the | |
2248 alternate buffer. | |
2249 A full match is preferred, otherwise a match at the start, end | |
1156 | 2250 or middle of the buffer name is accepted. If you only want a |
2251 full match then put "^" at the start and "$" at the end of the | |
2252 pattern. | |
7 | 2253 Listed buffers are found first. If there is a single match |
2254 with a listed buffer, that one is returned. Next unlisted | |
2255 buffers are searched for. | |
2256 If the {expr} is a String, but you want to use it as a buffer | |
2257 number, force it to be a Number by adding zero to it: > | |
2258 :echo bufname("3" + 0) | |
2259 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2260 string is returned. > | |
2261 bufname("#") alternate buffer name | |
2262 bufname(3) name of buffer 3 | |
2263 bufname("%") name of current buffer | |
2264 bufname("file2") name of buffer where "file2" matches. | |
2265 < *buffer_name()* | |
2266 Obsolete name: buffer_name(). | |
2267 | |
2268 *bufnr()* | |
707 | 2269 bufnr({expr} [, {create}]) |
2270 The result is the number of a buffer, as it is displayed by | |
7 | 2271 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2272 above. |
2273 If the buffer doesn't exist, -1 is returned. Or, if the | |
2274 {create} argument is present and not zero, a new, unlisted, | |
2275 buffer is created and its number is returned. | |
7 | 2276 bufnr("$") is the last buffer: > |
2277 :let last_buffer = bufnr("$") | |
2278 < The result is a Number, which is the highest buffer number | |
2279 of existing buffers. Note that not all buffers with a smaller | |
2280 number necessarily exist, because ":bwipeout" may have removed | |
2281 them. Use bufexists() to test for the existence of a buffer. | |
2282 *buffer_number()* | |
2283 Obsolete name: buffer_number(). | |
2284 *last_buffer_nr()* | |
2285 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2286 | |
2287 bufwinnr({expr}) *bufwinnr()* | |
2288 The result is a Number, which is the number of the first | |
2289 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2290 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2291 there is no such window, -1 is returned. Example: > |
2292 | |
2293 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2294 | |
2295 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2296 |:wincmd|. | |
1156 | 2297 Only deals with the current tab page. |
7 | 2298 |
2299 | |
2300 byte2line({byte}) *byte2line()* | |
2301 Return the line number that contains the character at byte | |
2302 count {byte} in the current buffer. This includes the | |
2303 end-of-line character, depending on the 'fileformat' option | |
2304 for the current buffer. The first character has byte count | |
2305 one. | |
2306 Also see |line2byte()|, |go| and |:goto|. | |
2307 {not available when compiled without the |+byte_offset| | |
2308 feature} | |
2309 | |
18 | 2310 byteidx({expr}, {nr}) *byteidx()* |
2311 Return byte index of the {nr}'th character in the string | |
2312 {expr}. Use zero for the first character, it returns zero. | |
2313 This function is only useful when there are multibyte | |
2314 characters, otherwise the returned value is equal to {nr}. | |
5413 | 2315 Composing characters are not counted separately, their byte |
2316 length is added to the preceding base character. See | |
2317 |byteidxcomp()| below for counting composing characters | |
2318 separately. | |
18 | 2319 Example : > |
2320 echo matchstr(str, ".", byteidx(str, 3)) | |
2321 < will display the fourth character. Another way to do the | |
2322 same: > | |
2323 let s = strpart(str, byteidx(str, 3)) | |
2324 echo strpart(s, 0, byteidx(s, 1)) | |
2325 < If there are less than {nr} characters -1 is returned. | |
2326 If there are exactly {nr} characters the length of the string | |
5413 | 2327 in bytes is returned. |
2328 | |
2329 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
2330 Like byteidx(), except that a composing character is counted | |
2331 as a separate character. Example: > | |
2332 let s = 'e' . nr2char(0x301) | |
2333 echo byteidx(s, 1) | |
2334 echo byteidxcomp(s, 1) | |
2335 echo byteidxcomp(s, 2) | |
2336 < The first and third echo result in 3 ('e' plus composing | |
2337 character is 3 bytes), the second echo results in 1 ('e' is | |
2338 one byte). | |
2339 Only works different from byteidx() when 'encoding' is set to | |
2340 a Unicode encoding. | |
18 | 2341 |
102 | 2342 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2343 Call function {func} with the items in |List| {arglist} as |
79 | 2344 arguments. |
685 | 2345 {func} can either be a |Funcref| or the name of a function. |
79 | 2346 a:firstline and a:lastline are set to the cursor line. |
2347 Returns the return value of the called function. | |
102 | 2348 {dict} is for functions with the "dict" attribute. It will be |
2349 used to set the local variable "self". |Dictionary-function| | |
79 | 2350 |
1621 | 2351 ceil({expr}) *ceil()* |
2352 Return the smallest integral value greater than or equal to | |
2353 {expr} as a |Float| (round up). | |
2354 {expr} must evaluate to a |Float| or a |Number|. | |
2355 Examples: > | |
2356 echo ceil(1.456) | |
2357 < 2.0 > | |
2358 echo ceil(-5.456) | |
2359 < -5.0 > | |
2360 echo ceil(4.0) | |
2361 < 4.0 | |
2362 {only available when compiled with the |+float| feature} | |
2363 | |
777 | 2364 changenr() *changenr()* |
2365 Return the number of the most recent change. This is the same | |
2366 number as what is displayed with |:undolist| and can be used | |
2367 with the |:undo| command. | |
2368 When a change was made it is the number of that change. After | |
2369 redo it is the number of the redone change. After undo it is | |
2370 one less than the number of the undone change. | |
2371 | |
4051 | 2372 char2nr({expr}[, {utf8}]) *char2nr()* |
7 | 2373 Return number value of the first char in {expr}. Examples: > |
2374 char2nr(" ") returns 32 | |
2375 char2nr("ABC") returns 65 | |
4051 | 2376 < When {utf8} is omitted or zero, the current 'encoding' is used. |
2377 Example for "utf-8": > | |
1156 | 2378 char2nr("á") returns 225 |
2379 char2nr("á"[0]) returns 195 | |
4051 | 2380 < With {utf8} set to 1, always treat as utf-8 characters. |
2381 A combining character is a separate character. | |
2965 | 2382 |nr2char()| does the opposite. |
7 | 2383 |
2384 cindent({lnum}) *cindent()* | |
2385 Get the amount of indent for line {lnum} according the C | |
2386 indenting rules, as with 'cindent'. | |
2387 The indent is counted in spaces, the value of 'tabstop' is | |
2388 relevant. {lnum} is used just like in |getline()|. | |
2389 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2390 feature, -1 is returned. | |
548 | 2391 See |C-indenting|. |
7 | 2392 |
1326 | 2393 clearmatches() *clearmatches()* |
2394 Clears all matches previously defined by |matchadd()| and the | |
2395 |:match| commands. | |
2396 | |
7 | 2397 *col()* |
24 | 2398 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2399 position given with {expr}. The accepted positions are: |
2400 . the cursor position | |
2401 $ the end of the cursor line (the result is the | |
3513 | 2402 number of bytes in the cursor line plus one) |
7 | 2403 'x position of mark x (if the mark is not set, 0 is |
2404 returned) | |
6447 | 2405 v In Visual mode: the start of the Visual area (the |
2406 cursor is the end). When not in Visual mode | |
2407 returns the cursor position. Differs from |'<| in | |
2408 that it's updated right away. | |
1317 | 2409 Additionally {expr} can be [lnum, col]: a |List| with the line |
2410 and column number. Most useful when the column is "$", to get | |
1621 | 2411 the last column of a specific line. When "lnum" or "col" is |
1317 | 2412 out of range then col() returns zero. |
1156 | 2413 To get the line number use |line()|. To get both use |
703 | 2414 |getpos()|. |
7 | 2415 For the screen column position use |virtcol()|. |
2416 Note that only marks in the current file can be used. | |
2417 Examples: > | |
2418 col(".") column of cursor | |
2419 col("$") length of cursor line plus one | |
2420 col("'t") column of mark t | |
2421 col("'" . markname) column of mark markname | |
1621 | 2422 < The first column is 1. 0 is returned for an error. |
1156 | 2423 For an uppercase mark the column may actually be in another |
2424 buffer. | |
7 | 2425 For the cursor position, when 'virtualedit' is active, the |
2426 column is one higher if the cursor is after the end of the | |
2427 line. This can be used to obtain the column in Insert mode: > | |
2428 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2429 \<C-O>:set ve=all<CR> | |
2430 \<C-O>:echo col(".") . "\n" <Bar> | |
2431 \let &ve = save_ve<CR> | |
2432 < | |
464 | 2433 |
724 | 2434 complete({startcol}, {matches}) *complete()* *E785* |
2435 Set the matches for Insert mode completion. | |
2436 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2437 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2438 with an expression mapping. | |
724 | 2439 {startcol} is the byte offset in the line where the completed |
2440 text start. The text up to the cursor is the original text | |
2441 that will be replaced by the matches. Use col('.') for an | |
2442 empty string. "col('.') - 1" will replace one character by a | |
2443 match. | |
2444 {matches} must be a |List|. Each |List| item is one match. | |
2445 See |complete-items| for the kind of items that are possible. | |
2446 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
|
2447 inserting anything that would cause completion to stop. |
724 | 2448 The match can be selected with CTRL-N and CTRL-P as usual with |
2449 Insert mode completion. The popup menu will appear if | |
2450 specified, see |ins-completion-menu|. | |
2451 Example: > | |
1156 | 2452 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2453 |
2454 func! ListMonths() | |
2455 call complete(col('.'), ['January', 'February', 'March', | |
2456 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2457 \ 'October', 'November', 'December']) | |
2458 return '' | |
2459 endfunc | |
2460 < This isn't very useful, but it shows how it works. Note that | |
2461 an empty string is returned to avoid a zero being inserted. | |
2462 | |
464 | 2463 complete_add({expr}) *complete_add()* |
2464 Add {expr} to the list of matches. Only to be used by the | |
2465 function specified with the 'completefunc' option. | |
2466 Returns 0 for failure (empty string or out of memory), | |
2467 1 when the match was added, 2 when the match was already in | |
2468 the list. | |
1621 | 2469 See |complete-functions| for an explanation of {expr}. It is |
786 | 2470 the same as one item in the list that 'omnifunc' would return. |
464 | 2471 |
2472 complete_check() *complete_check()* | |
2473 Check for a key typed while looking for completion matches. | |
2474 This is to be used when looking for matches takes some time. | |
2475 Returns non-zero when searching for matches is to be aborted, | |
2476 zero otherwise. | |
2477 Only to be used by the function specified with the | |
2478 'completefunc' option. | |
2479 | |
7 | 2480 *confirm()* |
2481 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2482 Confirm() offers the user a dialog, from which a choice can be | |
2483 made. It returns the number of the choice. For the first | |
2484 choice this is 1. | |
2485 Note: confirm() is only supported when compiled with dialog | |
2486 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
|
2487 |
7 | 2488 {msg} is displayed in a |dialog| with {choices} as the |
2489 alternatives. When {choices} is missing or empty, "&OK" is | |
2490 used (and translated). | |
2491 {msg} is a String, use '\n' to include a newline. Only on | |
2492 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
|
2493 |
7 | 2494 {choices} is a String, with the individual choices separated |
2495 by '\n', e.g. > | |
2496 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2497 < The letter after the '&' is the shortcut key for that choice. | |
2498 Thus you can type 'c' to select "Cancel". The shortcut does | |
2499 not need to be the first letter: > | |
2500 confirm("file has been modified", "&Save\nSave &All") | |
2501 < For the console, the first letter of each choice is used as | |
2502 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
|
2503 |
7 | 2504 The optional {default} argument is the number of the choice |
2505 that is made if the user hits <CR>. Use 1 to make the first | |
2506 choice the default one. Use 0 to not set a default. If | |
2507 {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
|
2508 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2509 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
|
2510 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
|
2511 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
|
2512 "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
|
2513 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
|
2514 |
7 | 2515 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2516 or another valid interrupt key, confirm() returns 0. | |
2517 | |
2518 An example: > | |
2519 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2520 :if choice == 0 | |
2521 : echo "make up your mind!" | |
2522 :elseif choice == 3 | |
2523 : echo "tasteful" | |
2524 :else | |
2525 : echo "I prefer bananas myself." | |
2526 :endif | |
2527 < In a GUI dialog, buttons are used. The layout of the buttons | |
2528 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2529 the buttons are always put vertically. Otherwise, confirm() |
7 | 2530 tries to put the buttons in one horizontal line. If they |
2531 don't fit, a vertical layout is used anyway. For some systems | |
2532 the horizontal layout is always used. | |
2533 | |
55 | 2534 *copy()* |
1621 | 2535 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2536 different from using {expr} directly. |
685 | 2537 When {expr} is a |List| a shallow copy is created. This means |
2538 that the original |List| can be changed without changing the | |
1621 | 2539 copy, and vice versa. But the items are identical, thus |
2540 changing an item changes the contents of both |Lists|. Also | |
685 | 2541 see |deepcopy()|. |
55 | 2542 |
1621 | 2543 cos({expr}) *cos()* |
2544 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2545 {expr} must evaluate to a |Float| or a |Number|. | |
2546 Examples: > | |
2547 :echo cos(100) | |
2548 < 0.862319 > | |
2549 :echo cos(-4.01) | |
2550 < -0.646043 | |
2551 {only available when compiled with the |+float| feature} | |
2552 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2553 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2554 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2555 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
|
2556 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2557 {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
|
2558 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2559 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2560 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2561 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2562 < -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
|
2563 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2564 |
1621 | 2565 |
102 | 2566 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2567 Return the number of times an item with value {expr} appears |
685 | 2568 in |List| or |Dictionary| {comp}. |
102 | 2569 If {start} is given then start with the item with this index. |
685 | 2570 {start} can only be used with a |List|. |
79 | 2571 When {ic} is given and it's non-zero then case is ignored. |
2572 | |
2573 | |
7 | 2574 *cscope_connection()* |
2575 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2576 Checks for the existence of a |cscope| connection. If no | |
2577 parameters are specified, then the function returns: | |
2578 0, if cscope was not available (not compiled in), or | |
2579 if there are no cscope connections; | |
2580 1, if there is at least one cscope connection. | |
2581 | |
2582 If parameters are specified, then the value of {num} | |
2583 determines how existence of a cscope connection is checked: | |
2584 | |
2585 {num} Description of existence check | |
2586 ----- ------------------------------ | |
2587 0 Same as no parameters (e.g., "cscope_connection()"). | |
2588 1 Ignore {prepend}, and use partial string matches for | |
2589 {dbpath}. | |
2590 2 Ignore {prepend}, and use exact string matches for | |
2591 {dbpath}. | |
2592 3 Use {prepend}, use partial string matches for both | |
2593 {dbpath} and {prepend}. | |
2594 4 Use {prepend}, use exact string matches for both | |
2595 {dbpath} and {prepend}. | |
2596 | |
2597 Note: All string comparisons are case sensitive! | |
2598 | |
2599 Examples. Suppose we had the following (from ":cs show"): > | |
2600 | |
2601 # pid database name prepend path | |
2602 0 27664 cscope.out /usr/local | |
2603 < | |
2604 Invocation Return Val ~ | |
2605 ---------- ---------- > | |
2606 cscope_connection() 1 | |
2607 cscope_connection(1, "out") 1 | |
2608 cscope_connection(2, "out") 0 | |
2609 cscope_connection(3, "out") 0 | |
2610 cscope_connection(3, "out", "local") 1 | |
2611 cscope_connection(4, "out") 0 | |
2612 cscope_connection(4, "out", "local") 0 | |
2613 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2614 < | |
703 | 2615 cursor({lnum}, {col} [, {off}]) *cursor()* |
2616 cursor({list}) | |
1156 | 2617 Positions the cursor at the column (byte count) {col} in the |
2618 line {lnum}. The first column is one. | |
5938 | 2619 |
703 | 2620 When there is one argument {list} this is used as a |List| |
5938 | 2621 with two, three or four item: |
2622 [{lnum}, {col}, {off}] | |
2623 [{lnum}, {col}, {off}, {curswant}] | |
6009 | 2624 This is like the return value of |getpos()| or |getcurpos()|, |
5944 | 2625 but without the first item. |
5938 | 2626 |
7 | 2627 Does not change the jumplist. |
2628 If {lnum} is greater than the number of lines in the buffer, | |
2629 the cursor will be positioned at the last line in the buffer. | |
2630 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 2631 If {col} is greater than the number of bytes in the line, |
7 | 2632 the cursor will be positioned at the last character in the |
2633 line. | |
2634 If {col} is zero, the cursor will stay in the current column. | |
5944 | 2635 If {curswant} is given it is used to set the preferred column |
6180 | 2636 for vertical movement. Otherwise {col} is used. |
6385 | 2637 |
703 | 2638 When 'virtualedit' is used {off} specifies the offset in |
2639 screen columns from the start of the character. E.g., a | |
1266 | 2640 position within a <Tab> or after the last character. |
1851 | 2641 Returns 0 when the position could be set, -1 otherwise. |
7 | 2642 |
55 | 2643 |
164 | 2644 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 2645 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2646 different from using {expr} directly. |
685 | 2647 When {expr} is a |List| a full copy is created. This means |
2648 that the original |List| can be changed without changing the | |
1621 | 2649 copy, and vice versa. When an item is a |List|, a copy for it |
55 | 2650 is made, recursively. Thus changing an item in the copy does |
685 | 2651 not change the contents of the original |List|. |
2652 When {noref} is omitted or zero a contained |List| or | |
2653 |Dictionary| is only copied once. All references point to | |
2654 this single copy. With {noref} set to 1 every occurrence of a | |
2655 |List| or |Dictionary| results in a new copy. This also means | |
2656 that a cyclic reference causes deepcopy() to fail. | |
114 | 2657 *E724* |
2658 Nesting is possible up to 100 levels. When there is an item | |
164 | 2659 that refers back to a higher level making a deep copy with |
2660 {noref} set to 1 will fail. | |
55 | 2661 Also see |copy()|. |
2662 | |
2663 delete({fname}) *delete()* | |
2664 Deletes the file by the name {fname}. The result is a Number, | |
7 | 2665 which is 0 if the file was deleted successfully, and non-zero |
2666 when the deletion failed. | |
685 | 2667 Use |remove()| to delete an item from a |List|. |
4229 | 2668 To delete a line from the buffer use |:delete|. Use |:exe| |
2669 when the line number is in a variable. | |
7 | 2670 |
2671 *did_filetype()* | |
2672 did_filetype() Returns non-zero when autocommands are being executed and the | |
2673 FileType event has been triggered at least once. Can be used | |
2674 to avoid triggering the FileType event again in the scripts | |
2675 that detect the file type. |FileType| | |
2676 When editing another file, the counter is reset, thus this | |
2677 really checks if the FileType event has been triggered for the | |
2678 current buffer. This allows an autocommand that starts | |
2679 editing another buffer to set 'filetype' and load a syntax | |
2680 file. | |
2681 | |
32 | 2682 diff_filler({lnum}) *diff_filler()* |
2683 Returns the number of filler lines above line {lnum}. | |
2684 These are the lines that were inserted at this point in | |
2685 another diff'ed window. These filler lines are shown in the | |
2686 display but don't exist in the buffer. | |
2687 {lnum} is used like with |getline()|. Thus "." is the current | |
2688 line, "'m" mark m, etc. | |
2689 Returns 0 if the current window is not in diff mode. | |
2690 | |
2691 diff_hlID({lnum}, {col}) *diff_hlID()* | |
2692 Returns the highlight ID for diff mode at line {lnum} column | |
2693 {col} (byte index). When the current line does not have a | |
2694 diff change zero is returned. | |
2695 {lnum} is used like with |getline()|. Thus "." is the current | |
2696 line, "'m" mark m, etc. | |
2697 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
2698 line. | |
2699 The highlight ID can be used with |synIDattr()| to obtain | |
2700 syntax information about the highlighting. | |
2701 | |
85 | 2702 empty({expr}) *empty()* |
2703 Return the Number 1 if {expr} is empty, zero otherwise. | |
685 | 2704 A |List| or |Dictionary| is empty when it does not have any |
1621 | 2705 items. A Number is empty when its value is zero. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2706 For a long |List| this is much faster than comparing the |
685 | 2707 length with zero. |
85 | 2708 |
7 | 2709 escape({string}, {chars}) *escape()* |
2710 Escape the characters in {chars} that occur in {string} with a | |
2711 backslash. Example: > | |
2712 :echo escape('c:\program files\vim', ' \') | |
2713 < results in: > | |
2714 c:\\program\ files\\vim | |
1621 | 2715 < Also see |shellescape()|. |
2716 | |
2717 *eval()* | |
95 | 2718 eval({string}) Evaluate {string} and return the result. Especially useful to |
2719 turn the result of |string()| back into the original value. | |
1621 | 2720 This works for Numbers, Floats, Strings and composites of |
2721 them. Also works for |Funcref|s that refer to existing | |
2722 functions. | |
95 | 2723 |
7 | 2724 eventhandler() *eventhandler()* |
2725 Returns 1 when inside an event handler. That is that Vim got | |
2726 interrupted while waiting for the user to type a character, | |
2727 e.g., when dropping a file on Vim. This means interactive | |
2728 commands cannot be used. Otherwise zero is returned. | |
2729 | |
2730 executable({expr}) *executable()* | |
2731 This function checks if an executable with the name {expr} | |
2732 exists. {expr} must be the name of the program without any | |
10 | 2733 arguments. |
2734 executable() uses the value of $PATH and/or the normal | |
2735 searchpath for programs. *PATHEXT* | |
2736 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
2737 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 2738 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
2739 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 2740 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 2741 the name without an extension. When 'shell' looks like a |
10 | 2742 Unix shell, then the name is also tried without adding an |
2743 extension. | |
2744 On MS-DOS and MS-Windows it only checks if the file exists and | |
2745 is not a directory, not if it's really executable. | |
819 | 2746 On MS-Windows an executable in the same directory as Vim is |
2747 always found. Since this directory is added to $PATH it | |
2748 should also work to execute it |win32-PATH|. | |
7 | 2749 The result is a Number: |
2750 1 exists | |
2751 0 does not exist | |
2752 -1 not implemented on this system | |
2753 | |
5782 | 2754 exepath({expr}) *exepath()* |
2755 If {expr} is an executable and is either an absolute path, a | |
2756 relative path or found in $PATH, return the full path. | |
2757 Note that the current directory is used when {expr} starts | |
2758 with "./", which may be a problem for Vim: > | |
2759 echo exepath(v:progpath) | |
5814 | 2760 < If {expr} cannot be found in $PATH or is not executable then |
5782 | 2761 an empty string is returned. |
2762 | |
7 | 2763 *exists()* |
2764 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
2765 defined, zero otherwise. The {expr} argument is a string, | |
2766 which contains one of these: | |
2767 &option-name Vim option (only checks if it exists, | |
2768 not if it really works) | |
2769 +option-name Vim option that works. | |
2770 $ENVNAME environment variable (could also be | |
2771 done by comparing with an empty | |
2772 string) | |
2773 *funcname built-in function (see |functions|) | |
2774 or user defined function (see | |
5862 | 2775 |user-functions|). Also works for a |
2776 variable that is a Funcref. | |
7 | 2777 varname internal variable (see |
1621 | 2778 |internal-variables|). Also works |
685 | 2779 for |curly-braces-names|, |Dictionary| |
2780 entries, |List| items, etc. Beware | |
1668 | 2781 that evaluating an index may cause an |
2782 error message for an invalid | |
2783 expression. E.g.: > | |
2784 :let l = [1, 2, 3] | |
2785 :echo exists("l[5]") | |
2786 < 0 > | |
2787 :echo exists("l[xx]") | |
2788 < E121: Undefined variable: xx | |
2789 0 | |
7 | 2790 :cmdname Ex command: built-in command, user |
2791 command or command modifier |:command|. | |
2792 Returns: | |
2793 1 for match with start of a command | |
2794 2 full match with a command | |
2795 3 matches several user commands | |
2796 To check for a supported command | |
2797 always check the return value to be 2. | |
864 | 2798 :2match The |:2match| command. |
2799 :3match The |:3match| command. | |
7 | 2800 #event autocommand defined for this event |
2801 #event#pattern autocommand defined for this event and | |
2802 pattern (the pattern is taken | |
2803 literally and compared to the | |
2804 autocommand patterns character by | |
2805 character) | |
613 | 2806 #group autocommand group exists |
2807 #group#event autocommand defined for this group and | |
2808 event. | |
2809 #group#event#pattern | |
856 | 2810 autocommand defined for this group, |
613 | 2811 event and pattern. |
615 | 2812 ##event autocommand for this event is |
2813 supported. | |
7 | 2814 For checking for a supported feature use |has()|. |
2815 | |
2816 Examples: > | |
2817 exists("&shortname") | |
2818 exists("$HOSTNAME") | |
2819 exists("*strftime") | |
2820 exists("*s:MyFunc") | |
2821 exists("bufcount") | |
2822 exists(":Make") | |
613 | 2823 exists("#CursorHold") |
7 | 2824 exists("#BufReadPre#*.gz") |
613 | 2825 exists("#filetypeindent") |
2826 exists("#filetypeindent#FileType") | |
2827 exists("#filetypeindent#FileType#*") | |
615 | 2828 exists("##ColorScheme") |
7 | 2829 < There must be no space between the symbol (&/$/*/#) and the |
2830 name. | |
867 | 2831 There must be no extra characters after the name, although in |
2832 a few cases this is ignored. That may become more strict in | |
2833 the future, thus don't count on it! | |
2834 Working example: > | |
2835 exists(":make") | |
2836 < NOT working example: > | |
2837 exists(":make install") | |
859 | 2838 |
2839 < Note that the argument must be a string, not the name of the | |
2840 variable itself. For example: > | |
7 | 2841 exists(bufcount) |
2842 < This doesn't check for existence of the "bufcount" variable, | |
853 | 2843 but gets the value of "bufcount", and checks if that exists. |
7 | 2844 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2845 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2846 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
|
2847 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2848 {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
|
2849 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2850 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2851 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2852 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2853 < 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
|
2854 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2855 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2856 |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2857 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
7 | 2858 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
|
2859 'wildignorecase' applies. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2860 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2861 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
|
2862 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
|
2863 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
|
2864 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
|
2865 file name contains a space] |
7 | 2866 |
1621 | 2867 If the expansion fails, the result is an empty string. A name |
4869 | 2868 for a non-existing file is not included, unless {expr} does |
2869 not start with '%', '#' or '<', see below. | |
7 | 2870 |
2871 When {expr} starts with '%', '#' or '<', the expansion is done | |
2872 like for the |cmdline-special| variables with their associated | |
2873 modifiers. Here is a short overview: | |
2874 | |
2875 % current file name | |
2876 # alternate file name | |
2877 #n alternate file name n | |
2878 <cfile> file name under the cursor | |
2879 <afile> autocmd file name | |
2880 <abuf> autocmd buffer number (as a String!) | |
2881 <amatch> autocmd matched name | |
5734 | 2882 <sfile> sourced script file or function name |
2662 | 2883 <slnum> sourced script file line number |
7 | 2884 <cword> word under the cursor |
2885 <cWORD> WORD under the cursor | |
2886 <client> the {clientid} of the last received | |
2887 message |server2client()| | |
2888 Modifiers: | |
2889 :p expand to full path | |
2890 :h head (last path component removed) | |
2891 :t tail (last path component only) | |
2892 :r root (one extension removed) | |
2893 :e extension only | |
2894 | |
2895 Example: > | |
2896 :let &tags = expand("%:p:h") . "/tags" | |
2897 < Note that when expanding a string that starts with '%', '#' or | |
2898 '<', any following text is ignored. This does NOT work: > | |
2899 :let doesntwork = expand("%:h.bak") | |
2900 < Use this: > | |
2901 :let doeswork = expand("%:h") . ".bak" | |
2902 < Also note that expanding "<cfile>" and others only returns the | |
2903 referenced file name without further expansion. If "<cfile>" | |
2904 is "~/.cshrc", you need to do another expand() to have the | |
2905 "~/" expanded into the path of the home directory: > | |
2906 :echo expand(expand("<cfile>")) | |
2907 < | |
2908 There cannot be white space between the variables and the | |
2909 following modifier. The |fnamemodify()| function can be used | |
2910 to modify normal file names. | |
2911 | |
2912 When using '%' or '#', and the current or alternate file name | |
2913 is not defined, an empty string is used. Using "%:p" in a | |
2914 buffer with no name, results in the current directory, with a | |
2915 '/' added. | |
2916 | |
2917 When {expr} does not start with '%', '#' or '<', it is | |
2918 expanded like a file name is expanded on the command line. | |
2919 'suffixes' and 'wildignore' are used, unless the optional | |
3398 | 2920 {nosuf} argument is given and it is non-zero. |
2921 Names for non-existing files are included. The "**" item can | |
2922 be used to search in a directory tree. For example, to find | |
2923 all "README" files in the current directory and below: > | |
444 | 2924 :echo expand("**/README") |
2925 < | |
7 | 2926 Expand() can also be used to expand variables and environment |
2927 variables that are only known in a shell. But this can be | |
6180 | 2928 slow, because a shell may be used to do the expansion. See |
2929 |expr-env-expand|. | |
7 | 2930 The expanded variable is still handled like a list of file |
1621 | 2931 names. When an environment variable cannot be expanded, it is |
7 | 2932 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
2933 "$FOOBAR". | |
2934 | |
2935 See |glob()| for finding existing files. See |system()| for | |
2936 getting the raw output of an external command. | |
2937 | |
102 | 2938 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 2939 {expr1} and {expr2} must be both |Lists| or both |
2940 |Dictionaries|. | |
2941 | |
2942 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 2943 If {expr3} is given insert the items of {expr2} before item |
2944 {expr3} in {expr1}. When {expr3} is zero insert before the | |
2945 first item. When {expr3} is equal to len({expr1}) then | |
2946 {expr2} is appended. | |
79 | 2947 Examples: > |
2948 :echo sort(extend(mylist, [7, 5])) | |
2949 :call extend(mylist, [2, 3], 1) | |
1699 | 2950 < When {expr1} is the same List as {expr2} then the number of |
2951 items copied is equal to the original length of the List. | |
2952 E.g., when {expr3} is 1 you get N new copies of the first item | |
2953 (where N is the original length of the List). | |
2954 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 2955 two lists into a new list use the + operator: > |
79 | 2956 :let newlist = [1, 2, 3] + [4, 5] |
102 | 2957 < |
692 | 2958 If they are |Dictionaries|: |
102 | 2959 Add all entries from {expr2} to {expr1}. |
2960 If a key exists in both {expr1} and {expr2} then {expr3} is | |
2961 used to decide what to do: | |
2962 {expr3} = "keep": keep the value of {expr1} | |
2963 {expr3} = "force": use the value of {expr2} | |
856 | 2964 {expr3} = "error": give an error message *E737* |
102 | 2965 When {expr3} is omitted then "force" is assumed. |
2966 | |
2967 {expr1} is changed when {expr2} is not empty. If necessary | |
2968 make a copy of {expr1} first. | |
2969 {expr2} remains unchanged. | |
6823 | 2970 When {expr1} is locked and {expr2} is not empty the operation |
2971 fails. | |
102 | 2972 Returns {expr1}. |
2973 | |
79 | 2974 |
842 | 2975 feedkeys({string} [, {mode}]) *feedkeys()* |
2976 Characters in {string} are queued for processing as if they | |
6549 | 2977 come from a mapping or were typed by the user. |
2978 By default the string is added to the end of the typeahead | |
2979 buffer, thus if a mapping is still being executed the | |
2980 characters come after them. Use the 'i' flag to insert before | |
2981 other characters, they will be executed next, before any | |
2982 characters from a mapping. | |
842 | 2983 The function does not wait for processing of keys contained in |
2984 {string}. | |
2985 To include special keys into {string}, use double-quotes | |
2986 and "\..." notation |expr-quote|. For example, | |
1215 | 2987 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 2988 feedkeys('\<CR>') pushes 5 characters. |
2989 If {mode} is absent, keys are remapped. | |
2990 {mode} is a String, which can contain these character flags: | |
843 | 2991 'm' Remap keys. This is default. |
2992 'n' Do not remap keys. | |
2993 't' Handle keys as if typed; otherwise they are handled as | |
2994 if coming from a mapping. This matters for undo, | |
2995 opening folds, etc. | |
6549 | 2996 'i' Insert the string instead of appending (see above). |
842 | 2997 Return value is always 0. |
2998 | |
7 | 2999 filereadable({file}) *filereadable()* |
3000 The result is a Number, which is TRUE when a file with the | |
3001 name {file} exists, and can be read. If {file} doesn't exist, | |
3002 or is a directory, the result is FALSE. {file} is any | |
3003 expression, which is used as a String. | |
1156 | 3004 If you don't care about the file being readable you can use |
3005 |glob()|. | |
7 | 3006 *file_readable()* |
3007 Obsolete name: file_readable(). | |
3008 | |
95 | 3009 |
1156 | 3010 filewritable({file}) *filewritable()* |
3011 The result is a Number, which is 1 when a file with the | |
3012 name {file} exists, and can be written. If {file} doesn't | |
1621 | 3013 exist, or is not writable, the result is 0. If {file} is a |
1156 | 3014 directory, and we can write to it, the result is 2. |
3015 | |
3016 | |
102 | 3017 filter({expr}, {string}) *filter()* |
685 | 3018 {expr} must be a |List| or a |Dictionary|. |
102 | 3019 For each item in {expr} evaluate {string} and when the result |
685 | 3020 is zero remove the item from the |List| or |Dictionary|. |
102 | 3021 Inside {string} |v:val| has the value of the current item. |
685 | 3022 For a |Dictionary| |v:key| has the key of the current item. |
102 | 3023 Examples: > |
3024 :call filter(mylist, 'v:val !~ "OLD"') | |
3025 < Removes the items where "OLD" appears. > | |
3026 :call filter(mydict, 'v:key >= 8') | |
3027 < Removes the items with a key below 8. > | |
3028 :call filter(var, 0) | |
685 | 3029 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 3030 |
102 | 3031 Note that {string} is the result of expression and is then |
3032 used as an expression again. Often it is good to use a | |
3033 |literal-string| to avoid having to double backslashes. | |
3034 | |
685 | 3035 The operation is done in-place. If you want a |List| or |
3036 |Dictionary| to remain unmodified make a copy first: > | |
650 | 3037 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 3038 |
685 | 3039 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3040 When an error is encountered while evaluating {string} no |
3041 further items in {expr} are processed. | |
95 | 3042 |
3043 | |
19 | 3044 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 3045 Find directory {name} in {path}. Supports both downwards and |
3046 upwards recursive directory searches. See |file-searching| | |
3047 for the syntax of {path}. | |
3048 Returns the path of the first found match. When the found | |
3049 directory is below the current directory a relative path is | |
3050 returned. Otherwise a full path is returned. | |
19 | 3051 If {path} is omitted or empty then 'path' is used. |
3052 If the optional {count} is given, find {count}'s occurrence of | |
794 | 3053 {name} in {path} instead of the first one. |
809 | 3054 When {count} is negative return all the matches in a |List|. |
19 | 3055 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
|
3056 {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
|
3057 feature} |
794 | 3058 |
3059 findfile({name}[, {path}[, {count}]]) *findfile()* | |
3060 Just like |finddir()|, but find a file instead of a directory. | |
3061 Uses 'suffixesadd'. | |
19 | 3062 Example: > |
3063 :echo findfile("tags.vim", ".;") | |
1156 | 3064 < Searches from the directory of the current file upwards until |
3065 it finds the file "tags.vim". | |
7 | 3066 |
1621 | 3067 float2nr({expr}) *float2nr()* |
3068 Convert {expr} to a Number by omitting the part after the | |
3069 decimal point. | |
3070 {expr} must evaluate to a |Float| or a Number. | |
3071 When the value of {expr} is out of range for a |Number| the | |
3072 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
3073 in -0x80000000. | |
3074 Examples: > | |
3075 echo float2nr(3.95) | |
3076 < 3 > | |
3077 echo float2nr(-23.45) | |
3078 < -23 > | |
3079 echo float2nr(1.0e100) | |
3080 < 2147483647 > | |
3081 echo float2nr(-1.0e150) | |
3082 < -2147483647 > | |
3083 echo float2nr(1.0e-100) | |
3084 < 0 | |
3085 {only available when compiled with the |+float| feature} | |
3086 | |
3087 | |
3088 floor({expr}) *floor()* | |
3089 Return the largest integral value less than or equal to | |
3090 {expr} as a |Float| (round down). | |
3091 {expr} must evaluate to a |Float| or a |Number|. | |
3092 Examples: > | |
3093 echo floor(1.856) | |
3094 < 1.0 > | |
3095 echo floor(-5.456) | |
3096 < -6.0 > | |
3097 echo floor(4.0) | |
3098 < 4.0 | |
3099 {only available when compiled with the |+float| feature} | |
3100 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3101 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3102 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3103 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3104 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3105 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
|
3106 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
|
3107 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
|
3108 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
|
3109 {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
|
3110 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3111 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3112 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3113 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3114 < -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
|
3115 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3116 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3117 |
1586 | 3118 fnameescape({string}) *fnameescape()* |
1621 | 3119 Escape {string} for use as file name command argument. All |
1586 | 3120 characters that have a special meaning, such as '%' and '|' |
3121 are escaped with a backslash. | |
1621 | 3122 For most systems the characters escaped are |
3123 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3124 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3125 A leading '+' and '>' is also escaped (special after |:edit| |
3126 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3127 Example: > |
1700 | 3128 :let fname = '+some str%nge|name' |
1586 | 3129 :exe "edit " . fnameescape(fname) |
3130 < results in executing: > | |
1700 | 3131 edit \+some\ str\%nge\|name |
1586 | 3132 |
7 | 3133 fnamemodify({fname}, {mods}) *fnamemodify()* |
3134 Modify file name {fname} according to {mods}. {mods} is a | |
3135 string of characters like it is used for file names on the | |
3136 command line. See |filename-modifiers|. | |
3137 Example: > | |
3138 :echo fnamemodify("main.c", ":p:h") | |
3139 < results in: > | |
3140 /home/mool/vim/vim/src | |
1621 | 3141 < Note: Environment variables don't work in {fname}, use |
7 | 3142 |expand()| first then. |
3143 | |
3144 foldclosed({lnum}) *foldclosed()* | |
3145 The result is a Number. If the line {lnum} is in a closed | |
3146 fold, the result is the number of the first line in that fold. | |
3147 If the line {lnum} is not in a closed fold, -1 is returned. | |
3148 | |
3149 foldclosedend({lnum}) *foldclosedend()* | |
3150 The result is a Number. If the line {lnum} is in a closed | |
3151 fold, the result is the number of the last line in that fold. | |
3152 If the line {lnum} is not in a closed fold, -1 is returned. | |
3153 | |
3154 foldlevel({lnum}) *foldlevel()* | |
3155 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3156 in the current buffer. For nested folds the deepest level is |
7 | 3157 returned. If there is no fold at line {lnum}, zero is |
3158 returned. It doesn't matter if the folds are open or closed. | |
3159 When used while updating folds (from 'foldexpr') -1 is | |
3160 returned for lines where folds are still to be updated and the | |
3161 foldlevel is unknown. As a special case the level of the | |
3162 previous line is usually available. | |
3163 | |
3164 *foldtext()* | |
3165 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3166 the default function used for the 'foldtext' option and should | |
3167 only be called from evaluating 'foldtext'. It uses the | |
3168 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3169 The returned string looks like this: > | |
3170 +-- 45 lines: abcdef | |
1621 | 3171 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3172 the number of lines in the fold. "abcdef" is the text in the |
3173 first non-blank line of the fold. Leading white space, "//" | |
3174 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3175 options is removed. | |
3176 {not available when compiled without the |+folding| feature} | |
3177 | |
29 | 3178 foldtextresult({lnum}) *foldtextresult()* |
3179 Returns the text that is displayed for the closed fold at line | |
3180 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3181 When there is no closed fold at {lnum} an empty string is | |
3182 returned. | |
3183 {lnum} is used like with |getline()|. Thus "." is the current | |
3184 line, "'m" mark m, etc. | |
3185 Useful when exporting folded text, e.g., to HTML. | |
3186 {not available when compiled without the |+folding| feature} | |
3187 | |
7 | 3188 *foreground()* |
1621 | 3189 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3190 a client to a Vim server. |remote_send()| |
3191 On Win32 systems this might not work, the OS does not always | |
3192 allow a window to bring itself to the foreground. Use | |
3193 |remote_foreground()| instead. | |
3194 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3195 Win32 console version} | |
3196 | |
82 | 3197 |
85 | 3198 function({name}) *function()* *E700* |
685 | 3199 Return a |Funcref| variable that refers to function {name}. |
55 | 3200 {name} can be a user defined function or an internal function. |
3201 | |
82 | 3202 |
3224 | 3203 garbagecollect([{atexit}]) *garbagecollect()* |
692 | 3204 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 3205 references. There is hardly ever a need to invoke this |
3206 function, as it is automatically done when Vim runs out of | |
3207 memory or is waiting for the user to press a key after | |
3208 'updatetime'. Items without circular references are always | |
3209 freed when they become unused. | |
685 | 3210 This is useful if you have deleted a very big |List| and/or |
3211 |Dictionary| with circular references in a script that runs | |
3212 for a long time. | |
3224 | 3213 When the optional {atexit} argument is one, garbage |
1405 | 3214 collection will also be done when exiting Vim, if it wasn't |
3215 done before. This is useful when checking for memory leaks. | |
370 | 3216 |
140 | 3217 get({list}, {idx} [, {default}]) *get()* |
685 | 3218 Get item {idx} from |List| {list}. When this item is not |
82 | 3219 available return {default}. Return zero when {default} is |
3220 omitted. | |
102 | 3221 get({dict}, {key} [, {default}]) |
685 | 3222 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3223 item is not available return {default}. Return zero when |
3224 {default} is omitted. | |
3225 | |
435 | 3226 *getbufline()* |
3227 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3228 Return a |List| with the lines starting from {lnum} to {end} |
3229 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3230 |List| with only the line {lnum} is returned. | |
435 | 3231 |
3232 For the use of {expr}, see |bufname()| above. | |
3233 | |
448 | 3234 For {lnum} and {end} "$" can be used for the last line of the |
3235 buffer. Otherwise a number must be used. | |
435 | 3236 |
3237 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3238 lines in the buffer, an empty |List| is returned. |
435 | 3239 |
3240 When {end} is greater than the number of lines in the buffer, | |
3241 it is treated as {end} is set to the number of lines in the | |
685 | 3242 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3243 returned. |
3244 | |
448 | 3245 This function works only for loaded buffers. For unloaded and |
685 | 3246 non-existing buffers, an empty |List| is returned. |
435 | 3247 |
3248 Example: > | |
3249 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3250 |
4157 | 3251 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
82 | 3252 The result is the value of option or local buffer variable |
3253 {varname} in buffer {expr}. Note that the name without "b:" | |
3254 must be used. | |
1668 | 3255 When {varname} is empty returns a dictionary with all the |
3256 buffer-local variables. | |
216 | 3257 This also works for a global or buffer-local option, but it |
3258 doesn't work for a global variable, window-local variable or | |
3259 window-local option. | |
82 | 3260 For the use of {expr}, see |bufname()| above. |
4157 | 3261 When the buffer or variable doesn't exist {def} or an empty |
3262 string is returned, there is no error message. | |
82 | 3263 Examples: > |
3264 :let bufmodified = getbufvar(1, "&mod") | |
3265 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3266 < | |
7 | 3267 getchar([expr]) *getchar()* |
867 | 3268 Get a single character from the user or input stream. |
7 | 3269 If [expr] is omitted, wait until a character is available. |
3270 If [expr] is 0, only get a character when one is available. | |
867 | 3271 Return zero otherwise. |
7 | 3272 If [expr] is 1, only check if a character is available, it is |
867 | 3273 not consumed. Return zero if no character available. |
3274 | |
5555 | 3275 Without [expr] and when [expr] is 0 a whole character or |
867 | 3276 special key is returned. If it is an 8-bit character, the |
3277 result is a number. Use nr2char() to convert it to a String. | |
3278 Otherwise a String is returned with the encoded character. | |
3279 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3280 (decimal: 128). This is the same value as the string |
3281 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3282 String when a modifier (shift, control, alt) was used that is | |
3283 not included in the character. | |
867 | 3284 |
5968 | 3285 When [expr] is 0 and Esc is typed, there will be a short delay |
3286 while Vim waits to see if this is the start of an escape | |
3287 sequence. | |
3288 | |
5555 | 3289 When [expr] is 1 only the first byte is returned. For a |
872 | 3290 one-byte character it is the character itself as a number. |
3291 Use nr2char() to convert it to a String. | |
867 | 3292 |
3224 | 3293 Use getcharmod() to obtain any additional modifiers. |
3294 | |
1029 | 3295 When the user clicks a mouse button, the mouse event will be |
3296 returned. The position can then be found in |v:mouse_col|, | |
3297 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3298 mouse as it would normally happen: > | |
3299 let c = getchar() | |
1621 | 3300 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3301 exe v:mouse_win . "wincmd w" |
3302 exe v:mouse_lnum | |
3303 exe "normal " . v:mouse_col . "|" | |
3304 endif | |
3305 < | |
7 | 3306 There is no prompt, you will somehow have to make clear to the |
3307 user that a character has to be typed. | |
3308 There is no mapping for the character. | |
3309 Key codes are replaced, thus when the user presses the <Del> | |
3310 key you get the code for the <Del> key, not the raw character | |
3311 sequence. Examples: > | |
3312 getchar() == "\<Del>" | |
3313 getchar() == "\<S-Left>" | |
3314 < This example redefines "f" to ignore case: > | |
3315 :nmap f :call FindChar()<CR> | |
3316 :function FindChar() | |
3317 : let c = nr2char(getchar()) | |
3318 : while col('.') < col('$') - 1 | |
3319 : normal l | |
3320 : if getline('.')[col('.') - 1] ==? c | |
3321 : break | |
3322 : endif | |
3323 : endwhile | |
3324 :endfunction | |
6421 | 3325 < |
6647 | 3326 You may also receive synthetic characters, such as |
6421 | 3327 |<CursorHold>|. Often you will want to ignore this and get |
3328 another character: > | |
3329 :function GetKey() | |
3330 : let c = getchar() | |
3331 : while c == "\<CursorHold>" | |
3332 : let c = getchar() | |
3333 : endwhile | |
3334 : return c | |
3335 :endfunction | |
7 | 3336 |
3337 getcharmod() *getcharmod()* | |
3338 The result is a Number which is the state of the modifiers for | |
3339 the last obtained character with getchar() or in another way. | |
3340 These values are added together: | |
3341 2 shift | |
3342 4 control | |
3343 8 alt (meta) | |
3224 | 3344 16 meta (when it's different from ALT) |
3345 32 mouse double click | |
3346 64 mouse triple click | |
3347 96 mouse quadruple click (== 32 + 64) | |
3348 128 command (Macintosh only) | |
7 | 3349 Only the modifiers that have not been included in the |
1621 | 3350 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3351 without a modifier. |
7 | 3352 |
3353 getcmdline() *getcmdline()* | |
3354 Return the current command-line. Only works when the command | |
3355 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3356 |c_CTRL-R_=|. | |
3357 Example: > | |
3358 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3359 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3360 |
95 | 3361 getcmdpos() *getcmdpos()* |
7 | 3362 Return the position of the cursor in the command line as a |
3363 byte count. The first column is 1. | |
3364 Only works when editing the command line, thus requires use of | |
3456 | 3365 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3366 Returns 0 otherwise. | |
531 | 3367 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3368 | |
3369 getcmdtype() *getcmdtype()* | |
3370 Return the current command-line type. Possible return values | |
3371 are: | |
532 | 3372 : normal Ex command |
3373 > debug mode command |debug-mode| | |
3374 / forward search command | |
3375 ? backward search command | |
3376 @ |input()| command | |
3377 - |:insert| or |:append| command | |
6213 | 3378 = |i_CTRL-R_=| |
531 | 3379 Only works when editing the command line, thus requires use of |
3456 | 3380 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3381 Returns an empty string otherwise. | |
531 | 3382 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
7 | 3383 |
6153 | 3384 getcmdwintype() *getcmdwintype()* |
3385 Return the current |command-line-window| type. Possible return | |
3386 values are the same as |getcmdtype()|. Returns an empty string | |
3387 when not in the command-line window. | |
3388 | |
5944 | 3389 *getcurpos()* |
3390 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
3391 includes an extra item in the list: | |
3392 [bufnum, lnum, col, off, curswant] | |
3393 The "curswant" number is the preferred column when moving the | |
3394 cursor vertically. | |
3395 This can be used to save and restore the cursor position: > | |
3396 let save_cursor = getcurpos() | |
3397 MoveTheCursorAround | |
3398 call setpos('.', save_cursor) | |
6153 | 3399 < |
7 | 3400 *getcwd()* |
3401 getcwd() The result is a String, which is the name of the current | |
3402 working directory. | |
3403 | |
3404 getfsize({fname}) *getfsize()* | |
3405 The result is a Number, which is the size in bytes of the | |
3406 given file {fname}. | |
3407 If {fname} is a directory, 0 is returned. | |
3408 If the file {fname} can't be found, -1 is returned. | |
1293 | 3409 If the size of {fname} is too big to fit in a Number then -2 |
3410 is returned. | |
7 | 3411 |
37 | 3412 getfontname([{name}]) *getfontname()* |
3413 Without an argument returns the name of the normal font being | |
3414 used. Like what is used for the Normal highlight group | |
3415 |hl-Normal|. | |
3416 With an argument a check is done whether {name} is a valid | |
3417 font name. If not then an empty string is returned. | |
3418 Otherwise the actual font name is returned, or {name} if the | |
3419 GUI does not support obtaining the real name. | |
824 | 3420 Only works when the GUI is running, thus not in your vimrc or |
819 | 3421 gvimrc file. Use the |GUIEnter| autocommand to use this |
3422 function just after the GUI has started. | |
37 | 3423 Note that the GTK 2 GUI accepts any font name, thus checking |
3424 for a valid name does not work. | |
3425 | |
20 | 3426 getfperm({fname}) *getfperm()* |
3427 The result is a String, which is the read, write, and execute | |
3428 permissions of the given file {fname}. | |
3429 If {fname} does not exist or its directory cannot be read, an | |
3430 empty string is returned. | |
3431 The result is of the form "rwxrwxrwx", where each group of | |
3432 "rwx" flags represent, in turn, the permissions of the owner | |
3433 of the file, the group the file belongs to, and other users. | |
3434 If a user does not have a given permission the flag for this | |
3750 | 3435 is replaced with the string "-". Examples: > |
20 | 3436 :echo getfperm("/etc/passwd") |
3750 | 3437 :echo getfperm(expand("~/.vimrc")) |
20 | 3438 < This will hopefully (from a security point of view) display |
3439 the string "rw-r--r--" or even "rw-------". | |
205 | 3440 |
7 | 3441 getftime({fname}) *getftime()* |
3442 The result is a Number, which is the last modification time of | |
3443 the given file {fname}. The value is measured as seconds | |
3444 since 1st Jan 1970, and may be passed to strftime(). See also | |
3445 |localtime()| and |strftime()|. | |
3446 If the file {fname} can't be found -1 is returned. | |
3447 | |
20 | 3448 getftype({fname}) *getftype()* |
3449 The result is a String, which is a description of the kind of | |
3450 file of the given file {fname}. | |
3451 If {fname} does not exist an empty string is returned. | |
3452 Here is a table over different kinds of files and their | |
3453 results: | |
3454 Normal file "file" | |
3455 Directory "dir" | |
3456 Symbolic link "link" | |
3457 Block device "bdev" | |
3458 Character device "cdev" | |
3459 Socket "socket" | |
3460 FIFO "fifo" | |
3461 All other "other" | |
3462 Example: > | |
3463 getftype("/home") | |
3464 < Note that a type such as "link" will only be returned on | |
3465 systems that support it. On some systems only "dir" and | |
3466 "file" are returned. | |
3467 | |
7 | 3468 *getline()* |
82 | 3469 getline({lnum} [, {end}]) |
3470 Without {end} the result is a String, which is line {lnum} | |
3471 from the current buffer. Example: > | |
7 | 3472 getline(1) |
3473 < When {lnum} is a String that doesn't start with a | |
3474 digit, line() is called to translate the String into a Number. | |
3475 To get the line under the cursor: > | |
3476 getline(".") | |
3477 < When {lnum} is smaller than 1 or bigger than the number of | |
3478 lines in the buffer, an empty string is returned. | |
3479 | |
685 | 3480 When {end} is given the result is a |List| where each item is |
3481 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3482 including line {end}. |
3483 {end} is used in the same way as {lnum}. | |
3484 Non-existing lines are silently omitted. | |
685 | 3485 When {end} is before {lnum} an empty |List| is returned. |
82 | 3486 Example: > |
3487 :let start = line('.') | |
3488 :let end = search("^$") - 1 | |
3489 :let lines = getline(start, end) | |
3490 | |
1156 | 3491 < To get lines from another buffer see |getbufline()| |
3492 | |
647 | 3493 getloclist({nr}) *getloclist()* |
3494 Returns a list with all the entries in the location list for | |
3495 window {nr}. When {nr} is zero the current window is used. | |
3496 For a location list window, the displayed location list is | |
648 | 3497 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
|
3498 returned. Otherwise, same as |getqflist()|. |
82 | 3499 |
1326 | 3500 getmatches() *getmatches()* |
3501 Returns a |List| with all matches previously defined by | |
3502 |matchadd()| and the |:match| commands. |getmatches()| is | |
3503 useful in combination with |setmatches()|, as |setmatches()| | |
3504 can restore a list of matches saved by |getmatches()|. | |
3505 Example: > | |
3506 :echo getmatches() | |
3507 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3508 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3509 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3510 :let m = getmatches() | |
3511 :call clearmatches() | |
3512 :echo getmatches() | |
3513 < [] > | |
3514 :call setmatches(m) | |
3515 :echo getmatches() | |
3516 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3517 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3518 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3519 :unlet m | |
3520 < | |
5968 | 3521 *getpid()* |
3522 getpid() Return a Number which is the process ID of the Vim process. | |
3523 On Unix and MS-Windows this is a unique number, until Vim | |
3524 exits. On MS-DOS it's always zero. | |
3525 | |
3526 *getpos()* | |
3527 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
3528 see |line()|. For getting the cursor position see | |
3529 |getcurpos()|. | |
3530 The result is a |List| with four numbers: | |
3531 [bufnum, lnum, col, off] | |
3532 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
3533 is the buffer number of the mark. | |
3534 "lnum" and "col" are the position in the buffer. The first | |
3535 column is 1. | |
3536 The "off" number is zero, unless 'virtualedit' is used. Then | |
3537 it is the offset in screen columns from the start of the | |
3538 character. E.g., a position within a <Tab> or after the last | |
3539 character. | |
3540 Note that for '< and '> Visual mode matters: when it is "V" | |
3541 (visual line mode) the column of '< is zero and the column of | |
3542 '> is a large number. | |
3543 This can be used to save and restore the position of a mark: > | |
3544 let save_a_mark = getpos("'a") | |
3545 ... | |
6421 | 3546 call setpos("'a", save_a_mark) |
5968 | 3547 < Also see |getcurpos()| and |setpos()|. |
3548 | |
1326 | 3549 |
230 | 3550 getqflist() *getqflist()* |
3551 Returns a list with all the current quickfix errors. Each | |
3552 list item is a dictionary with these entries: | |
3553 bufnr number of buffer that has the file name, use | |
3554 bufname() to get the name | |
3555 lnum line number in the buffer (first line is 1) | |
3556 col column number (first column is 1) | |
233 | 3557 vcol non-zero: "col" is visual column |
3558 zero: "col" is byte index | |
230 | 3559 nr error number |
1065 | 3560 pattern search pattern used to locate the error |
230 | 3561 text description of the error |
3562 type type of the error, 'E', '1', etc. | |
3563 valid non-zero: recognized error message | |
3564 | |
515 | 3565 When there is no error list or it's empty an empty list is |
1065 | 3566 returned. Quickfix list entries with non-existing buffer |
3567 number are returned with "bufnr" set to zero. | |
515 | 3568 |
230 | 3569 Useful application: Find pattern matches in multiple files and |
3570 do something with them: > | |
3571 :vimgrep /theword/jg *.c | |
3572 :for d in getqflist() | |
3573 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
3574 :endfor | |
3575 | |
3576 | |
5796 | 3577 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
7 | 3578 The result is a String, which is the contents of register |
236 | 3579 {regname}. Example: > |
7 | 3580 :let cliptext = getreg('*') |
3581 < getreg('=') returns the last evaluated value of the expression | |
236 | 3582 register. (For use in maps.) |
282 | 3583 getreg('=', 1) returns the expression itself, so that it can |
3584 be restored with |setreg()|. For other registers the extra | |
3585 argument is ignored, thus you can always give it. | |
5796 | 3586 If {list} is present and non-zero result type is changed to |
3587 |List|. Each list item is one text line. Use it if you care | |
3588 about zero bytes possibly present inside register: without | |
3589 third argument both NLs and zero bytes are represented as NLs | |
3590 (see |NL-used-for-Nul|). | |
7 | 3591 If {regname} is not specified, |v:register| is used. |
3592 | |
82 | 3593 |
7 | 3594 getregtype([{regname}]) *getregtype()* |
3595 The result is a String, which is type of register {regname}. | |
3596 The value will be one of: | |
3597 "v" for |characterwise| text | |
3598 "V" for |linewise| text | |
3599 "<CTRL-V>{width}" for |blockwise-visual| text | |
5596 | 3600 "" for an empty or unknown register |
7 | 3601 <CTRL-V> is one character with value 0x16. |
3602 If {regname} is not specified, |v:register| is used. | |
3603 | |
4157 | 3604 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3605 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
|
3606 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3607 Tabs are numbered starting with one. |
6197 | 3608 When {varname} is empty a dictionary with all tab-local |
3609 variables is returned. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3610 Note that the name without "t:" must be used. |
4157 | 3611 When the tab or variable doesn't exist {def} or an empty |
3612 string is returned, there is no error message. | |
3613 | |
3614 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
1156 | 3615 Get the value of window-local variable {varname} in window |
3616 {winnr} in tab page {tabnr}. | |
3617 When {varname} starts with "&" get the value of a window-local | |
3618 option. | |
4157 | 3619 When {varname} is empty a dictionary with all window-local |
3620 variables is returned. | |
3621 Note that {varname} must be the name without "w:". | |
831 | 3622 Tabs are numbered starting with one. For the current tabpage |
3623 use |getwinvar()|. | |
3624 When {winnr} is zero the current window is used. | |
3625 This also works for a global option, buffer-local option and | |
3626 window-local option, but it doesn't work for a global variable | |
3627 or buffer-local variable. | |
4157 | 3628 When the tab, window or variable doesn't exist {def} or an |
3629 empty string is returned, there is no error message. | |
831 | 3630 Examples: > |
3631 :let list_is_on = gettabwinvar(1, 2, '&list') | |
3632 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 3633 < |
7 | 3634 *getwinposx()* |
3635 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
3636 the left hand side of the GUI Vim window. The result will be | |
3637 -1 if the information is not available. | |
3638 | |
3639 *getwinposy()* | |
3640 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 3641 the top of the GUI Vim window. The result will be -1 if the |
7 | 3642 information is not available. |
3643 | |
4157 | 3644 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
831 | 3645 Like |gettabwinvar()| for the current tabpage. |
7 | 3646 Examples: > |
3647 :let list_is_on = getwinvar(2, '&list') | |
3648 :echo "myvar = " . getwinvar(1, 'myvar') | |
3649 < | |
6663 | 3650 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
1754 | 3651 Expand the file wildcards in {expr}. See |wildcards| for the |
1156 | 3652 use of special characters. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3653 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3654 Unless the optional {nosuf} argument is given and is non-zero, |
1754 | 3655 the 'suffixes' and 'wildignore' options apply: Names matching |
3656 one of the patterns in 'wildignore' will be skipped and | |
3657 'suffixes' affect the ordering of matches. | |
2662 | 3658 'wildignorecase' always applies. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3659 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3660 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
|
3661 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
|
3662 you also get filenames containing newlines correctly. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3663 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
|
3664 matches, they are separated by <NL> characters. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3665 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3666 If the expansion fails, the result is an empty String or List. |
6663 | 3667 |
3445 | 3668 A name for a non-existing file is not included. A symbolic |
3669 link is only included if it points to an existing file. | |
6663 | 3670 However, when the {alllinks} argument is present and it is |
3671 non-zero then all symbolic links are included. | |
7 | 3672 |
3673 For most systems backticks can be used to get files names from | |
3674 any external command. Example: > | |
3675 :let tagfiles = glob("`find . -name tags -print`") | |
3676 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
3677 < The result of the program inside the backticks should be one | |
1621 | 3678 item per line. Spaces inside an item are allowed. |
7 | 3679 |
3680 See |expand()| for expanding special Vim variables. See | |
3681 |system()| for getting the raw output of an external command. | |
3682 | |
6697 | 3683 glob2regpat({expr}) *glob2regpat()* |
3684 Convert a file pattern, as used by glob(), into a search | |
3685 pattern. The result can be used to match with a string that | |
3686 is a file name. E.g. > | |
3687 if filename =~ glob2regpat('Make*.mak') | |
3688 < This is equivalent to: > | |
3689 if filename =~ '^Make.*\.mak$' | |
3690 < | |
6663 | 3691 *globpath()* |
3692 globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) | |
7 | 3693 Perform glob() on all directories in {path} and concatenate |
3694 the results. Example: > | |
3695 :echo globpath(&rtp, "syntax/c.vim") | |
5873 | 3696 < |
3697 {path} is a comma-separated list of directory names. Each | |
7 | 3698 directory name is prepended to {expr} and expanded like with |
1754 | 3699 |glob()|. A path separator is inserted when needed. |
7 | 3700 To add a comma inside a directory name escape it with a |
3701 backslash. Note that on MS-Windows a directory may have a | |
3702 trailing backslash, remove it if you put a comma after it. | |
3703 If the expansion fails for one of the directories, there is no | |
3704 error message. | |
5873 | 3705 |
3706 Unless the optional {nosuf} argument is given and is non-zero, | |
1754 | 3707 the 'suffixes' and 'wildignore' options apply: Names matching |
3708 one of the patterns in 'wildignore' will be skipped and | |
3709 'suffixes' affect the ordering of matches. | |
7 | 3710 |
5873 | 3711 When {list} is present and it is non-zero the result is a List |
3712 with all matching files. The advantage of using a List is, you | |
3713 also get filenames containing newlines correctly. Otherwise | |
3714 the result is a String and when there are several matches, | |
3715 they are separated by <NL> characters. Example: > | |
3716 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
3717 < | |
6663 | 3718 {allinks} is used as with |glob()|. |
3719 | |
444 | 3720 The "**" item can be used to search in a directory tree. |
3721 For example, to find all "README.txt" files in the directories | |
3722 in 'runtimepath' and below: > | |
3723 :echo globpath(&rtp, "**/README.txt") | |
1668 | 3724 < Upwards search and limiting the depth of "**" is not |
3725 supported, thus using 'path' will not always work properly. | |
3726 | |
7 | 3727 *has()* |
3728 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
3729 supported, zero otherwise. The {feature} argument is a | |
3730 string. See |feature-list| below. | |
3731 Also see |exists()|. | |
3732 | |
102 | 3733 |
3734 has_key({dict}, {key}) *has_key()* | |
685 | 3735 The result is a Number, which is 1 if |Dictionary| {dict} has |
3736 an entry with key {key}. Zero otherwise. | |
102 | 3737 |
1104 | 3738 haslocaldir() *haslocaldir()* |
3739 The result is a Number, which is 1 when the current | |
1621 | 3740 window has set a local path via |:lcd|, and 0 otherwise. |
102 | 3741 |
782 | 3742 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 3743 The result is a Number, which is 1 if there is a mapping that |
3744 contains {what} in somewhere in the rhs (what it is mapped to) | |
3745 and this mapping exists in one of the modes indicated by | |
3746 {mode}. | |
782 | 3747 When {abbr} is there and it is non-zero use abbreviations |
786 | 3748 instead of mappings. Don't forget to specify Insert and/or |
3749 Command-line mode. | |
7 | 3750 Both the global mappings and the mappings local to the current |
3751 buffer are checked for a match. | |
3752 If no matching mapping is found 0 is returned. | |
3753 The following characters are recognized in {mode}: | |
3754 n Normal mode | |
3755 v Visual mode | |
3756 o Operator-pending mode | |
3757 i Insert mode | |
3758 l Language-Argument ("r", "f", "t", etc.) | |
3759 c Command-line mode | |
3760 When {mode} is omitted, "nvo" is used. | |
3761 | |
3762 This function is useful to check if a mapping already exists | |
1621 | 3763 to a function in a Vim script. Example: > |
7 | 3764 :if !hasmapto('\ABCdoit') |
3765 : map <Leader>d \ABCdoit | |
3766 :endif | |
3767 < This installs the mapping to "\ABCdoit" only if there isn't | |
3768 already a mapping to "\ABCdoit". | |
3769 | |
3770 histadd({history}, {item}) *histadd()* | |
3771 Add the String {item} to the history {history} which can be | |
3772 one of: *hist-names* | |
3773 "cmd" or ":" command line history | |
3774 "search" or "/" search pattern history | |
1621 | 3775 "expr" or "=" typed expression history |
7 | 3776 "input" or "@" input line history |
3682 | 3777 "debug" or ">" debug command history |
3778 The {history} string does not need to be the whole name, one | |
3779 character is sufficient. | |
7 | 3780 If {item} does already exist in the history, it will be |
3781 shifted to become the newest entry. | |
3782 The result is a Number: 1 if the operation was successful, | |
3783 otherwise 0 is returned. | |
3784 | |
3785 Example: > | |
3786 :call histadd("input", strftime("%Y %b %d")) | |
3787 :let date=input("Enter date: ") | |
3788 < This function is not available in the |sandbox|. | |
3789 | |
3790 histdel({history} [, {item}]) *histdel()* | |
236 | 3791 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 3792 for the possible values of {history}. |
3793 | |
1668 | 3794 If the parameter {item} evaluates to a String, it is used as a |
3795 regular expression. All entries matching that expression will | |
3796 be removed from the history (if there are any). | |
7 | 3797 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 3798 If {item} evaluates to a Number, it will be interpreted as |
3799 an index, see |:history-indexing|. The respective entry will | |
3800 be removed if it exists. | |
7 | 3801 |
3802 The result is a Number: 1 for a successful operation, | |
3803 otherwise 0 is returned. | |
3804 | |
3805 Examples: | |
3806 Clear expression register history: > | |
3807 :call histdel("expr") | |
3808 < | |
3809 Remove all entries starting with "*" from the search history: > | |
3810 :call histdel("/", '^\*') | |
3811 < | |
3812 The following three are equivalent: > | |
3813 :call histdel("search", histnr("search")) | |
3814 :call histdel("search", -1) | |
3815 :call histdel("search", '^'.histget("search", -1).'$') | |
3816 < | |
3817 To delete the last search pattern and use the last-but-one for | |
3818 the "n" command and 'hlsearch': > | |
3819 :call histdel("search", -1) | |
3820 :let @/ = histget("search", -1) | |
3821 | |
3822 histget({history} [, {index}]) *histget()* | |
3823 The result is a String, the entry with Number {index} from | |
3824 {history}. See |hist-names| for the possible values of | |
3825 {history}, and |:history-indexing| for {index}. If there is | |
3826 no such entry, an empty String is returned. When {index} is | |
3827 omitted, the most recent item from the history is used. | |
3828 | |
3829 Examples: | |
3830 Redo the second last search from history. > | |
3831 :execute '/' . histget("search", -2) | |
3832 | |
3833 < Define an Ex command ":H {num}" that supports re-execution of | |
3834 the {num}th entry from the output of |:history|. > | |
3835 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
3836 < | |
3837 histnr({history}) *histnr()* | |
3838 The result is the Number of the current entry in {history}. | |
3839 See |hist-names| for the possible values of {history}. | |
3840 If an error occurred, -1 is returned. | |
3841 | |
3842 Example: > | |
3843 :let inp_index = histnr("expr") | |
3844 < | |
3845 hlexists({name}) *hlexists()* | |
3846 The result is a Number, which is non-zero if a highlight group | |
3847 called {name} exists. This is when the group has been | |
3848 defined in some way. Not necessarily when highlighting has | |
3849 been defined for it, it may also have been used for a syntax | |
3850 item. | |
3851 *highlight_exists()* | |
3852 Obsolete name: highlight_exists(). | |
3853 | |
3854 *hlID()* | |
3855 hlID({name}) The result is a Number, which is the ID of the highlight group | |
3856 with name {name}. When the highlight group doesn't exist, | |
3857 zero is returned. | |
3858 This can be used to retrieve information about the highlight | |
1621 | 3859 group. For example, to get the background color of the |
7 | 3860 "Comment" group: > |
3861 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
3862 < *highlightID()* | |
3863 Obsolete name: highlightID(). | |
3864 | |
3865 hostname() *hostname()* | |
3866 The result is a String, which is the name of the machine on | |
236 | 3867 which Vim is currently running. Machine names greater than |
7 | 3868 256 characters long are truncated. |
3869 | |
3870 iconv({expr}, {from}, {to}) *iconv()* | |
3871 The result is a String, which is the text {expr} converted | |
3872 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3873 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3874 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3875 are replaced with "?". |
7 | 3876 The encoding names are whatever the iconv() library function |
3877 can accept, see ":!man 3 iconv". | |
3878 Most conversions require Vim to be compiled with the |+iconv| | |
3879 feature. Otherwise only UTF-8 to latin1 conversion and back | |
3880 can be done. | |
3881 This can be used to display messages with special characters, | |
3882 no matter what 'encoding' is set to. Write the message in | |
3883 UTF-8 and use: > | |
3884 echo iconv(utf8_str, "utf-8", &enc) | |
3885 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
3886 from/to UCS-2 is automatically changed to use UTF-8. You | |
3887 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
|
3888 {only available when compiled with the |+multi_byte| feature} |
7 | 3889 |
3890 *indent()* | |
3891 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
3892 current buffer. The indent is counted in spaces, the value | |
3893 of 'tabstop' is relevant. {lnum} is used just like in | |
3894 |getline()|. | |
3895 When {lnum} is invalid -1 is returned. | |
3896 | |
79 | 3897 |
95 | 3898 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 3899 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
|
3900 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3901 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
|
3902 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
|
3903 is not used here, case always matters. |
153 | 3904 If {start} is given then start looking at the item with index |
3905 {start} (may be negative for an item relative to the end). | |
79 | 3906 When {ic} is given and it is non-zero, ignore case. Otherwise |
3907 case must match. | |
3908 -1 is returned when {expr} is not found in {list}. | |
3909 Example: > | |
3910 :let idx = index(words, "the") | |
87 | 3911 :if index(numbers, 123) >= 0 |
79 | 3912 |
3913 | |
531 | 3914 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 3915 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
|
3916 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3917 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
|
3918 in the prompt to start a new line. |
531 | 3919 The highlighting set with |:echohl| is used for the prompt. |
3920 The input is entered just like a command-line, with the same | |
1621 | 3921 editing commands and mappings. There is a separate history |
531 | 3922 for lines typed for input(). |
3923 Example: > | |
3924 :if input("Coffee or beer? ") == "beer" | |
3925 : echo "Cheers!" | |
3926 :endif | |
3927 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3928 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3929 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
|
3930 Example: > |
531 | 3931 :let color = input("Color? ", "white") |
3932 | |
3933 < The optional {completion} argument specifies the type of | |
3934 completion supported for the input. Without it completion is | |
1621 | 3935 not performed. The supported completion types are the same as |
531 | 3936 that can be supplied to a user-defined command using the |
1621 | 3937 "-complete=" argument. Refer to |:command-completion| for |
531 | 3938 more information. Example: > |
3939 let fname = input("File: ", "", "file") | |
3940 < | |
3941 NOTE: This function must not be used in a startup file, for | |
3942 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 3943 Note: When input() is called from within a mapping it will |
3944 consume remaining characters from that mapping, because a | |
3945 mapping is handled like the characters were typed. | |
3946 Use |inputsave()| before input() and |inputrestore()| | |
3947 after input() to avoid that. Another solution is to avoid | |
3948 that further characters follow in the mapping, e.g., by using | |
3949 |:execute| or |:normal|. | |
3950 | |
531 | 3951 Example with a mapping: > |
7 | 3952 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
3953 :function GetFoo() | |
3954 : call inputsave() | |
3955 : let g:Foo = input("enter search pattern: ") | |
3956 : call inputrestore() | |
3957 :endfunction | |
3958 | |
3959 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3960 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3961 are supported, a dialog window pops up to input the text. |
7 | 3962 Example: > |
3875 | 3963 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
3964 :if n != "" | |
3965 : let &sw = n | |
3966 :endif | |
7 | 3967 < When the dialog is cancelled {cancelreturn} is returned. When |
3968 omitted an empty string is returned. | |
3969 Hitting <Enter> works like pressing the OK button. Hitting | |
3970 <Esc> works like pressing the Cancel button. | |
531 | 3971 NOTE: Command-line completion is not supported. |
7 | 3972 |
519 | 3973 inputlist({textlist}) *inputlist()* |
819 | 3974 {textlist} must be a |List| of strings. This |List| is |
3975 displayed, one string per line. The user will be prompted to | |
3976 enter a number, which is returned. | |
519 | 3977 The user can also select an item by clicking on it with the |
1621 | 3978 mouse. For the first string 0 is returned. When clicking |
519 | 3979 above the first item a negative number is returned. When |
3980 clicking on the prompt one more than the length of {textlist} | |
3981 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3982 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 3983 it won't work. It's a good idea to put the entry number at |
1156 | 3984 the start of the string. And put a prompt in the first item. |
3985 Example: > | |
519 | 3986 let color = inputlist(['Select color:', '1. red', |
3987 \ '2. green', '3. blue']) | |
3988 | |
7 | 3989 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3990 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 3991 Should be called the same number of times inputsave() is |
3992 called. Calling it more often is harmless though. | |
3993 Returns 1 when there is nothing to restore, 0 otherwise. | |
3994 | |
3995 inputsave() *inputsave()* | |
3996 Preserve typeahead (also from mappings) and clear it, so that | |
3997 a following prompt gets input from the user. Should be | |
3998 followed by a matching inputrestore() after the prompt. Can | |
3999 be used several times, in which case there must be just as | |
4000 many inputrestore() calls. | |
4001 Returns 1 when out of memory, 0 otherwise. | |
4002 | |
4003 inputsecret({prompt} [, {text}]) *inputsecret()* | |
4004 This function acts much like the |input()| function with but | |
4005 two exceptions: | |
4006 a) the user's response will be displayed as a sequence of | |
4007 asterisks ("*") thereby keeping the entry secret, and | |
4008 b) the user's response will not be recorded on the input | |
4009 |history| stack. | |
4010 The result is a String, which is whatever the user actually | |
4011 typed on the command-line in response to the issued prompt. | |
531 | 4012 NOTE: Command-line completion is not supported. |
7 | 4013 |
55 | 4014 insert({list}, {item} [, {idx}]) *insert()* |
685 | 4015 Insert {item} at the start of |List| {list}. |
55 | 4016 If {idx} is specified insert {item} before the item with index |
1621 | 4017 {idx}. If {idx} is zero it goes before the first item, just |
55 | 4018 like omitting {idx}. A negative {idx} is also possible, see |
4019 |list-index|. -1 inserts just before the last item. | |
685 | 4020 Returns the resulting |List|. Examples: > |
55 | 4021 :let mylist = insert([2, 3, 5], 1) |
4022 :call insert(mylist, 4, -1) | |
4023 :call insert(mylist, 6, len(mylist)) | |
82 | 4024 < The last example can be done simpler with |add()|. |
685 | 4025 Note that when {item} is a |List| it is inserted as a single |
692 | 4026 item. Use |extend()| to concatenate |Lists|. |
55 | 4027 |
3214 | 4028 invert({expr}) *invert()* |
4029 Bitwise invert. The argument is converted to a number. A | |
4030 List, Dict or Float argument causes an error. Example: > | |
4031 :let bits = invert(bits) | |
4032 | |
7 | 4033 isdirectory({directory}) *isdirectory()* |
4034 The result is a Number, which is non-zero when a directory | |
4035 with the name {directory} exists. If {directory} doesn't | |
4036 exist, or isn't a directory, the result is FALSE. {directory} | |
4037 is any expression, which is used as a String. | |
4038 | |
819 | 4039 islocked({expr}) *islocked()* *E786* |
148 | 4040 The result is a Number, which is non-zero when {expr} is the |
4041 name of a locked variable. | |
685 | 4042 {expr} must be the name of a variable, |List| item or |
4043 |Dictionary| entry, not the variable itself! Example: > | |
148 | 4044 :let alist = [0, ['a', 'b'], 2, 3] |
4045 :lockvar 1 alist | |
4046 :echo islocked('alist') " 1 | |
4047 :echo islocked('alist[1]') " 0 | |
4048 | |
4049 < When {expr} is a variable that does not exist you get an error | |
843 | 4050 message. Use |exists()| to check for existence. |
148 | 4051 |
140 | 4052 items({dict}) *items()* |
685 | 4053 Return a |List| with all the key-value pairs of {dict}. Each |
4054 |List| item is a list with two items: the key of a {dict} | |
4055 entry and the value of this entry. The |List| is in arbitrary | |
4056 order. | |
140 | 4057 |
95 | 4058 |
4059 join({list} [, {sep}]) *join()* | |
4060 Join the items in {list} together into one String. | |
4061 When {sep} is specified it is put in between the items. If | |
4062 {sep} is omitted a single space is used. | |
4063 Note that {sep} is not added at the end. You might want to | |
4064 add it there too: > | |
4065 let lines = join(mylist, "\n") . "\n" | |
692 | 4066 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 4067 converted into a string like with |string()|. |
4068 The opposite function is |split()|. | |
4069 | |
99 | 4070 keys({dict}) *keys()* |
685 | 4071 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 4072 arbitrary order. |
4073 | |
85 | 4074 *len()* *E701* |
55 | 4075 len({expr}) The result is a Number, which is the length of the argument. |
4076 When {expr} is a String or a Number the length in bytes is | |
4077 used, as with |strlen()|. | |
685 | 4078 When {expr} is a |List| the number of items in the |List| is |
55 | 4079 returned. |
685 | 4080 When {expr} is a |Dictionary| the number of entries in the |
4081 |Dictionary| is returned. | |
55 | 4082 Otherwise an error is given. |
4083 | |
7 | 4084 *libcall()* *E364* *E368* |
4085 libcall({libname}, {funcname}, {argument}) | |
4086 Call function {funcname} in the run-time library {libname} | |
4087 with single argument {argument}. | |
4088 This is useful to call functions in a library that you | |
4089 especially made to be used with Vim. Since only one argument | |
4090 is possible, calling standard library functions is rather | |
4091 limited. | |
4092 The result is the String returned by the function. If the | |
4093 function returns NULL, this will appear as an empty string "" | |
4094 to Vim. | |
4095 If the function returns a number, use libcallnr()! | |
4096 If {argument} is a number, it is passed to the function as an | |
4097 int; if {argument} is a string, it is passed as a | |
4098 null-terminated string. | |
4099 This function will fail in |restricted-mode|. | |
4100 | |
4101 libcall() allows you to write your own 'plug-in' extensions to | |
4102 Vim without having to recompile the program. It is NOT a | |
4103 means to call system functions! If you try to do so Vim will | |
4104 very probably crash. | |
4105 | |
4106 For Win32, the functions you write must be placed in a DLL | |
4107 and use the normal C calling convention (NOT Pascal which is | |
4108 used in Windows System DLLs). The function must take exactly | |
4109 one parameter, either a character pointer or a long integer, | |
4110 and must return a character pointer or NULL. The character | |
4111 pointer returned must point to memory that will remain valid | |
4112 after the function has returned (e.g. in static data in the | |
4113 DLL). If it points to allocated memory, that memory will | |
4114 leak away. Using a static buffer in the function should work, | |
4115 it's then freed when the DLL is unloaded. | |
4116 | |
4117 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 4118 crash! This also happens if the function returns a number, |
7 | 4119 because Vim thinks it's a pointer. |
4120 For Win32 systems, {libname} should be the filename of the DLL | |
4121 without the ".DLL" suffix. A full path is only required if | |
4122 the DLL is not in the usual places. | |
4123 For Unix: When compiling your own plugins, remember that the | |
4124 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4125 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 4126 feature is present} |
4127 Examples: > | |
4128 :echo libcall("libc.so", "getenv", "HOME") | |
4129 < | |
4130 *libcallnr()* | |
4131 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4132 Just like |libcall()|, but used for a function that returns an |
7 | 4133 int instead of a string. |
4134 {only in Win32 on some Unix versions, when the |+libcall| | |
4135 feature is present} | |
1621 | 4136 Examples: > |
4137 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 4138 :call libcallnr("libc.so", "printf", "Hello World!\n") |
4139 :call libcallnr("libc.so", "sleep", 10) | |
4140 < | |
4141 *line()* | |
4142 line({expr}) The result is a Number, which is the line number of the file | |
4143 position given with {expr}. The accepted positions are: | |
4144 . the cursor position | |
4145 $ the last line in the current buffer | |
4146 'x position of mark x (if the mark is not set, 0 is | |
4147 returned) | |
665 | 4148 w0 first line visible in current window |
4149 w$ last line visible in current window | |
1609 | 4150 v In Visual mode: the start of the Visual area (the |
4151 cursor is the end). When not in Visual mode | |
4152 returns the cursor position. Differs from |'<| in | |
4153 that it's updated right away. | |
1156 | 4154 Note that a mark in another file can be used. The line number |
4155 then applies to another buffer. | |
703 | 4156 To get the column number use |col()|. To get both use |
4157 |getpos()|. | |
7 | 4158 Examples: > |
4159 line(".") line number of the cursor | |
4160 line("'t") line number of mark t | |
4161 line("'" . marker) line number of mark marker | |
4162 < *last-position-jump* | |
4163 This autocommand jumps to the last known position in a file | |
4164 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4165 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 4166 |
7 | 4167 line2byte({lnum}) *line2byte()* |
4168 Return the byte count from the start of the buffer for line | |
4169 {lnum}. This includes the end-of-line character, depending on | |
4170 the 'fileformat' option for the current buffer. The first | |
3237 | 4171 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 4172 This can also be used to get the byte count for the line just |
4173 below the last line: > | |
4174 line2byte(line("$") + 1) | |
3237 | 4175 < This is the buffer size plus one. If 'fileencoding' is empty |
4176 it is the file size plus one. | |
7 | 4177 When {lnum} is invalid, or the |+byte_offset| feature has been |
4178 disabled at compile time, -1 is returned. | |
4179 Also see |byte2line()|, |go| and |:goto|. | |
4180 | |
4181 lispindent({lnum}) *lispindent()* | |
4182 Get the amount of indent for line {lnum} according the lisp | |
4183 indenting rules, as with 'lisp'. | |
4184 The indent is counted in spaces, the value of 'tabstop' is | |
4185 relevant. {lnum} is used just like in |getline()|. | |
4186 When {lnum} is invalid or Vim was not compiled the | |
4187 |+lispindent| feature, -1 is returned. | |
4188 | |
4189 localtime() *localtime()* | |
4190 Return the current time, measured as seconds since 1st Jan | |
4191 1970. See also |strftime()| and |getftime()|. | |
4192 | |
95 | 4193 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4194 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4195 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
|
4196 {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
|
4197 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4198 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4199 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4200 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4201 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4202 < 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
|
4203 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4204 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4205 |
1621 | 4206 log10({expr}) *log10()* |
4207 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
4208 {expr} must evaluate to a |Float| or a |Number|. | |
4209 Examples: > | |
4210 :echo log10(1000) | |
4211 < 3.0 > | |
4212 :echo log10(0.01) | |
4213 < -2.0 | |
4214 {only available when compiled with the |+float| feature} | |
4215 | |
3492 | 4216 luaeval({expr}[, {expr}]) *luaeval()* |
4217 Evaluate Lua expression {expr} and return its result converted | |
4218 to Vim data structures. Second {expr} may hold additional | |
4219 argument accessible as _A inside first {expr}. | |
4220 Strings are returned as they are. | |
4221 Boolean objects are converted to numbers. | |
4222 Numbers are converted to |Float| values if vim was compiled | |
4223 with |+float| and to numbers otherwise. | |
4224 Dictionaries and lists obtained by vim.eval() are returned | |
4225 as-is. | |
4226 Other objects are returned as zero without any errors. | |
4227 See |lua-luaeval| for more details. | |
4228 {only available when compiled with the |+lua| feature} | |
4229 | |
102 | 4230 map({expr}, {string}) *map()* |
685 | 4231 {expr} must be a |List| or a |Dictionary|. |
102 | 4232 Replace each item in {expr} with the result of evaluating |
4233 {string}. | |
4234 Inside {string} |v:val| has the value of the current item. | |
1998 | 4235 For a |Dictionary| |v:key| has the key of the current item |
4236 and for a |List| |v:key| has the index of the current item. | |
102 | 4237 Example: > |
4238 :call map(mylist, '"> " . v:val . " <"') | |
95 | 4239 < This puts "> " before and " <" after each item in "mylist". |
102 | 4240 |
158 | 4241 Note that {string} is the result of an expression and is then |
102 | 4242 used as an expression again. Often it is good to use a |
158 | 4243 |literal-string| to avoid having to double backslashes. You |
4244 still have to double ' quotes | |
102 | 4245 |
685 | 4246 The operation is done in-place. If you want a |List| or |
4247 |Dictionary| to remain unmodified make a copy first: > | |
3682 | 4248 :let tlist = map(copy(mylist), ' v:val . "\t"') |
102 | 4249 |
685 | 4250 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4251 When an error is encountered while evaluating {string} no |
4252 further items in {expr} are processed. | |
95 | 4253 |
4254 | |
2610 | 4255 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4256 When {dict} is omitted or zero: Return the rhs of mapping | |
4257 {name} in mode {mode}. The returned String has special | |
4258 characters translated like in the output of the ":map" command | |
4259 listing. | |
4260 | |
4261 When there is no mapping for {name}, an empty String is | |
4262 returned. | |
4263 | |
4264 The {name} can have special key names, like in the ":map" | |
4265 command. | |
4266 | |
644 | 4267 {mode} can be one of these strings: |
7 | 4268 "n" Normal |
2610 | 4269 "v" Visual (including Select) |
7 | 4270 "o" Operator-pending |
4271 "i" Insert | |
4272 "c" Cmd-line | |
2610 | 4273 "s" Select |
4274 "x" Visual | |
7 | 4275 "l" langmap |language-mapping| |
4276 "" Normal, Visual and Operator-pending | |
644 | 4277 When {mode} is omitted, the modes for "" are used. |
2610 | 4278 |
782 | 4279 When {abbr} is there and it is non-zero use abbreviations |
4280 instead of mappings. | |
2610 | 4281 |
4282 When {dict} is there and it is non-zero return a dictionary | |
4283 containing all the information of the mapping with the | |
4284 following items: | |
4285 "lhs" The {lhs} of the mapping. | |
4286 "rhs" The {rhs} of the mapping as typed. | |
4287 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 4288 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 4289 "expr" 1 for an expression mapping (|:map-<expr>|). |
4290 "buffer" 1 for a buffer local mapping (|:map-local|). | |
4291 "mode" Modes for which the mapping is defined. In | |
4292 addition to the modes mentioned above, these | |
4293 characters will be used: | |
4294 " " Normal, Visual and Operator-pending | |
4295 "!" Insert and Commandline mode | |
2642 | 4296 (|mapmode-ic|) |
2625 | 4297 "sid" The script local ID, used for <sid> mappings |
4298 (|<SID>|). | |
5555 | 4299 "nowait" Do not wait for other, longer mappings. |
4300 (|:map-<nowait>|). | |
2610 | 4301 |
7 | 4302 The mappings local to the current buffer are checked first, |
4303 then the global mappings. | |
626 | 4304 This function can be used to map a key even when it's already |
4305 mapped, and have it do the original mapping too. Sketch: > | |
4306 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
4307 | |
7 | 4308 |
782 | 4309 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 4310 Check if there is a mapping that matches with {name} in mode |
4311 {mode}. See |maparg()| for {mode} and special names in | |
4312 {name}. | |
782 | 4313 When {abbr} is there and it is non-zero use abbreviations |
4314 instead of mappings. | |
7 | 4315 A match happens with a mapping that starts with {name} and |
4316 with a mapping which is equal to the start of {name}. | |
4317 | |
1621 | 4318 matches mapping "a" "ab" "abc" ~ |
7 | 4319 mapcheck("a") yes yes yes |
4320 mapcheck("abc") yes yes yes | |
4321 mapcheck("ax") yes no no | |
4322 mapcheck("b") no no no | |
4323 | |
4324 The difference with maparg() is that mapcheck() finds a | |
4325 mapping that matches with {name}, while maparg() only finds a | |
4326 mapping for {name} exactly. | |
4327 When there is no mapping that starts with {name}, an empty | |
4328 String is returned. If there is one, the rhs of that mapping | |
4329 is returned. If there are several mappings that start with | |
4330 {name}, the rhs of one of them is returned. | |
4331 The mappings local to the current buffer are checked first, | |
4332 then the global mappings. | |
4333 This function can be used to check if a mapping can be added | |
4334 without being ambiguous. Example: > | |
4335 :if mapcheck("_vv") == "" | |
4336 : map _vv :set guifont=7x13<CR> | |
4337 :endif | |
4338 < This avoids adding the "_vv" mapping when there already is a | |
4339 mapping for "_v" or for "_vvv". | |
4340 | |
19 | 4341 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 4342 When {expr} is a |List| then this returns the index of the |
4343 first item where {pat} matches. Each item is used as a | |
692 | 4344 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 4345 Otherwise, {expr} is used as a String. The result is a |
95 | 4346 Number, which gives the index (byte offset) in {expr} where |
4347 {pat} matches. | |
685 | 4348 A match at the first character or |List| item returns zero. |
19 | 4349 If there is no match -1 is returned. |
2833 | 4350 For getting submatches see |matchlist()|. |
19 | 4351 Example: > |
95 | 4352 :echo match("testing", "ing") " results in 4 |
714 | 4353 :echo match([1, 'x'], '\a') " results in 1 |
95 | 4354 < See |string-match| for how {pat} is used. |
170 | 4355 *strpbrk()* |
1621 | 4356 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 4357 :let sepidx = match(line, '[.,;: \t]') |
4358 < *strcasestr()* | |
4359 Vim doesn't have a strcasestr() function. But you can add | |
4360 "\c" to the pattern to ignore case: > | |
4361 :let idx = match(haystack, '\cneedle') | |
4362 < | |
95 | 4363 If {start} is given, the search starts from byte index |
685 | 4364 {start} in a String or item {start} in a |List|. |
7 | 4365 The result, however, is still the index counted from the |
236 | 4366 first character/item. Example: > |
7 | 4367 :echo match("testing", "ing", 2) |
4368 < result is again "4". > | |
4369 :echo match("testing", "ing", 4) | |
4370 < result is again "4". > | |
4371 :echo match("testing", "t", 2) | |
4372 < result is "3". | |
694 | 4373 For a String, if {start} > 0 then it is like the string starts |
703 | 4374 {start} bytes later, thus "^" will match at {start}. Except |
4375 when {count} is given, then it's like matches before the | |
4376 {start} byte are ignored (this is a bit complicated to keep it | |
4377 backwards compatible). | |
95 | 4378 For a String, if {start} < 0, it will be set to 0. For a list |
4379 the index is counted from the end. | |
697 | 4380 If {start} is out of range ({start} > strlen({expr}) for a |
4381 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 4382 |
694 | 4383 When {count} is given use the {count}'th match. When a match |
697 | 4384 is found in a String the search for the next one starts one |
694 | 4385 character further. Thus this example results in 1: > |
4386 echo match("testing", "..", 0, 2) | |
4387 < In a |List| the search continues in the next item. | |
703 | 4388 Note that when {count} is added the way {start} works changes, |
4389 see above. | |
694 | 4390 |
7 | 4391 See |pattern| for the patterns that are accepted. |
4392 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 4393 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 4394 done like 'magic' is set and 'cpoptions' is empty. |
4395 | |
1326 | 4396 *matchadd()* *E798* *E799* *E801* |
4397 matchadd({group}, {pattern}[, {priority}[, {id}]]) | |
4398 Defines a pattern to be highlighted in the current window (a | |
4399 "match"). It will be highlighted with {group}. Returns an | |
4400 identification number (ID), which can be used to delete the | |
4401 match using |matchdelete()|. | |
5466 | 4402 Matching is case sensitive and magic, unless case sensitivity |
4403 or magicness are explicitly overridden in {pattern}. The | |
4404 'magic', 'smartcase' and 'ignorecase' options are not used. | |
1326 | 4405 |
4406 The optional {priority} argument assigns a priority to the | |
1621 | 4407 match. A match with a high priority will have its |
1326 | 4408 highlighting overrule that of a match with a lower priority. |
4409 A priority is specified as an integer (negative numbers are no | |
4410 exception). If the {priority} argument is not specified, the | |
4411 default priority is 10. The priority of 'hlsearch' is zero, | |
4412 hence all matches with a priority greater than zero will | |
4413 overrule it. Syntax highlighting (see 'syntax') is a separate | |
4414 mechanism, and regardless of the chosen priority a match will | |
4415 always overrule syntax highlighting. | |
4416 | |
4417 The optional {id} argument allows the request for a specific | |
4418 match ID. If a specified ID is already taken, an error | |
4419 message will appear and the match will not be added. An ID | |
4420 is specified as a positive integer (zero excluded). IDs 1, 2 | |
4421 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
4422 respectively. If the {id} argument is not specified, | |
4423 |matchadd()| automatically chooses a free ID. | |
4424 | |
4425 The number of matches is not limited, as it is the case with | |
4426 the |:match| commands. | |
4427 | |
4428 Example: > | |
4429 :highlight MyGroup ctermbg=green guibg=green | |
4430 :let m = matchadd("MyGroup", "TODO") | |
4431 < Deletion of the pattern: > | |
4432 :call matchdelete(m) | |
4433 | |
4434 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 4435 available from |getmatches()|. All matches can be deleted in |
1326 | 4436 one operation by |clearmatches()|. |
819 | 4437 |
5979 | 4438 matchaddpos({group}, {pos}[, {priority}[, {id}]]) *matchaddpos()* |
4439 Same as |matchadd()|, but requires a list of positions {pos} | |
4440 instead of a pattern. This command is faster than |matchadd()| | |
4441 because it does not require to handle regular expressions and | |
4442 sets buffer line boundaries to redraw screen. It is supposed | |
4443 to be used when fast match additions and deletions are | |
4444 required, for example to highlight matching parentheses. | |
4445 | |
4446 The list {pos} can contain one of these items: | |
6007 | 4447 - A number. This whole line will be highlighted. The first |
5979 | 4448 line has number 1. |
4449 - A list with one number, e.g., [23]. The whole line with this | |
4450 number will be highlighted. | |
4451 - A list with two numbers, e.g., [23, 11]. The first number is | |
6007 | 4452 the line number, the second one is the column number (first |
4453 column is 1, the value must correspond to the byte index as | |
4454 |col()| would return). The character at this position will | |
4455 be highlighted. | |
5979 | 4456 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
6007 | 4457 the third number gives the length of the highlight in bytes. |
5979 | 4458 |
4459 The maximum number of positions is 8. | |
4460 | |
4461 Example: > | |
4462 :highlight MyGroup ctermbg=green guibg=green | |
4463 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
4464 < Deletion of the pattern: > | |
4465 :call matchdelete(m) | |
4466 | |
4467 < Matches added by |matchaddpos()| are returned by | |
4468 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
4469 value a list like the {pos} item. | |
4470 These matches cannot be set via |setmatches()|, however they | |
4471 can still be deleted by |clearmatches()|. | |
4472 | |
819 | 4473 matcharg({nr}) *matcharg()* |
856 | 4474 Selects the {nr} match item, as set with a |:match|, |
819 | 4475 |:2match| or |:3match| command. |
4476 Return a |List| with two elements: | |
4477 The name of the highlight group used | |
4478 The pattern used. | |
4479 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
4480 When there is no match item set returns ['', '']. | |
1326 | 4481 This is useful to save and restore a |:match|. |
4482 Highlighting matches using the |:match| commands are limited | |
4483 to three matches. |matchadd()| does not have this limitation. | |
4484 | |
4485 matchdelete({id}) *matchdelete()* *E802* *E803* | |
4486 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 4487 or one of the |:match| commands. Returns 0 if successful, |
1326 | 4488 otherwise -1. See example for |matchadd()|. All matches can |
4489 be deleted in one operation by |clearmatches()|. | |
819 | 4490 |
19 | 4491 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4492 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4493 after the match. Example: > |
7 | 4494 :echo matchend("testing", "ing") |
4495 < results in "7". | |
170 | 4496 *strspn()* *strcspn()* |
4497 Vim doesn't have a strspn() or strcspn() function, but you can | |
4498 do it with matchend(): > | |
4499 :let span = matchend(line, '[a-zA-Z]') | |
4500 :let span = matchend(line, '[^a-zA-Z]') | |
4501 < Except that -1 is returned when there are no matches. | |
4502 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4503 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4504 :echo matchend("testing", "ing", 2) |
4505 < results in "7". > | |
4506 :echo matchend("testing", "ing", 5) | |
4507 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4508 When {expr} is a |List| the result is equal to |match()|. |
7 | 4509 |
158 | 4510 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4511 Same as |match()|, but return a |List|. The first item in the |
158 | 4512 list is the matched string, same as what matchstr() would |
4513 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 4514 in |:substitute|. When an optional submatch didn't match an |
4515 empty string is used. Example: > | |
4516 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
4517 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 4518 When there is no match an empty list is returned. |
4519 | |
19 | 4520 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 4521 Same as |match()|, but return the matched string. Example: > |
7 | 4522 :echo matchstr("testing", "ing") |
4523 < results in "ing". | |
4524 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4525 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4526 :echo matchstr("testing", "ing", 2) |
4527 < results in "ing". > | |
4528 :echo matchstr("testing", "ing", 5) | |
4529 < result is "". | |
685 | 4530 When {expr} is a |List| then the matching item is returned. |
95 | 4531 The type isn't changed, it's not necessarily a String. |
7 | 4532 |
87 | 4533 *max()* |
4534 max({list}) Return the maximum value of all items in {list}. | |
4535 If {list} is not a list or one of the items in {list} cannot | |
4536 be used as a Number this results in an error. | |
685 | 4537 An empty |List| results in zero. |
87 | 4538 |
4539 *min()* | |
1215 | 4540 min({list}) Return the minimum value of all items in {list}. |
87 | 4541 If {list} is not a list or one of the items in {list} cannot |
4542 be used as a Number this results in an error. | |
685 | 4543 An empty |List| results in zero. |
87 | 4544 |
843 | 4545 *mkdir()* *E739* |
168 | 4546 mkdir({name} [, {path} [, {prot}]]) |
4547 Create directory {name}. | |
4548 If {path} is "p" then intermediate directories are created as | |
4549 necessary. Otherwise it must be "". | |
4550 If {prot} is given it is used to set the protection bits of | |
4551 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 4552 the user readable for others). Use 0700 to make it unreadable |
1702 | 4553 for others. This is only used for the last part of {name}. |
4554 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
4555 with 0755. | |
4556 Example: > | |
4557 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
4558 < This function is not available in the |sandbox|. | |
168 | 4559 Not available on all systems. To check use: > |
4560 :if exists("*mkdir") | |
4561 < | |
7 | 4562 *mode()* |
1621 | 4563 mode([expr]) Return a string that indicates the current mode. |
1661 | 4564 If [expr] is supplied and it evaluates to a non-zero Number or |
4565 a non-empty String (|non-zero-arg|), then the full mode is | |
4566 returned, otherwise only the first letter is returned. Note | |
4567 that " " and "0" are also non-empty strings. | |
1621 | 4568 |
7 | 4569 n Normal |
1621 | 4570 no Operator-pending |
7 | 4571 v Visual by character |
4572 V Visual by line | |
4573 CTRL-V Visual blockwise | |
4574 s Select by character | |
4575 S Select by line | |
4576 CTRL-S Select blockwise | |
4577 i Insert | |
1621 | 4578 R Replace |R| |
4579 Rv Virtual Replace |gR| | |
7 | 4580 c Command-line |
1621 | 4581 cv Vim Ex mode |gQ| |
4582 ce Normal Ex mode |Q| | |
7 | 4583 r Hit-enter prompt |
1621 | 4584 rm The -- more -- prompt |
4585 r? A |:confirm| query of some sort | |
4586 ! Shell or external command is executing | |
4587 This is useful in the 'statusline' option or when used | |
4588 with |remote_expr()| In most other places it always returns | |
4589 "c" or "n". | |
4590 Also see |visualmode()|. | |
7 | 4591 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4592 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4593 Evaluate MzScheme expression {expr} and return its result |
3492 | 4594 converted to Vim data structures. |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4595 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4596 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
|
4597 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4598 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
|
4599 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4600 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
|
4601 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4602 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4603 :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
|
4604 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4605 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4606 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4607 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4608 |
7 | 4609 nextnonblank({lnum}) *nextnonblank()* |
4610 Return the line number of the first line at or below {lnum} | |
4611 that is not blank. Example: > | |
4612 if getline(nextnonblank(1)) =~ "Java" | |
4613 < When {lnum} is invalid or there is no non-blank line at or | |
4614 below it, zero is returned. | |
4615 See also |prevnonblank()|. | |
4616 | |
4051 | 4617 nr2char({expr}[, {utf8}]) *nr2char()* |
7 | 4618 Return a string with a single character, which has the number |
4619 value {expr}. Examples: > | |
4620 nr2char(64) returns "@" | |
4621 nr2char(32) returns " " | |
4051 | 4622 < When {utf8} is omitted or zero, the current 'encoding' is used. |
4623 Example for "utf-8": > | |
7 | 4624 nr2char(300) returns I with bow character |
4051 | 4625 < With {utf8} set to 1, always return utf-8 characters. |
4626 Note that a NUL character in the file is specified with | |
7 | 4627 nr2char(10), because NULs are represented with newline |
4628 characters. nr2char(0) is a real NUL and terminates the | |
119 | 4629 string, thus results in an empty string. |
7 | 4630 |
3214 | 4631 or({expr}, {expr}) *or()* |
4632 Bitwise OR on the two arguments. The arguments are converted | |
4633 to a number. A List, Dict or Float argument causes an error. | |
4634 Example: > | |
4635 :let bits = or(bits, 0x80) | |
4636 | |
4637 | |
819 | 4638 pathshorten({expr}) *pathshorten()* |
4639 Shorten directory names in the path {expr} and return the | |
4640 result. The tail, the file name, is kept as-is. The other | |
4641 components in the path are reduced to single letters. Leading | |
4642 '~' and '.' characters are kept. Example: > | |
4643 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
4644 < ~/.v/a/myfile.vim ~ | |
4645 It doesn't matter if the path exists or not. | |
4646 | |
1621 | 4647 pow({x}, {y}) *pow()* |
4648 Return the power of {x} to the exponent {y} as a |Float|. | |
4649 {x} and {y} must evaluate to a |Float| or a |Number|. | |
4650 Examples: > | |
4651 :echo pow(3, 3) | |
4652 < 27.0 > | |
4653 :echo pow(2, 16) | |
4654 < 65536.0 > | |
4655 :echo pow(32, 0.20) | |
4656 < 2.0 | |
4657 {only available when compiled with the |+float| feature} | |
4658 | |
667 | 4659 prevnonblank({lnum}) *prevnonblank()* |
4660 Return the line number of the first line at or above {lnum} | |
4661 that is not blank. Example: > | |
4662 let ind = indent(prevnonblank(v:lnum - 1)) | |
4663 < When {lnum} is invalid or there is no non-blank line at or | |
4664 above it, zero is returned. | |
4665 Also see |nextnonblank()|. | |
4666 | |
4667 | |
449 | 4668 printf({fmt}, {expr1} ...) *printf()* |
4669 Return a String with {fmt}, where "%" items are replaced by | |
4670 the formatted form of their respective arguments. Example: > | |
452 | 4671 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 4672 < May result in: |
452 | 4673 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 4674 |
4675 Often used items are: | |
856 | 4676 %s string |
3914 | 4677 %6S string right-aligned in 6 display cells |
653 | 4678 %6s string right-aligned in 6 bytes |
1621 | 4679 %.9s string truncated to 9 bytes |
4680 %c single byte | |
4681 %d decimal number | |
4682 %5d decimal number padded with spaces to 5 characters | |
4683 %x hex number | |
4684 %04x hex number padded with zeros to at least 4 characters | |
4685 %X hex number using upper case letters | |
4686 %o octal number | |
4687 %f floating point number in the form 123.456 | |
4688 %e floating point number in the form 1.234e3 | |
4689 %E floating point number in the form 1.234E3 | |
4690 %g floating point number, as %f or %e depending on value | |
4691 %G floating point number, as %f or %E depending on value | |
4692 %% the % character itself | |
449 | 4693 |
4694 Conversion specifications start with '%' and end with the | |
4695 conversion type. All other characters are copied unchanged to | |
4696 the result. | |
4697 | |
4698 The "%" starts a conversion specification. The following | |
452 | 4699 arguments appear in sequence: |
4700 | |
4701 % [flags] [field-width] [.precision] type | |
4702 | |
856 | 4703 flags |
452 | 4704 Zero or more of the following flags: |
4705 | |
449 | 4706 # The value should be converted to an "alternate |
4707 form". For c, d, and s conversions, this option | |
4708 has no effect. For o conversions, the precision | |
4709 of the number is increased to force the first | |
4710 character of the output string to a zero (except | |
4711 if a zero value is printed with an explicit | |
4712 precision of zero). | |
4713 For x and X conversions, a non-zero result has | |
4714 the string "0x" (or "0X" for X conversions) | |
4715 prepended to it. | |
452 | 4716 |
449 | 4717 0 (zero) Zero padding. For all conversions the converted |
4718 value is padded on the left with zeros rather | |
4719 than blanks. If a precision is given with a | |
4720 numeric conversion (d, o, x, and X), the 0 flag | |
4721 is ignored. | |
452 | 4722 |
449 | 4723 - A negative field width flag; the converted value |
4724 is to be left adjusted on the field boundary. | |
4725 The converted value is padded on the right with | |
4726 blanks, rather than on the left with blanks or | |
4727 zeros. A - overrides a 0 if both are given. | |
452 | 4728 |
449 | 4729 ' ' (space) A blank should be left before a positive |
4730 number produced by a signed conversion (d). | |
452 | 4731 |
449 | 4732 + A sign must always be placed before a number |
1621 | 4733 produced by a signed conversion. A + overrides |
449 | 4734 a space if both are used. |
452 | 4735 |
4736 field-width | |
4737 An optional decimal digit string specifying a minimum | |
653 | 4738 field width. If the converted value has fewer bytes |
4739 than the field width, it will be padded with spaces on | |
4740 the left (or right, if the left-adjustment flag has | |
4741 been given) to fill out the field width. | |
452 | 4742 |
4743 .precision | |
4744 An optional precision, in the form of a period '.' | |
4745 followed by an optional digit string. If the digit | |
4746 string is omitted, the precision is taken as zero. | |
4747 This gives the minimum number of digits to appear for | |
4748 d, o, x, and X conversions, or the maximum number of | |
653 | 4749 bytes to be printed from a string for s conversions. |
1621 | 4750 For floating point it is the number of digits after |
4751 the decimal point. | |
452 | 4752 |
4753 type | |
4754 A character that specifies the type of conversion to | |
4755 be applied, see below. | |
4756 | |
449 | 4757 A field width or precision, or both, may be indicated by an |
4758 asterisk '*' instead of a digit string. In this case, a | |
1621 | 4759 Number argument supplies the field width or precision. A |
449 | 4760 negative field width is treated as a left adjustment flag |
4761 followed by a positive field width; a negative precision is | |
4762 treated as though it were missing. Example: > | |
452 | 4763 :echo printf("%d: %.*s", nr, width, line) |
449 | 4764 < This limits the length of the text used from "line" to |
452 | 4765 "width" bytes. |
449 | 4766 |
856 | 4767 The conversion specifiers and their meanings are: |
452 | 4768 |
1621 | 4769 *printf-d* *printf-o* *printf-x* *printf-X* |
4770 doxX The Number argument is converted to signed decimal | |
449 | 4771 (d), unsigned octal (o), or unsigned hexadecimal (x |
4772 and X) notation. The letters "abcdef" are used for | |
4773 x conversions; the letters "ABCDEF" are used for X | |
452 | 4774 conversions. |
4775 The precision, if any, gives the minimum number of | |
4776 digits that must appear; if the converted value | |
4777 requires fewer digits, it is padded on the left with | |
4778 zeros. | |
4779 In no case does a non-existent or small field width | |
4780 cause truncation of a numeric field; if the result of | |
4781 a conversion is wider than the field width, the field | |
4782 is expanded to contain the conversion result. | |
4783 | |
1621 | 4784 *printf-c* |
452 | 4785 c The Number argument is converted to a byte, and the |
4786 resulting character is written. | |
4787 | |
1621 | 4788 *printf-s* |
452 | 4789 s The text of the String argument is used. If a |
4790 precision is specified, no more bytes than the number | |
4791 specified are used. | |
6583 | 4792 *printf-S* |
3914 | 4793 S The text of the String argument is used. If a |
4794 precision is specified, no more display cells than the | |
4795 number specified are used. Without the |+multi_byte| | |
4796 feature works just like 's'. | |
452 | 4797 |
1621 | 4798 *printf-f* *E807* |
4799 f The Float argument is converted into a string of the | |
4800 form 123.456. The precision specifies the number of | |
4801 digits after the decimal point. When the precision is | |
4802 zero the decimal point is omitted. When the precision | |
4803 is not specified 6 is used. A really big number | |
4804 (out of range or dividing by zero) results in "inf". | |
4805 "0.0 / 0.0" results in "nan". | |
4806 Example: > | |
4807 echo printf("%.2f", 12.115) | |
4808 < 12.12 | |
4809 Note that roundoff depends on the system libraries. | |
4810 Use |round()| when in doubt. | |
4811 | |
4812 *printf-e* *printf-E* | |
4813 e E The Float argument is converted into a string of the | |
4814 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
4815 precision specifies the number of digits after the | |
4816 decimal point, like with 'f'. | |
4817 | |
4818 *printf-g* *printf-G* | |
4819 g G The Float argument is converted like with 'f' if the | |
4820 value is between 0.001 (inclusive) and 10000000.0 | |
4821 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
4822 for 'G'. When no precision is specified superfluous | |
4823 zeroes and '+' signs are removed, except for the zero | |
4824 immediately after the decimal point. Thus 10000000.0 | |
4825 results in 1.0e7. | |
4826 | |
4827 *printf-%* | |
449 | 4828 % A '%' is written. No argument is converted. The |
4829 complete conversion specification is "%%". | |
452 | 4830 |
1668 | 4831 When a Number argument is expected a String argument is also |
4832 accepted and automatically converted. | |
4833 When a Float or String argument is expected a Number argument | |
4834 is also accepted and automatically converted. | |
4835 Any other argument type results in an error message. | |
449 | 4836 |
459 | 4837 *E766* *E767* |
449 | 4838 The number of {exprN} arguments must exactly match the number |
4839 of "%" items. If there are not sufficient or too many | |
452 | 4840 arguments an error is given. Up to 18 arguments can be used. |
449 | 4841 |
4842 | |
667 | 4843 pumvisible() *pumvisible()* |
4844 Returns non-zero when the popup menu is visible, zero | |
4845 otherwise. See |ins-completion-menu|. | |
712 | 4846 This can be used to avoid some things that would remove the |
4847 popup menu. | |
7 | 4848 |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
4849 *E860* |
3682 | 4850 py3eval({expr}) *py3eval()* |
4851 Evaluate Python expression {expr} and return its result | |
4852 converted to Vim data structures. | |
4853 Numbers and strings are returned as they are (strings are | |
6647 | 4854 copied though, Unicode strings are additionally converted to |
3682 | 4855 'encoding'). |
4856 Lists are represented as Vim |List| type. | |
4857 Dictionaries are represented as Vim |Dictionary| type with | |
4858 keys converted to strings. | |
4859 {only available when compiled with the |+python3| feature} | |
4860 | |
4861 *E858* *E859* | |
4862 pyeval({expr}) *pyeval()* | |
4863 Evaluate Python expression {expr} and return its result | |
4864 converted to Vim data structures. | |
4865 Numbers and strings are returned as they are (strings are | |
4866 copied though). | |
4867 Lists are represented as Vim |List| type. | |
3830 | 4868 Dictionaries are represented as Vim |Dictionary| type, |
4869 non-string keys result in error. | |
3682 | 4870 {only available when compiled with the |+python| feature} |
4871 | |
114 | 4872 *E726* *E727* |
99 | 4873 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 4874 Returns a |List| with Numbers: |
99 | 4875 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
4876 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
4877 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
4878 {max}] (increasing {expr} with {stride} each time, not | |
4879 producing a value past {max}). | |
336 | 4880 When the maximum is one before the start the result is an |
4881 empty list. When the maximum is more than one before the | |
4882 start this is an error. | |
99 | 4883 Examples: > |
856 | 4884 range(4) " [0, 1, 2, 3] |
99 | 4885 range(2, 4) " [2, 3, 4] |
4886 range(2, 9, 3) " [2, 5, 8] | |
856 | 4887 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 4888 range(0) " [] |
4889 range(2, 0) " error! | |
99 | 4890 < |
158 | 4891 *readfile()* |
168 | 4892 readfile({fname} [, {binary} [, {max}]]) |
685 | 4893 Read file {fname} and return a |List|, each line of the file |
4894 as an item. Lines broken at NL characters. Macintosh files | |
158 | 4895 separated with CR will result in a single long line (unless a |
4896 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
|
4897 All NUL characters are replaced with a NL character. |
6385 | 4898 When {binary/append} contains "b" binary mode is used: |
158 | 4899 - When the last line ends in a NL an extra empty list item is |
4900 added. | |
4901 - No CR characters are removed. | |
4902 Otherwise: | |
4903 - CR characters that appear before a NL are removed. | |
4904 - 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
|
4905 - 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
|
4906 removed from the text. |
168 | 4907 When {max} is given this specifies the maximum number of lines |
4908 to be read. Useful if you only want to check the first ten | |
4909 lines of a file: > | |
4910 :for line in readfile(fname, '', 10) | |
4911 : if line =~ 'Date' | echo line | endif | |
4912 :endfor | |
233 | 4913 < When {max} is negative -{max} lines from the end of the file |
4914 are returned, or as many as there are. | |
4915 When {max} is zero the result is an empty list. | |
168 | 4916 Note that without {max} the whole file is read into memory. |
4917 Also note that there is no recognition of encoding. Read a | |
4918 file into a buffer if you need to. | |
158 | 4919 When the file can't be opened an error message is given and |
4920 the result is an empty list. | |
4921 Also see |writefile()|. | |
4922 | |
794 | 4923 reltime([{start} [, {end}]]) *reltime()* |
4924 Return an item that represents a time value. The format of | |
4925 the item depends on the system. It can be passed to | |
4926 |reltimestr()| to convert it to a string. | |
4927 Without an argument it returns the current time. | |
4928 With one argument is returns the time passed since the time | |
4929 specified in the argument. | |
843 | 4930 With two arguments it returns the time passed between {start} |
794 | 4931 and {end}. |
4932 The {start} and {end} arguments must be values returned by | |
4933 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4934 {only available when compiled with the |+reltime| feature} |
794 | 4935 |
4936 reltimestr({time}) *reltimestr()* | |
4937 Return a String that represents the time value of {time}. | |
4938 This is the number of seconds, a dot and the number of | |
4939 microseconds. Example: > | |
4940 let start = reltime() | |
4941 call MyFunction() | |
4942 echo reltimestr(reltime(start)) | |
4943 < Note that overhead for the commands will be added to the time. | |
4944 The accuracy depends on the system. | |
1156 | 4945 Leading spaces are used to make the string align nicely. You |
4946 can use split() to remove it. > | |
4947 echo split(reltimestr(reltime(start)))[0] | |
4948 < 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
|
4949 {only available when compiled with the |+reltime| feature} |
794 | 4950 |
7 | 4951 *remote_expr()* *E449* |
4952 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 4953 Send the {string} to {server}. The string is sent as an |
7 | 4954 expression and the result is returned after evaluation. |
714 | 4955 The result must be a String or a |List|. A |List| is turned |
4956 into a String by joining the items with a line break in | |
4957 between (not at the end), like with join(expr, "\n"). | |
7 | 4958 If {idvar} is present, it is taken as the name of a |
4959 variable and a {serverid} for later use with | |
4960 remote_read() is stored there. | |
4961 See also |clientserver| |RemoteReply|. | |
4962 This function is not available in the |sandbox|. | |
4963 {only available when compiled with the |+clientserver| feature} | |
4964 Note: Any errors will cause a local error message to be issued | |
4965 and the result will be the empty string. | |
4966 Examples: > | |
4967 :echo remote_expr("gvim", "2+2") | |
4968 :echo remote_expr("gvim1", "b:current_syntax") | |
4969 < | |
4970 | |
4971 remote_foreground({server}) *remote_foreground()* | |
4972 Move the Vim server with the name {server} to the foreground. | |
4973 This works like: > | |
4974 remote_expr({server}, "foreground()") | |
4975 < Except that on Win32 systems the client does the work, to work | |
4976 around the problem that the OS doesn't always allow the server | |
4977 to bring itself to the foreground. | |
574 | 4978 Note: This does not restore the window if it was minimized, |
4979 like foreground() does. | |
7 | 4980 This function is not available in the |sandbox|. |
4981 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
4982 Win32 console version} | |
4983 | |
4984 | |
4985 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
4986 Returns a positive number if there are available strings | |
4987 from {serverid}. Copies any reply string into the variable | |
1621 | 4988 {retvar} if specified. {retvar} must be a string with the |
7 | 4989 name of a variable. |
4990 Returns zero if none are available. | |
4991 Returns -1 if something is wrong. | |
4992 See also |clientserver|. | |
4993 This function is not available in the |sandbox|. | |
4994 {only available when compiled with the |+clientserver| feature} | |
4995 Examples: > | |
4996 :let repl = "" | |
4997 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
4998 | |
4999 remote_read({serverid}) *remote_read()* | |
5000 Return the oldest available reply from {serverid} and consume | |
5001 it. It blocks until a reply is available. | |
5002 See also |clientserver|. | |
5003 This function is not available in the |sandbox|. | |
5004 {only available when compiled with the |+clientserver| feature} | |
5005 Example: > | |
5006 :echo remote_read(id) | |
5007 < | |
5008 *remote_send()* *E241* | |
5009 remote_send({server}, {string} [, {idvar}]) | |
1621 | 5010 Send the {string} to {server}. The string is sent as input |
22 | 5011 keys and the function returns immediately. At the Vim server |
5012 the keys are not mapped |:map|. | |
667 | 5013 If {idvar} is present, it is taken as the name of a variable |
5014 and a {serverid} for later use with remote_read() is stored | |
5015 there. | |
7 | 5016 See also |clientserver| |RemoteReply|. |
5017 This function is not available in the |sandbox|. | |
5018 {only available when compiled with the |+clientserver| feature} | |
5019 Note: Any errors will be reported in the server and may mess | |
5020 up the display. | |
5021 Examples: > | |
5022 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
5023 \ remote_read(serverid) | |
5024 | |
5025 :autocmd NONE RemoteReply * | |
5026 \ echo remote_read(expand("<amatch>")) | |
5027 :echo remote_send("gvim", ":sleep 10 | echo ". | |
5028 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 5029 < |
79 | 5030 remove({list}, {idx} [, {end}]) *remove()* |
685 | 5031 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
|
5032 return the item. |
79 | 5033 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5034 return a List with these items. When {idx} points to the same |
79 | 5035 item as {end} a list with one item is returned. When {end} |
5036 points to an item before {idx} this is an error. | |
5037 See |list-index| for possible values of {idx} and {end}. | |
55 | 5038 Example: > |
5039 :echo "last item: " . remove(mylist, -1) | |
79 | 5040 :call remove(mylist, 0, 9) |
99 | 5041 remove({dict}, {key}) |
5042 Remove the entry from {dict} with key {key}. Example: > | |
5043 :echo "removed " . remove(dict, "one") | |
5044 < If there is no {key} in {dict} this is an error. | |
5045 | |
5046 Use |delete()| to remove a file. | |
55 | 5047 |
7 | 5048 rename({from}, {to}) *rename()* |
5049 Rename the file by the name {from} to the name {to}. This | |
5050 should also work to move files across file systems. The | |
5051 result is a Number, which is 0 if the file was renamed | |
5052 successfully, and non-zero when the renaming failed. | |
1851 | 5053 NOTE: If {to} exists it is overwritten without warning. |
7 | 5054 This function is not available in the |sandbox|. |
5055 | |
18 | 5056 repeat({expr}, {count}) *repeat()* |
5057 Repeat {expr} {count} times and return the concatenated | |
5058 result. Example: > | |
843 | 5059 :let separator = repeat('-', 80) |
18 | 5060 < When {count} is zero or negative the result is empty. |
685 | 5061 When {expr} is a |List| the result is {expr} concatenated |
1621 | 5062 {count} times. Example: > |
79 | 5063 :let longlist = repeat(['a', 'b'], 3) |
5064 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 5065 |
82 | 5066 |
7 | 5067 resolve({filename}) *resolve()* *E655* |
5068 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
5069 returns the path the shortcut points to in a simplified form. | |
5070 On Unix, repeat resolving symbolic links in all path | |
5071 components of {filename} and return the simplified result. | |
5072 To cope with link cycles, resolving of symbolic links is | |
5073 stopped after 100 iterations. | |
5074 On other systems, return the simplified {filename}. | |
5075 The simplification step is done as by |simplify()|. | |
5076 resolve() keeps a leading path component specifying the | |
5077 current directory (provided the result is still a relative | |
5078 path name) and also keeps a trailing path separator. | |
5079 | |
82 | 5080 *reverse()* |
1621 | 5081 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 5082 {list}. |
5083 If you want a list to remain unmodified make a copy first: > | |
5084 :let revlist = reverse(copy(mylist)) | |
5085 | |
1621 | 5086 round({expr}) *round()* |
1668 | 5087 Round off {expr} to the nearest integral value and return it |
1621 | 5088 as a |Float|. If {expr} lies halfway between two integral |
5089 values, then use the larger one (away from zero). | |
5090 {expr} must evaluate to a |Float| or a |Number|. | |
5091 Examples: > | |
5092 echo round(0.456) | |
5093 < 0.0 > | |
5094 echo round(4.5) | |
5095 < 5.0 > | |
5096 echo round(-4.5) | |
5097 < -5.0 | |
5098 {only available when compiled with the |+float| feature} | |
3996 | 5099 |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5100 screenattr(row, col) *screenattr()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5101 Like screenchar(), but return the attribute. This is a rather |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5102 arbitrary number that can only be used to compare to the |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5103 attribute at other positions. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5104 |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5105 screenchar(row, col) *screenchar()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5106 The result is a Number, which is the character at position |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5107 [row, col] on the screen. This works for every possible |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5108 screen position, also status lines, window separators and the |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5109 command line. The top left position is row one, column one |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5110 The character excludes composing characters. For double-byte |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5111 encodings it may only be the first byte. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5112 This is mainly to be used for testing. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5113 Returns -1 when row or col is out of range. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5114 |
3996 | 5115 screencol() *screencol()* |
5116 The result is a Number, which is the current screen column of | |
5117 the cursor. The leftmost column has number 1. | |
5118 This function is mainly used for testing. | |
5119 | |
5120 Note: Always returns the current screen column, thus if used | |
5121 in a command (e.g. ":echo screencol()") it will return the | |
5122 column inside the command line, which is 1 when the command is | |
5123 executed. To get the cursor position in the file use one of | |
5124 the following mappings: > | |
5125 nnoremap <expr> GG ":echom ".screencol()."\n" | |
5126 nnoremap <silent> GG :echom screencol()<CR> | |
5127 < | |
5128 screenrow() *screenrow()* | |
5129 The result is a Number, which is the current screen row of the | |
5130 cursor. The top line has number one. | |
5131 This function is mainly used for testing. | |
5132 | |
5133 Note: Same restrictions as with |screencol()|. | |
5134 | |
1496 | 5135 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 5136 Search for regexp pattern {pattern}. The search starts at the |
119 | 5137 cursor position (you can use |cursor()| to set it). |
707 | 5138 |
3967 | 5139 When a match has been found its line number is returned. |
3312 | 5140 If there is no match a 0 is returned and the cursor doesn't |
5141 move. No error message is given. | |
5142 | |
7 | 5143 {flags} is a String, which can contain these character flags: |
5144 'b' search backward instead of forward | |
1621 | 5145 'c' accept a match at the cursor position |
712 | 5146 'e' move to the End of the match |
20 | 5147 'n' do Not move the cursor |
712 | 5148 'p' return number of matching sub-pattern (see below) |
5149 's' set the ' mark at the previous location of the cursor | |
7 | 5150 'w' wrap around the end of the file |
5151 'W' don't wrap around the end of the file | |
5152 If neither 'w' or 'W' is given, the 'wrapscan' option applies. | |
5153 | |
444 | 5154 If the 's' flag is supplied, the ' mark is set, only if the |
5155 cursor is moved. The 's' flag cannot be combined with the 'n' | |
5156 flag. | |
5157 | |
1156 | 5158 'ignorecase', 'smartcase' and 'magic' are used. |
5159 | |
692 | 5160 When the {stopline} argument is given then the search stops |
5161 after searching this line. This is useful to restrict the | |
5162 search to a range of lines. Examples: > | |
5163 let match = search('(', 'b', line("w0")) | |
5164 let end = search('END', '', line("w$")) | |
5165 < When {stopline} is used and it is not zero this also implies | |
5166 that the search does not wrap around the end of the file. | |
1496 | 5167 A zero value is equal to not giving the argument. |
5168 | |
5169 When the {timeout} argument is given the search stops when | |
3513 | 5170 more than this many milliseconds have passed. Thus when |
1496 | 5171 {timeout} is 500 the search stops after half a second. |
5172 The value must not be negative. A zero value is like not | |
5173 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
|
5174 {only available when compiled with the |+reltime| feature} |
692 | 5175 |
714 | 5176 *search()-sub-match* |
5177 With the 'p' flag the returned value is one more than the | |
5178 first sub-match in \(\). One if none of them matched but the | |
5179 whole pattern did match. | |
712 | 5180 To get the column number too use |searchpos()|. |
5181 | |
20 | 5182 The cursor will be positioned at the match, unless the 'n' |
707 | 5183 flag is used. |
7 | 5184 |
5185 Example (goes over all files in the argument list): > | |
5186 :let n = 1 | |
5187 :while n <= argc() " loop over all files in arglist | |
5188 : exe "argument " . n | |
5189 : " start at the last char in the file and wrap for the | |
5190 : " first search to find match at start of file | |
5191 : normal G$ | |
5192 : let flags = "w" | |
5193 : while search("foo", flags) > 0 | |
1621 | 5194 : s/foo/bar/g |
7 | 5195 : let flags = "W" |
5196 : endwhile | |
5197 : update " write the file if modified | |
5198 : let n = n + 1 | |
5199 :endwhile | |
5200 < | |
712 | 5201 Example for using some flags: > |
5202 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
5203 < This will search for the keywords "if", "else", and "endif" | |
5204 under or after the cursor. Because of the 'p' flag, it | |
5205 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
5206 if the search fails. With the cursor on the first word of the | |
5207 line: | |
5208 if (foo == 0) | let foo = foo + 1 | endif ~ | |
5209 the function returns 1. Without the 'c' flag, the function | |
5210 finds the "endif" and returns 3. The same thing happens | |
5211 without the 'e' flag if the cursor is on the "f" of "if". | |
5212 The 'n' flag tells the function not to move the cursor. | |
5213 | |
504 | 5214 |
523 | 5215 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
5216 Search for the declaration of {name}. | |
856 | 5217 |
523 | 5218 With a non-zero {global} argument it works like |gD|, find |
5219 first match in the file. Otherwise it works like |gd|, find | |
5220 first match in the function. | |
5221 | |
5222 With a non-zero {thisblock} argument matches in a {} block | |
5223 that ends before the cursor position are ignored. Avoids | |
5224 finding variable declarations only valid in another scope. | |
5225 | |
504 | 5226 Moves the cursor to the found match. |
5227 Returns zero for success, non-zero for failure. | |
5228 Example: > | |
5229 if searchdecl('myvar') == 0 | |
5230 echo getline('.') | |
5231 endif | |
5232 < | |
7 | 5233 *searchpair()* |
1496 | 5234 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
5235 [, {stopline} [, {timeout}]]]]) | |
7 | 5236 Search for the match of a nested start-end pair. This can be |
5237 used to find the "endif" that matches an "if", while other | |
5238 if/endif pairs in between are ignored. | |
677 | 5239 The search starts at the cursor. The default is to search |
5240 forward, include 'b' in {flags} to search backward. | |
5241 If a match is found, the cursor is positioned at it and the | |
5242 line number is returned. If no match is found 0 or -1 is | |
5243 returned and the cursor doesn't move. No error message is | |
5244 given. | |
7 | 5245 |
5246 {start}, {middle} and {end} are patterns, see |pattern|. They | |
5247 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
5248 {middle} is not empty, it is found when searching from either | |
5249 direction, but only when not in a nested start-end pair. A | |
5250 typical use is: > | |
5251 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
5252 < By leaving {middle} empty the "else" is skipped. | |
5253 | |
712 | 5254 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
5255 |search()|. Additionally: | |
7 | 5256 'r' Repeat until no more matches found; will find the |
1621 | 5257 outer pair. Implies the 'W' flag. |
5258 'm' Return number of matches instead of line number with | |
712 | 5259 the match; will be > 1 when 'r' is used. |
1621 | 5260 Note: it's nearly always a good idea to use the 'W' flag, to |
5261 avoid wrapping around the end of the file. | |
7 | 5262 |
5263 When a match for {start}, {middle} or {end} is found, the | |
5264 {skip} expression is evaluated with the cursor positioned on | |
5265 the start of the match. It should return non-zero if this | |
5266 match is to be skipped. E.g., because it is inside a comment | |
5267 or a string. | |
5268 When {skip} is omitted or empty, every match is accepted. | |
5269 When evaluating {skip} causes an error the search is aborted | |
5270 and -1 returned. | |
5271 | |
1496 | 5272 For {stopline} and {timeout} see |search()|. |
692 | 5273 |
7 | 5274 The value of 'ignorecase' is used. 'magic' is ignored, the |
5275 patterns are used like it's on. | |
5276 | |
5277 The search starts exactly at the cursor. A match with | |
5278 {start}, {middle} or {end} at the next character, in the | |
5279 direction of searching, is the first one found. Example: > | |
5280 if 1 | |
5281 if 2 | |
5282 endif 2 | |
5283 endif 1 | |
5284 < When starting at the "if 2", with the cursor on the "i", and | |
5285 searching forwards, the "endif 2" is found. When starting on | |
5286 the character just before the "if 2", the "endif 1" will be | |
1621 | 5287 found. That's because the "if 2" will be found first, and |
7 | 5288 then this is considered to be a nested if/endif from "if 2" to |
5289 "endif 2". | |
5290 When searching backwards and {end} is more than one character, | |
5291 it may be useful to put "\zs" at the end of the pattern, so | |
5292 that when the cursor is inside a match with the end it finds | |
5293 the matching start. | |
5294 | |
5295 Example, to find the "endif" command in a Vim script: > | |
5296 | |
5297 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
5298 \ 'getline(".") =~ "^\\s*\""') | |
5299 | |
5300 < The cursor must be at or after the "if" for which a match is | |
5301 to be found. Note that single-quote strings are used to avoid | |
5302 having to double the backslashes. The skip expression only | |
5303 catches comments at the start of a line, not after a command. | |
5304 Also, a word "en" or "if" halfway a line is considered a | |
5305 match. | |
5306 Another example, to search for the matching "{" of a "}": > | |
5307 | |
5308 :echo searchpair('{', '', '}', 'bW') | |
5309 | |
5310 < This works when the cursor is at or before the "}" for which a | |
5311 match is to be found. To reject matches that syntax | |
5312 highlighting recognized as strings: > | |
5313 | |
5314 :echo searchpair('{', '', '}', 'bW', | |
5315 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
5316 < | |
667 | 5317 *searchpairpos()* |
1496 | 5318 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
5319 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5320 Same as |searchpair()|, but returns a |List| with the line and |
685 | 5321 column position of the match. The first element of the |List| |
5322 is the line number and the second element is the byte index of | |
667 | 5323 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
|
5324 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5325 |
667 | 5326 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
5327 < | |
5328 See |match-parens| for a bigger and more useful example. | |
5329 | |
1496 | 5330 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 5331 Same as |search()|, but returns a |List| with the line and |
685 | 5332 column position of the match. The first element of the |List| |
5333 is the line number and the second element is the byte index of | |
5334 the column position of the match. If no match is found, | |
5335 returns [0, 0]. | |
714 | 5336 Example: > |
5337 :let [lnum, col] = searchpos('mypattern', 'n') | |
5338 | |
5339 < When the 'p' flag is given then there is an extra item with | |
5340 the sub-pattern match number |search()-sub-match|. Example: > | |
5341 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
5342 < In this example "submatch" is 2 when a lowercase letter is | |
5343 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
5344 | |
7 | 5345 server2client( {clientid}, {string}) *server2client()* |
5346 Send a reply string to {clientid}. The most recent {clientid} | |
5347 that sent a string can be retrieved with expand("<client>"). | |
5348 {only available when compiled with the |+clientserver| feature} | |
5349 Note: | |
5350 This id has to be stored before the next command can be | |
236 | 5351 received. I.e. before returning from the received command and |
7 | 5352 before calling any commands that waits for input. |
5353 See also |clientserver|. | |
5354 Example: > | |
5355 :echo server2client(expand("<client>"), "HELLO") | |
5356 < | |
5357 serverlist() *serverlist()* | |
5358 Return a list of available server names, one per line. | |
5359 When there are no servers or the information is not available | |
5360 an empty string is returned. See also |clientserver|. | |
5361 {only available when compiled with the |+clientserver| feature} | |
5362 Example: > | |
5363 :echo serverlist() | |
5364 < | |
5365 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
5366 Set option or local variable {varname} in buffer {expr} to | |
5367 {val}. | |
5368 This also works for a global or local window option, but it | |
5369 doesn't work for a global or local window variable. | |
5370 For a local window option the global value is unchanged. | |
5371 For the use of {expr}, see |bufname()| above. | |
5372 Note that the variable name without "b:" must be used. | |
5373 Examples: > | |
5374 :call setbufvar(1, "&mod", 1) | |
5375 :call setbufvar("todo", "myvar", "foobar") | |
5376 < This function is not available in the |sandbox|. | |
5377 | |
5378 setcmdpos({pos}) *setcmdpos()* | |
5379 Set the cursor position in the command line to byte position | |
1621 | 5380 {pos}. The first position is 1. |
7 | 5381 Use |getcmdpos()| to obtain the current position. |
5382 Only works while editing the command line, thus you must use | |
99 | 5383 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
5384 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
5385 set after the command line is set to the expression. For | |
5386 |c_CTRL-R_=| it is set after evaluating the expression but | |
5387 before inserting the resulting text. | |
7 | 5388 When the number is too big the cursor is put at the end of the |
5389 line. A number smaller than one has undefined results. | |
5390 Returns 0 when successful, 1 when not editing the command | |
5391 line. | |
5392 | |
1621 | 5393 setline({lnum}, {text}) *setline()* |
3312 | 5394 Set line {lnum} of the current buffer to {text}. To insert |
5395 lines use |append()|. | |
236 | 5396 {lnum} is used like with |getline()|. |
1621 | 5397 When {lnum} is just below the last line the {text} will be |
282 | 5398 added as a new line. |
236 | 5399 If this succeeds, 0 is returned. If this fails (most likely |
5400 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 5401 :call setline(5, strftime("%c")) |
1621 | 5402 < When {text} is a |List| then line {lnum} and following lines |
282 | 5403 will be set to the items in the list. Example: > |
5404 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
5405 < This is equivalent to: > | |
3465 | 5406 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
282 | 5407 : call setline(n, l) |
5408 :endfor | |
7 | 5409 < Note: The '[ and '] marks are not set. |
5410 | |
647 | 5411 setloclist({nr}, {list} [, {action}]) *setloclist()* |
5412 Create or replace or add to the location list for window {nr}. | |
5413 When {nr} is zero the current window is used. For a location | |
648 | 5414 list window, the displayed location list is modified. For an |
5415 invalid window number {nr}, -1 is returned. | |
1326 | 5416 Otherwise, same as |setqflist()|. |
5417 Also see |location-list|. | |
5418 | |
5419 setmatches({list}) *setmatches()* | |
5420 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 5421 if successful, otherwise -1. All current matches are cleared |
1326 | 5422 before the list is restored. See example for |getmatches()|. |
230 | 5423 |
707 | 5424 *setpos()* |
5425 setpos({expr}, {list}) | |
5426 Set the position for {expr}. Possible values: | |
5427 . the cursor | |
5428 'x mark x | |
5429 | |
5938 | 5430 {list} must be a |List| with four or five numbers: |
707 | 5431 [bufnum, lnum, col, off] |
5938 | 5432 [bufnum, lnum, col, off, curswant] |
707 | 5433 |
1621 | 5434 "bufnum" is the buffer number. Zero can be used for the |
856 | 5435 current buffer. Setting the cursor is only possible for |
707 | 5436 the current buffer. To set a mark in another buffer you can |
5437 use the |bufnr()| function to turn a file name into a buffer | |
5438 number. | |
798 | 5439 Does not change the jumplist. |
707 | 5440 |
5441 "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
|
5442 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
|
5443 smaller than 1 then 1 is used. |
707 | 5444 |
5445 The "off" number is only used when 'virtualedit' is set. Then | |
5446 it is the offset in screen columns from the start of the | |
1266 | 5447 character. E.g., a position within a <Tab> or after the last |
707 | 5448 character. |
5449 | |
5938 | 5450 The "curswant" number is only used when setting the cursor |
5451 position. It sets the preferred column for when moving the | |
5452 cursor vertically. When the "curswant" number is missing the | |
5453 preferred column is not set. When it is present and setting a | |
5454 mark position it is not used. | |
5455 | |
5555 | 5456 Note that for '< and '> changing the line number may result in |
5457 the marks to be effectively be swapped, so that '< is always | |
5458 before '>. | |
5459 | |
1533 | 5460 Returns 0 when the position could be set, -1 otherwise. |
5461 An error message is given if {expr} is invalid. | |
5462 | |
5944 | 5463 Also see |getpos()| and |getcurpos()|. |
707 | 5464 |
1156 | 5465 This does not restore the preferred column for moving |
5938 | 5466 vertically; if you set the cursor position with this, |j| and |
5467 |k| motions will jump to previous columns! Use |cursor()| to | |
5468 also set the preferred column. Also see the "curswant" key in | |
5469 |winrestview()|. | |
1156 | 5470 |
707 | 5471 |
277 | 5472 setqflist({list} [, {action}]) *setqflist()* |
647 | 5473 Create or replace or add to the quickfix list using the items |
5474 in {list}. Each item in {list} is a dictionary. | |
5475 Non-dictionary items in {list} are ignored. Each dictionary | |
5476 item can contain the following entries: | |
230 | 5477 |
1065 | 5478 bufnr buffer number; must be the number of a valid |
1621 | 5479 buffer |
1065 | 5480 filename name of a file; only used when "bufnr" is not |
1621 | 5481 present or it is invalid. |
230 | 5482 lnum line number in the file |
233 | 5483 pattern search pattern used to locate the error |
230 | 5484 col column number |
233 | 5485 vcol when non-zero: "col" is visual column |
856 | 5486 when zero: "col" is byte index |
233 | 5487 nr error number |
230 | 5488 text description of the error |
233 | 5489 type single-character error type, 'E', 'W', etc. |
5490 | |
5491 The "col", "vcol", "nr", "type" and "text" entries are | |
5492 optional. Either "lnum" or "pattern" entry can be used to | |
5493 locate a matching error line. | |
1065 | 5494 If the "filename" and "bufnr" entries are not present or |
5495 neither the "lnum" or "pattern" entries are present, then the | |
5496 item will not be handled as an error line. | |
230 | 5497 If both "pattern" and "lnum" are present then "pattern" will |
5498 be used. | |
2152 | 5499 If you supply an empty {list}, the quickfix list will be |
5500 cleared. | |
1065 | 5501 Note that the list is not exactly the same as what |
5502 |getqflist()| returns. | |
230 | 5503 |
277 | 5504 If {action} is set to 'a', then the items from {list} are |
5505 added to the existing quickfix list. If there is no existing | |
5506 list, then a new list is created. If {action} is set to 'r', | |
5507 then the items from the current quickfix list are replaced | |
5508 with the items from {list}. If {action} is not present or is | |
5509 set to ' ', then a new list is created. | |
5510 | |
230 | 5511 Returns zero for success, -1 for failure. |
5512 | |
5513 This function can be used to create a quickfix list | |
5514 independent of the 'errorformat' setting. Use a command like | |
5515 ":cc 1" to jump to the first position. | |
5516 | |
5517 | |
7 | 5518 *setreg()* |
5519 setreg({regname}, {value} [,{options}]) | |
5520 Set the register {regname} to {value}. | |
5798 | 5521 {value} may be any value returned by |getreg()|, including |
5522 a |List|. | |
7 | 5523 If {options} contains "a" or {regname} is upper case, |
5524 then the value is appended. | |
2423 | 5525 {options} can also contain a register type specification: |
7 | 5526 "c" or "v" |characterwise| mode |
5527 "l" or "V" |linewise| mode | |
5528 "b" or "<CTRL-V>" |blockwise-visual| mode | |
5529 If a number immediately follows "b" or "<CTRL-V>" then this is | |
5530 used as the width of the selection - if it is not specified | |
5531 then the width of the block is set to the number of characters | |
1266 | 5532 in the longest line (counting a <Tab> as 1 character). |
7 | 5533 |
5534 If {options} contains no register settings, then the default | |
5798 | 5535 is to use character mode unless {value} ends in a <NL> for |
5536 string {value} and linewise mode for list {value}. Blockwise | |
5537 mode is never selected automatically. | |
5538 Returns zero for success, non-zero for failure. | |
5539 | |
5540 *E883* | |
6180 | 5541 Note: you may not use |List| containing more than one item to |
5798 | 5542 set search and expression registers. Lists containing no |
5543 items act like empty strings. | |
7 | 5544 |
5545 Examples: > | |
5546 :call setreg(v:register, @*) | |
5547 :call setreg('*', @%, 'ac') | |
5548 :call setreg('a', "1\n2\n3", 'b5') | |
5549 | |
5550 < This example shows using the functions to save and restore a | |
5798 | 5551 register (note: you may not reliably restore register value |
5552 without using the third argument to |getreg()| as without it | |
5553 newlines are represented as newlines AND Nul bytes are | |
5554 represented as newlines as well, see |NL-used-for-Nul|). > | |
5555 :let var_a = getreg('a', 1, 1) | |
7 | 5556 :let var_amode = getregtype('a') |
5557 .... | |
5558 :call setreg('a', var_a, var_amode) | |
5559 | |
5560 < You can also change the type of a register by appending | |
5561 nothing: > | |
5562 :call setreg('a', '', 'al') | |
5563 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5564 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5565 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
|
5566 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5567 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
|
5568 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5569 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5570 |
831 | 5571 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
5572 Set option or local variable {varname} in window {winnr} to | |
5573 {val}. | |
5574 Tabs are numbered starting with one. For the current tabpage | |
5575 use |setwinvar()|. | |
5576 When {winnr} is zero the current window is used. | |
7 | 5577 This also works for a global or local buffer option, but it |
5578 doesn't work for a global or local buffer variable. | |
5579 For a local buffer option the global value is unchanged. | |
5580 Note that the variable name without "w:" must be used. | |
831 | 5581 Examples: > |
5582 :call settabwinvar(1, 1, "&list", 0) | |
5583 :call settabwinvar(3, 2, "myvar", "foobar") | |
5584 < This function is not available in the |sandbox|. | |
5585 | |
5586 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
5587 Like |settabwinvar()| for the current tab page. | |
7 | 5588 Examples: > |
5589 :call setwinvar(1, "&list", 0) | |
5590 :call setwinvar(2, "myvar", "foobar") | |
5591 | |
4126 | 5592 sha256({string}) *sha256()* |
6647 | 5593 Returns a String with 64 hex characters, which is the SHA256 |
4126 | 5594 checksum of {string}. |
5595 {only available when compiled with the |+cryptv| feature} | |
5596 | |
1661 | 5597 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5598 Escape {string} for use as a shell command argument. |
985 | 5599 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 5600 will enclose {string} in double quotes and double all double |
985 | 5601 quotes within {string}. |
5602 For other systems, it will enclose {string} in single quotes | |
5603 and replace all "'" with "'\''". | |
1661 | 5604 When the {special} argument is present and it's a non-zero |
5605 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 5606 items such as "!", "%", "#" and "<cword>" will be preceded by |
5607 a backslash. This backslash will be removed again by the |:!| | |
1661 | 5608 command. |
1698 | 5609 The "!" character will be escaped (again with a |non-zero-arg| |
5610 {special}) when 'shell' contains "csh" in the tail. That is | |
5611 because for csh and tcsh "!" is used for history replacement | |
5612 even when inside single quotes. | |
5613 The <NL> character is also escaped. With a |non-zero-arg| | |
5614 {special} and 'shell' containing "csh" in the tail it's | |
5615 escaped a second time. | |
1661 | 5616 Example of use with a |:!| command: > |
5617 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
5618 < This results in a directory listing for the file under the | |
5619 cursor. Example of use with |system()|: > | |
5620 :call system("chmod +w -- " . shellescape(expand("%"))) | |
5690 | 5621 < See also |::S|. |
985 | 5622 |
5623 | |
3875 | 5624 shiftwidth() *shiftwidth()* |
5625 Returns the effective value of 'shiftwidth'. This is the | |
5626 'shiftwidth' value unless it is zero, in which case it is the | |
5627 'tabstop' value. To be backwards compatible in indent | |
5628 plugins, use this: > | |
5629 if exists('*shiftwidth') | |
5630 func s:sw() | |
5631 return shiftwidth() | |
5632 endfunc | |
5633 else | |
5634 func s:sw() | |
5635 return &sw | |
5636 endfunc | |
5637 endif | |
5638 < And then use s:sw() instead of &sw. | |
5639 | |
5640 | |
7 | 5641 simplify({filename}) *simplify()* |
5642 Simplify the file name as much as possible without changing | |
5643 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
5644 Unix) are not resolved. If the first path component in | |
5645 {filename} designates the current directory, this will be | |
5646 valid for the result as well. A trailing path separator is | |
5647 not removed either. | |
5648 Example: > | |
5649 simplify("./dir/.././/file/") == "./file/" | |
5650 < Note: The combination "dir/.." is only removed if "dir" is | |
5651 a searchable directory or does not exist. On Unix, it is also | |
5652 removed when "dir" is a symbolic link within the same | |
5653 directory. In order to resolve all the involved symbolic | |
5654 links before simplifying the path name, use |resolve()|. | |
5655 | |
82 | 5656 |
1621 | 5657 sin({expr}) *sin()* |
5658 Return the sine of {expr}, measured in radians, as a |Float|. | |
5659 {expr} must evaluate to a |Float| or a |Number|. | |
5660 Examples: > | |
5661 :echo sin(100) | |
5662 < -0.506366 > | |
5663 :echo sin(-4.01) | |
5664 < 0.763301 | |
5665 {only available when compiled with the |+float| feature} | |
5666 | |
5667 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5668 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5669 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
|
5670 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5671 {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
|
5672 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5673 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5674 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5675 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5676 < -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
|
5677 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5678 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5679 |
2902 | 5680 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
5747 | 5681 Sort the items in {list} in-place. Returns {list}. |
5682 | |
5683 If you want a list to remain unmodified make a copy first: > | |
82 | 5684 :let sortedlist = sort(copy(mylist)) |
5968 | 5685 |
6009 | 5686 < When {func} is omitted, is empty or zero, then sort() uses the |
5687 string representation of each item to sort on. Numbers sort | |
5688 after Strings, |Lists| after Numbers. For sorting text in the | |
5689 current buffer use |:sort|. | |
5690 | |
6180 | 5691 When {func} is given and it is '1' or 'i' then case is |
6009 | 5692 ignored. |
5693 | |
5694 When {func} is given and it is 'n' then all items will be | |
5695 sorted numerical (Implementation detail: This uses the | |
5696 strtod() function to parse numbers, Strings, Lists, Dicts and | |
5697 Funcrefs will be considered as being 0). | |
5698 | |
685 | 5699 When {func} is a |Funcref| or a function name, this function |
5700 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
|
5701 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
|
5702 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
|
5703 smaller if the first one sorts before the second one. |
5747 | 5704 |
5705 {dict} is for functions with the "dict" attribute. It will be | |
5706 used to set the local variable "self". |Dictionary-function| | |
5707 | |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5708 The sort is stable, items which compare equal (as number or as |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5709 string) will keep their relative position. E.g., when sorting |
6051 | 5710 on numbers, text strings will sort next to each other, in the |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5711 same order as they were originally. |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5712 |
5747 | 5713 Also see |uniq()|. |
5714 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5715 Example: > |
82 | 5716 func MyCompare(i1, i2) |
5717 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
5718 endfunc | |
5719 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5720 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5721 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5722 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5723 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5724 endfunc |
344 | 5725 < |
374 | 5726 *soundfold()* |
5727 soundfold({word}) | |
5728 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 5729 language in 'spelllang' for the current window that supports |
375 | 5730 soundfolding. 'spell' must be set. When no sound folding is |
5731 possible the {word} is returned unmodified. | |
374 | 5732 This can be used for making spelling suggestions. Note that |
5733 the method can be quite slow. | |
5734 | |
344 | 5735 *spellbadword()* |
532 | 5736 spellbadword([{sentence}]) |
5737 Without argument: The result is the badly spelled word under | |
5738 or after the cursor. The cursor is moved to the start of the | |
5739 bad word. When no bad word is found in the cursor line the | |
5740 result is an empty string and the cursor doesn't move. | |
5741 | |
5742 With argument: The result is the first word in {sentence} that | |
5743 is badly spelled. If there are no spelling mistakes the | |
5744 result is an empty string. | |
5745 | |
5746 The return value is a list with two items: | |
5747 - The badly spelled word or an empty string. | |
5748 - The type of the spelling error: | |
856 | 5749 "bad" spelling mistake |
532 | 5750 "rare" rare word |
5751 "local" word only valid in another region | |
5752 "caps" word should start with Capital | |
5753 Example: > | |
5754 echo spellbadword("the quik brown fox") | |
5755 < ['quik', 'bad'] ~ | |
5756 | |
5757 The spelling information for the current window is used. The | |
5758 'spell' option must be set and the value of 'spelllang' is | |
5759 used. | |
344 | 5760 |
5761 *spellsuggest()* | |
537 | 5762 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 5763 Return a |List| with spelling suggestions to replace {word}. |
344 | 5764 When {max} is given up to this number of suggestions are |
5765 returned. Otherwise up to 25 suggestions are returned. | |
5766 | |
537 | 5767 When the {capital} argument is given and it's non-zero only |
5768 suggestions with a leading capital will be given. Use this | |
5769 after a match with 'spellcapcheck'. | |
5770 | |
344 | 5771 {word} can be a badly spelled word followed by other text. |
5772 This allows for joining two words that were split. The | |
359 | 5773 suggestions also include the following text, thus you can |
5774 replace a line. | |
5775 | |
5776 {word} may also be a good word. Similar words will then be | |
537 | 5777 returned. {word} itself is not included in the suggestions, |
5778 although it may appear capitalized. | |
344 | 5779 |
5780 The spelling information for the current window is used. The | |
375 | 5781 'spell' option must be set and the values of 'spelllang' and |
5782 'spellsuggest' are used. | |
344 | 5783 |
82 | 5784 |
282 | 5785 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 5786 Make a |List| out of {expr}. When {pattern} is omitted or |
5787 empty each white-separated sequence of characters becomes an | |
5788 item. | |
82 | 5789 Otherwise the string is split where {pattern} matches, |
3920 | 5790 removing the matched characters. 'ignorecase' is not used |
5791 here, add \c to ignore case. |/\c| | |
282 | 5792 When the first or last item is empty it is omitted, unless the |
5793 {keepempty} argument is given and it's non-zero. | |
293 | 5794 Other empty items are kept when {pattern} matches at least one |
5795 character or when {keepempty} is non-zero. | |
82 | 5796 Example: > |
95 | 5797 :let words = split(getline('.'), '\W\+') |
282 | 5798 < To split a string in individual characters: > |
236 | 5799 :for c in split(mystring, '\zs') |
258 | 5800 < If you want to keep the separator you can also use '\zs': > |
5801 :echo split('abc:def:ghi', ':\zs') | |
5802 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 5803 Splitting a table where the first element can be empty: > |
5804 :let items = split(line, ':', 1) | |
5805 < The opposite function is |join()|. | |
82 | 5806 |
5807 | |
1621 | 5808 sqrt({expr}) *sqrt()* |
5809 Return the non-negative square root of Float {expr} as a | |
5810 |Float|. | |
5811 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
5812 is negative the result is NaN (Not a Number). | |
5813 Examples: > | |
5814 :echo sqrt(100) | |
5815 < 10.0 > | |
5816 :echo sqrt(-4.01) | |
5817 < nan | |
1668 | 5818 "nan" may be different, it depends on system libraries. |
1621 | 5819 {only available when compiled with the |+float| feature} |
5820 | |
5821 | |
5822 str2float( {expr}) *str2float()* | |
5823 Convert String {expr} to a Float. This mostly works the same | |
5824 as when using a floating point number in an expression, see | |
5825 |floating-point-format|. But it's a bit more permissive. | |
5826 E.g., "1e40" is accepted, while in an expression you need to | |
5827 write "1.0e40". | |
5828 Text after the number is silently ignored. | |
5829 The decimal point is always '.', no matter what the locale is | |
5830 set to. A comma ends the number: "12,345.67" is converted to | |
5831 12.0. You can strip out thousands separators with | |
5832 |substitute()|: > | |
5833 let f = str2float(substitute(text, ',', '', 'g')) | |
5834 < {only available when compiled with the |+float| feature} | |
5835 | |
5836 | |
782 | 5837 str2nr( {expr} [, {base}]) *str2nr()* |
5838 Convert string {expr} to a number. | |
5839 {base} is the conversion base, it can be 8, 10 or 16. | |
5840 When {base} is omitted base 10 is used. This also means that | |
5841 a leading zero doesn't cause octal conversion to be used, as | |
5842 with the default String to Number conversion. | |
5843 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
5844 different base the result will be zero. | |
5845 Text after the number is silently ignored. | |
856 | 5846 |
782 | 5847 |
6884 | 5848 strchars({expr} [, {skipcc}]) *strchars()* |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5849 The result is a Number, which is the number of characters |
6884 | 5850 in String {expr}. |
5851 When {skipcc} is omitted or zero, composing characters are | |
5852 counted separately. | |
5853 When {skipcc} set to 1, Composing characters are ignored. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5854 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5855 |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5856 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5857 The result is a Number, which is the number of display cells |
6884 | 5858 String {expr} occupies on the screen when it starts at {col}. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5859 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5860 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5861 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5862 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
|
5863 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
|
5864 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5865 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5866 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5867 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5868 |
7 | 5869 strftime({format} [, {time}]) *strftime()* |
5870 The result is a String, which is a formatted date and time, as | |
5871 specified by the {format} string. The given {time} is used, | |
5872 or the current time if no time is given. The accepted | |
5873 {format} depends on your system, thus this is not portable! | |
5874 See the manual page of the C function strftime() for the | |
5875 format. The maximum length of the result is 80 characters. | |
5876 See also |localtime()| and |getftime()|. | |
5877 The language can be changed with the |:language| command. | |
5878 Examples: > | |
5879 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
5880 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
5881 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
5882 :echo strftime("%H:%M") 11:55 | |
5883 :echo strftime("%c", getftime("file.c")) | |
5884 Show mod time of file.c. | |
82 | 5885 < Not available on all systems. To check use: > |
5886 :if exists("*strftime") | |
5887 | |
133 | 5888 stridx({haystack}, {needle} [, {start}]) *stridx()* |
5889 The result is a Number, which gives the byte index in | |
5890 {haystack} of the first occurrence of the String {needle}. | |
140 | 5891 If {start} is specified, the search starts at index {start}. |
5892 This can be used to find a second match: > | |
2662 | 5893 :let colon1 = stridx(line, ":") |
5894 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 5895 < The search is done case-sensitive. |
205 | 5896 For pattern searches use |match()|. |
133 | 5897 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 5898 See also |strridx()|. |
5899 Examples: > | |
7 | 5900 :echo stridx("An Example", "Example") 3 |
5901 :echo stridx("Starting point", "Start") 0 | |
5902 :echo stridx("Starting point", "start") -1 | |
856 | 5903 < *strstr()* *strchr()* |
170 | 5904 stridx() works similar to the C function strstr(). When used |
5905 with a single character it works similar to strchr(). | |
5906 | |
55 | 5907 *string()* |
95 | 5908 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 5909 Float, String or a composition of them, then the result can be |
5910 parsed back with |eval()|. | |
55 | 5911 {expr} type result ~ |
99 | 5912 String 'string' |
95 | 5913 Number 123 |
1621 | 5914 Float 123.123456 or 1.123456e8 |
99 | 5915 Funcref function('name') |
95 | 5916 List [item, item] |
323 | 5917 Dictionary {key: value, key: value} |
99 | 5918 Note that in String values the ' character is doubled. |
1156 | 5919 Also see |strtrans()|. |
55 | 5920 |
7 | 5921 *strlen()* |
5922 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 5923 {expr} in bytes. |
55 | 5924 If the argument is a Number it is first converted to a String. |
5925 For other types an error is given. | |
6870 | 5926 If you want to count the number of multi-byte characters use |
5927 |strchars()|. | |
5928 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
7 | 5929 |
5930 strpart({src}, {start}[, {len}]) *strpart()* | |
5931 The result is a String, which is part of {src}, starting from | |
574 | 5932 byte {start}, with the byte length {len}. |
7 | 5933 When non-existing bytes are included, this doesn't result in |
5934 an error, the bytes are simply omitted. | |
5935 If {len} is missing, the copy continues from {start} till the | |
5936 end of the {src}. > | |
5937 strpart("abcdefg", 3, 2) == "de" | |
5938 strpart("abcdefg", -2, 4) == "ab" | |
5939 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 5940 strpart("abcdefg", 3) == "defg" |
7 | 5941 < Note: To get the first character, {start} must be 0. For |
5942 example, to get three bytes under and after the cursor: > | |
823 | 5943 strpart(getline("."), col(".") - 1, 3) |
7 | 5944 < |
140 | 5945 strridx({haystack}, {needle} [, {start}]) *strridx()* |
5946 The result is a Number, which gives the byte index in | |
5947 {haystack} of the last occurrence of the String {needle}. | |
5948 When {start} is specified, matches beyond this index are | |
5949 ignored. This can be used to find a match before a previous | |
5950 match: > | |
5951 :let lastcomma = strridx(line, ",") | |
5952 :let comma2 = strridx(line, ",", lastcomma - 1) | |
5953 < The search is done case-sensitive. | |
133 | 5954 For pattern searches use |match()|. |
5955 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 5956 If the {needle} is empty the length of {haystack} is returned. |
236 | 5957 See also |stridx()|. Examples: > |
7 | 5958 :echo strridx("an angry armadillo", "an") 3 |
856 | 5959 < *strrchr()* |
170 | 5960 When used with a single character it works similar to the C |
5961 function strrchr(). | |
5962 | |
7 | 5963 strtrans({expr}) *strtrans()* |
5964 The result is a String, which is {expr} with all unprintable | |
5965 characters translated into printable characters |'isprint'|. | |
5966 Like they are shown in a window. Example: > | |
5967 echo strtrans(@a) | |
5968 < This displays a newline in register a as "^@" instead of | |
5969 starting a new line. | |
5970 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5971 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5972 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
|
5973 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5974 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5975 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5976 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5977 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5978 |
5794 | 5979 submatch({nr}[, {list}]) *submatch()* |
2908 | 5980 Only for an expression in a |:substitute| command or |
5981 substitute() function. | |
5982 Returns the {nr}'th submatch of the matched text. When {nr} | |
5983 is 0 the whole matched text is returned. | |
5794 | 5984 Note that a NL in the string can stand for a line break of a |
5985 multi-line match or a NUL character in the text. | |
2908 | 5986 Also see |sub-replace-expression|. |
5794 | 5987 |
5988 If {list} is present and non-zero then submatch() returns | |
5989 a list of strings, similar to |getline()| with two arguments. | |
5990 NL characters in the text represent NUL characters in the | |
5991 text. | |
5992 Only returns more than one item for |:substitute|, inside | |
5993 |substitute()| this list will always contain one or zero | |
5994 items, since there are no real line breaks. | |
5995 | |
7 | 5996 Example: > |
5997 :s/\d\+/\=submatch(0) + 1/ | |
5998 < This finds the first number in the line and adds one to it. | |
5999 A line break is included as a newline character. | |
6000 | |
6001 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
6002 The result is a String, which is a copy of {expr}, in which | |
2908 | 6003 the first match of {pat} is replaced with {sub}. |
6004 When {flags} is "g", all matches of {pat} in {expr} are | |
6005 replaced. Otherwise {flags} should be "". | |
6006 | |
6007 This works like the ":substitute" command (without any flags). | |
6008 But the matching with {pat} is always done like the 'magic' | |
6009 option is set and 'cpoptions' is empty (to make scripts | |
3967 | 6010 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
6011 if you want to ignore or match case and ignore 'ignorecase'. | |
6012 'smartcase' is not used. See |string-match| for how {pat} is | |
6013 used. | |
2908 | 6014 |
6015 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 6016 Note that some codes in {sub} have a special meaning |
1621 | 6017 |sub-replace-special|. For example, to replace something with |
7 | 6018 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 6019 |
7 | 6020 When {pat} does not match in {expr}, {expr} is returned |
6021 unmodified. | |
2908 | 6022 |
7 | 6023 Example: > |
6024 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
6025 < This removes the last component of the 'path' option. > | |
6026 :echo substitute("testing", ".*", "\\U\\0", "") | |
6027 < results in "TESTING". | |
2908 | 6028 |
6029 When {sub} starts with "\=", the remainder is interpreted as | |
6030 an expression. See |sub-replace-expression|. Example: > | |
2833 | 6031 :echo substitute(s, '%\(\x\x\)', |
6032 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 6033 |
32 | 6034 synID({lnum}, {col}, {trans}) *synID()* |
7 | 6035 The result is a Number, which is the syntax ID at the position |
32 | 6036 {lnum} and {col} in the current window. |
7 | 6037 The syntax ID can be used with |synIDattr()| and |
6038 |synIDtrans()| to obtain syntax information about text. | |
419 | 6039 |
32 | 6040 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 6041 line. 'synmaxcol' applies, in a longer line zero is returned. |
6042 | |
7 | 6043 When {trans} is non-zero, transparent items are reduced to the |
1621 | 6044 item that they reveal. This is useful when wanting to know |
7 | 6045 the effective color. When {trans} is zero, the transparent |
6046 item is returned. This is useful when wanting to know which | |
6047 syntax item is effective (e.g. inside parens). | |
6048 Warning: This function can be very slow. Best speed is | |
6049 obtained by going through the file in forward direction. | |
6050 | |
6051 Example (echoes the name of the syntax item under the cursor): > | |
6052 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
6053 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6054 |
7 | 6055 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
6056 The result is a String, which is the {what} attribute of | |
6057 syntax ID {synID}. This can be used to obtain information | |
6058 about a syntax item. | |
6059 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 6060 for that mode. When {mode} is omitted, or an invalid value is |
7 | 6061 used, the attributes for the currently active highlighting are |
6062 used (GUI, cterm or term). | |
6063 Use synIDtrans() to follow linked highlight groups. | |
6064 {what} result | |
6065 "name" the name of the syntax item | |
6066 "fg" foreground color (GUI: color name used to set | |
6067 the color, cterm: color number as a string, | |
6068 term: empty string) | |
1755 | 6069 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6070 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6071 |highlight-font| |
1755 | 6072 "sp" special color (as with "fg") |highlight-guisp| |
7 | 6073 "fg#" like "fg", but for the GUI and the GUI is |
6074 running the name in "#RRGGBB" form | |
6075 "bg#" like "fg#" for "bg" | |
1755 | 6076 "sp#" like "fg#" for "sp" |
7 | 6077 "bold" "1" if bold |
6078 "italic" "1" if italic | |
6079 "reverse" "1" if reverse | |
6080 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6081 "standout" "1" if standout |
7 | 6082 "underline" "1" if underlined |
205 | 6083 "undercurl" "1" if undercurled |
7 | 6084 |
6085 Example (echoes the color of the syntax item under the | |
6086 cursor): > | |
6087 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
6088 < | |
6089 synIDtrans({synID}) *synIDtrans()* | |
6090 The result is a Number, which is the translated syntax ID of | |
6091 {synID}. This is the syntax group ID of what is being used to | |
6092 highlight the character. Highlight links given with | |
6093 ":highlight link" are followed. | |
6094 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6095 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6096 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
|
6097 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
|
6098 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
|
6099 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
|
6100 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
|
6101 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6102 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
|
6103 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6104 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
|
6105 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6106 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6107 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6108 |
1500 | 6109 synstack({lnum}, {col}) *synstack()* |
6110 Return a |List|, which is the stack of syntax items at the | |
6111 position {lnum} and {col} in the current window. Each item in | |
6112 the List is an ID like what |synID()| returns. | |
6113 The first item in the List is the outer region, following are | |
6114 items contained in that one. The last one is what |synID()| | |
6115 returns, unless not the whole item is highlighted or it is a | |
6116 transparent item. | |
6117 This function is useful for debugging a syntax file. | |
6118 Example that shows the syntax stack under the cursor: > | |
6119 for id in synstack(line("."), col(".")) | |
6120 echo synIDattr(id, "name") | |
6121 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6122 < 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
|
6123 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6124 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
|
6125 valid positions. |
1500 | 6126 |
24 | 6127 system({expr} [, {input}]) *system()* *E677* |
5808 | 6128 Get the output of the shell command {expr} as a string. See |
6129 |systemlist()| to get the output as a List. | |
5806 | 6130 |
6131 When {input} is given and is a string this string is written | |
6132 to a file and passed as stdin to the command. The string is | |
6133 written as-is, you need to take care of using the correct line | |
6134 separators yourself. | |
6135 If {input} is given and is a |List| it is written to the file | |
6136 in a way |writefile()| does with {binary} set to "b" (i.e. | |
6137 with a newline between each list item with newlines inside | |
6138 list items converted to NULs). | |
6139 Pipes are not used. | |
6140 | |
6183 | 6141 When prepended by |:silent| the shell will not be set to |
6142 cooked mode. This is meant to be used for commands that do | |
6143 not need the user to type. It avoids stray characters showing | |
6144 up on the screen which require |CTRL-L| to remove. > | |
6145 :silent let f = system('ls *.vim') | |
6146 < | |
5690 | 6147 Note: Use |shellescape()| or |::S| with |expand()| or |
6148 |fnamemodify()| to escape special characters in a command | |
6149 argument. Newlines in {expr} may cause the command to fail. | |
6150 The characters in 'shellquote' and 'shellxquote' may also | |
6151 cause trouble. | |
7 | 6152 This is not to be used for interactive commands. |
1661 | 6153 |
7 | 6154 The result is a String. Example: > |
1661 | 6155 :let files = system("ls " . shellescape(expand('%:h'))) |
5690 | 6156 :let files = system('ls ' . expand('%:h:S')) |
7 | 6157 |
6158 < To make the result more system-independent, the shell output | |
6159 is filtered to replace <CR> with <NL> for Macintosh, and | |
6160 <CR><NL> with <NL> for DOS-like systems. | |
5277 | 6161 To avoid the string being truncated at a NUL, all NUL |
6162 characters are replaced with SOH (0x01). | |
6163 | |
7 | 6164 The command executed is constructed using several options: |
6165 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
6166 ({tmp} is an automatically generated file name). | |
6167 For Unix and OS/2 braces are put around {expr} to allow for | |
6168 concatenated commands. | |
6169 | |
794 | 6170 The command will be executed in "cooked" mode, so that a |
6171 CTRL-C will interrupt the command (on Unix at least). | |
6172 | |
7 | 6173 The resulting error code can be found in |v:shell_error|. |
6174 This function will fail in |restricted-mode|. | |
625 | 6175 |
6176 Note that any wrong value in the options mentioned above may | |
6177 make the function fail. It has also been reported to fail | |
6178 when using a security agent application. | |
7 | 6179 Unlike ":!cmd" there is no automatic check for changed files. |
6180 Use |:checktime| to force a check. | |
6181 | |
205 | 6182 |
5808 | 6183 systemlist({expr} [, {input}]) *systemlist()* |
6184 Same as |system()|, but returns a |List| with lines (parts of | |
6185 output separated by NL) with NULs transformed into NLs. Output | |
6186 is the same as |readfile()| will output with {binary} argument | |
6187 set to "b". | |
6188 | |
6189 Returns an empty string on error, so be careful not to run | |
6190 into |E706|. | |
6191 | |
6192 | |
677 | 6193 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 6194 The result is a |List|, where each item is the number of the |
677 | 6195 buffer associated with each window in the current tab page. |
6196 {arg} specifies the number of tab page to be used. When | |
6197 omitted the current tab page is used. | |
6198 When {arg} is invalid the number zero is returned. | |
6199 To get a list of all buffers in all tabs use this: > | |
3445 | 6200 let buflist = [] |
677 | 6201 for i in range(tabpagenr('$')) |
3445 | 6202 call extend(buflist, tabpagebuflist(i + 1)) |
677 | 6203 endfor |
6204 < Note that a buffer may appear in more than one window. | |
6205 | |
6206 | |
6207 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 6208 The result is a Number, which is the number of the current |
6209 tab page. The first tab page has number 1. | |
6210 When the optional argument is "$", the number of the last tab | |
6211 page is returned (the tab page count). | |
6212 The number can be used with the |:tab| command. | |
6213 | |
6214 | |
5763 | 6215 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6216 Like |winnr()| but for tab page {tabarg}. |
677 | 6217 {tabarg} specifies the number of tab page to be used. |
6218 {arg} is used like with |winnr()|: | |
6219 - When omitted the current window number is returned. This is | |
6220 the window which will be used when going to this tab page. | |
6221 - When "$" the number of windows is returned. | |
6222 - When "#" the previous window nr is returned. | |
6223 Useful examples: > | |
6224 tabpagewinnr(1) " current window of tab page 1 | |
6225 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
6226 < When {tabarg} is invalid zero is returned. | |
6227 | |
805 | 6228 *tagfiles()* |
6229 tagfiles() Returns a |List| with the file names used to search for tags | |
6230 for the current buffer. This is the 'tags' option expanded. | |
6231 | |
6232 | |
205 | 6233 taglist({expr}) *taglist()* |
6234 Returns a list of tags matching the regular expression {expr}. | |
438 | 6235 Each list item is a dictionary with at least the following |
6236 entries: | |
648 | 6237 name Name of the tag. |
6238 filename Name of the file where the tag is | |
1156 | 6239 defined. It is either relative to the |
6240 current directory or a full path. | |
205 | 6241 cmd Ex command used to locate the tag in |
6242 the file. | |
648 | 6243 kind Type of the tag. The value for this |
205 | 6244 entry depends on the language specific |
1156 | 6245 kind values. Only available when |
6246 using a tags file generated by | |
6247 Exuberant ctags or hdrtag. | |
648 | 6248 static A file specific tag. Refer to |
205 | 6249 |static-tag| for more information. |
1156 | 6250 More entries may be present, depending on the content of the |
6251 tags file: access, implementation, inherits and signature. | |
6252 Refer to the ctags documentation for information about these | |
6253 fields. For C code the fields "struct", "class" and "enum" | |
6254 may appear, they give the name of the entity the tag is | |
6255 contained in. | |
452 | 6256 |
216 | 6257 The ex-command 'cmd' can be either an ex search pattern, a |
6258 line number or a line number followed by a byte number. | |
205 | 6259 |
6260 If there are no matching tags, then an empty list is returned. | |
6261 | |
6262 To get an exact tag match, the anchors '^' and '$' should be | |
4073 | 6263 used in {expr}. This also make the function work faster. |
6264 Refer to |tag-regexp| for more information about the tag | |
6265 search regular expression pattern. | |
205 | 6266 |
6267 Refer to |'tags'| for information about how the tags file is | |
6268 located by Vim. Refer to |tags-file-format| for the format of | |
6269 the tags file generated by the different ctags tools. | |
6270 | |
7 | 6271 tempname() *tempname()* *temp-file-name* |
6272 The result is a String, which is the name of a file that | |
1621 | 6273 doesn't exist. It can be used for a temporary file. The name |
7 | 6274 is different for at least 26 consecutive calls. Example: > |
6275 :let tmpfile = tempname() | |
6276 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6277 < For Unix, the file will be in a private directory |tempfile|. |
7 | 6278 For MS-Windows forward slashes are used when the 'shellslash' |
6279 option is set or when 'shellcmdflag' starts with '-'. | |
6280 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6281 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6282 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6283 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
|
6284 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6285 {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
|
6286 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6287 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6288 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6289 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6290 < -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
|
6291 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6292 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6293 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6294 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6295 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
|
6296 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6297 {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
|
6298 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6299 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6300 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6301 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6302 < -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
|
6303 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6304 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6305 |
7 | 6306 tolower({expr}) *tolower()* |
6307 The result is a copy of the String given, with all uppercase | |
6308 characters turned into lowercase (just like applying |gu| to | |
6309 the string). | |
6310 | |
6311 toupper({expr}) *toupper()* | |
6312 The result is a copy of the String given, with all lowercase | |
6313 characters turned into uppercase (just like applying |gU| to | |
6314 the string). | |
6315 | |
15 | 6316 tr({src}, {fromstr}, {tostr}) *tr()* |
6317 The result is a copy of the {src} string with all characters | |
6318 which appear in {fromstr} replaced by the character in that | |
6319 position in the {tostr} string. Thus the first character in | |
6320 {fromstr} is translated into the first character in {tostr} | |
6321 and so on. Exactly like the unix "tr" command. | |
6322 This code also deals with multibyte characters properly. | |
6323 | |
6324 Examples: > | |
6325 echo tr("hello there", "ht", "HT") | |
6326 < returns "Hello THere" > | |
6327 echo tr("<blob>", "<>", "{}") | |
6328 < returns "{blob}" | |
6329 | |
1621 | 6330 trunc({expr}) *trunc()* |
1668 | 6331 Return the largest integral value with magnitude less than or |
1621 | 6332 equal to {expr} as a |Float| (truncate towards zero). |
6333 {expr} must evaluate to a |Float| or a |Number|. | |
6334 Examples: > | |
6335 echo trunc(1.456) | |
6336 < 1.0 > | |
6337 echo trunc(-5.456) | |
6338 < -5.0 > | |
6339 echo trunc(4.0) | |
6340 < 4.0 | |
6341 {only available when compiled with the |+float| feature} | |
6342 | |
87 | 6343 *type()* |
6344 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 6345 Number: 0 |
6346 String: 1 | |
6347 Funcref: 2 | |
6348 List: 3 | |
6349 Dictionary: 4 | |
1621 | 6350 Float: 5 |
153 | 6351 To avoid the magic numbers it should be used this way: > |
87 | 6352 :if type(myvar) == type(0) |
6353 :if type(myvar) == type("") | |
6354 :if type(myvar) == type(function("tr")) | |
6355 :if type(myvar) == type([]) | |
153 | 6356 :if type(myvar) == type({}) |
1621 | 6357 :if type(myvar) == type(0.0) |
7 | 6358 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6359 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6360 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
|
6361 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
|
6362 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
|
6363 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6364 {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
|
6365 is used internally. |
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6366 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
|
6367 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
|
6368 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6369 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
|
6370 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6371 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6372 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6373 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
|
6374 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6375 "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
|
6376 "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
|
6377 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
|
6378 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
|
6379 "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
|
6380 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
|
6381 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6382 "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
|
6383 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6384 "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
|
6385 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6386 "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
|
6387 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
|
6388 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6389 "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
|
6390 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6391 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6392 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
|
6393 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
|
6394 "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
|
6395 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6396 "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
|
6397 |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
|
6398 "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
|
6399 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
|
6400 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
|
6401 "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
|
6402 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
|
6403 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
|
6404 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
|
6405 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
|
6406 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6407 "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
|
6408 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
|
6409 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
|
6410 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6411 "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
|
6412 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
|
6413 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6414 |
5747 | 6415 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
6416 Remove second and succeeding copies of repeated adjacent | |
6417 {list} items in-place. Returns {list}. If you want a list | |
6418 to remain unmodified make a copy first: > | |
6419 :let newlist = uniq(copy(mylist)) | |
6420 < The default compare function uses the string representation of | |
6421 each item. For the use of {func} and {dict} see |sort()|. | |
6422 | |
140 | 6423 values({dict}) *values()* |
1621 | 6424 Return a |List| with all the values of {dict}. The |List| is |
685 | 6425 in arbitrary order. |
140 | 6426 |
6427 | |
7 | 6428 virtcol({expr}) *virtcol()* |
6429 The result is a Number, which is the screen column of the file | |
6430 position given with {expr}. That is, the last screen position | |
6431 occupied by the character at that position, when the screen | |
6432 would be of unlimited width. When there is a <Tab> at the | |
6433 position, the returned Number will be the column at the end of | |
6434 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
3445 | 6435 set to 8, it returns 8. |conceal| is ignored. |
1317 | 6436 For the byte position use |col()|. |
6437 For the use of {expr} see |col()|. | |
6438 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 6439 "off" is the offset in screen columns from the start of the |
1266 | 6440 character. E.g., a position within a <Tab> or after the last |
2965 | 6441 character. When "off" is omitted zero is used. |
7 | 6442 When Virtual editing is active in the current mode, a position |
6443 beyond the end of the line can be returned. |'virtualedit'| | |
6444 The accepted positions are: | |
6445 . the cursor position | |
6446 $ the end of the cursor line (the result is the | |
6447 number of displayed characters in the cursor line | |
6448 plus one) | |
6449 'x position of mark x (if the mark is not set, 0 is | |
6450 returned) | |
6447 | 6451 v In Visual mode: the start of the Visual area (the |
6452 cursor is the end). When not in Visual mode | |
6453 returns the cursor position. Differs from |'<| in | |
6454 that it's updated right away. | |
7 | 6455 Note that only marks in the current file can be used. |
6456 Examples: > | |
6457 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
6458 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 6459 virtcol("'t") with text " there", with 't at 'h', returns 6 |
6460 < The first column is 1. 0 is returned for an error. | |
1156 | 6461 A more advanced example that echoes the maximum length of |
6462 all lines: > | |
6463 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
6464 | |
7 | 6465 |
6466 visualmode([expr]) *visualmode()* | |
6467 The result is a String, which describes the last Visual mode | |
856 | 6468 used in the current buffer. Initially it returns an empty |
6469 string, but once Visual mode has been used, it returns "v", | |
6470 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
6471 character-wise, line-wise, or block-wise Visual mode | |
6472 respectively. | |
7 | 6473 Example: > |
6474 :exe "normal " . visualmode() | |
6475 < This enters the same Visual mode as before. It is also useful | |
6476 in scripts if you wish to act differently depending on the | |
6477 Visual mode that was used. | |
1621 | 6478 If Visual mode is active, use |mode()| to get the Visual mode |
6479 (e.g., in a |:vmap|). | |
1661 | 6480 *non-zero-arg* |
6481 If [expr] is supplied and it evaluates to a non-zero Number or | |
6482 a non-empty String, then the Visual mode will be cleared and | |
1621 | 6483 the old value is returned. Note that " " and "0" are also |
1661 | 6484 non-empty strings, thus cause the mode to be cleared. A List, |
6485 Dictionary or Float is not a Number or String, thus does not | |
6486 cause the mode to be cleared. | |
7 | 6487 |
4151 | 6488 wildmenumode() *wildmenumode()* |
6489 Returns non-zero when the wildmenu is active and zero | |
6490 otherwise. See 'wildmenu' and 'wildmode'. | |
6491 This can be used in mappings to handle the 'wildcharm' option | |
6492 gracefully. (Makes only sense with |mapmode-c| mappings). | |
6493 | |
6494 For example to make <c-j> work like <down> in wildmode, use: > | |
6495 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
6496 < | |
6497 (Note, this needs the 'wildcharm' option set appropriately). | |
6498 | |
6499 | |
7 | 6500 *winbufnr()* |
6501 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 6502 associated with window {nr}. When {nr} is zero, the number of |
7 | 6503 the buffer in the current window is returned. When window |
6504 {nr} doesn't exist, -1 is returned. | |
6505 Example: > | |
6506 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
6507 < | |
6508 *wincol()* | |
6509 wincol() The result is a Number, which is the virtual column of the | |
6510 cursor in the window. This is counting screen cells from the | |
6511 left side of the window. The leftmost column is one. | |
6512 | |
6513 winheight({nr}) *winheight()* | |
6514 The result is a Number, which is the height of window {nr}. | |
6515 When {nr} is zero, the height of the current window is | |
6516 returned. When window {nr} doesn't exist, -1 is returned. | |
6517 An existing window always has a height of zero or more. | |
6518 Examples: > | |
6519 :echo "The current window has " . winheight(0) . " lines." | |
6520 < | |
6521 *winline()* | |
6522 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 6523 in the window. This is counting screen lines from the top of |
7 | 6524 the window. The first line is one. |
531 | 6525 If the cursor was moved the view on the file will be updated |
6526 first, this may cause a scroll. | |
7 | 6527 |
6528 *winnr()* | |
20 | 6529 winnr([{arg}]) The result is a Number, which is the number of the current |
6530 window. The top window has number 1. | |
6531 When the optional argument is "$", the number of the | |
3967 | 6532 last window is returned (the window count). > |
6533 let window_count = winnr('$') | |
6534 < When the optional argument is "#", the number of the last | |
20 | 6535 accessed window is returned (where |CTRL-W_p| goes to). |
1156 | 6536 If there is no previous window or it is in another tab page 0 |
6537 is returned. | |
20 | 6538 The number can be used with |CTRL-W_w| and ":wincmd w" |
6539 |:wincmd|. | |
1156 | 6540 Also see |tabpagewinnr()|. |
7 | 6541 |
6542 *winrestcmd()* | |
6543 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
6544 the current window sizes. Only works properly when no windows | |
712 | 6545 are opened or closed and the current window and tab page is |
6546 unchanged. | |
7 | 6547 Example: > |
6548 :let cmd = winrestcmd() | |
6549 :call MessWithWindowSizes() | |
6550 :exe cmd | |
712 | 6551 < |
6552 *winrestview()* | |
6553 winrestview({dict}) | |
6554 Uses the |Dictionary| returned by |winsaveview()| to restore | |
6555 the view of the current window. | |
5940 | 6556 Note: The {dict} does not have to contain all values, that are |
6557 returned by |winsaveview()|. If values are missing, those | |
6558 settings won't be restored. So you can use: > | |
6559 :call winrestview({'curswant': 4}) | |
6560 < | |
6561 This will only set the curswant value (the column the cursor | |
6562 wants to move on vertical movements) of the cursor to column 5 | |
6563 (yes, that is 5), while all other settings will remain the | |
6564 same. This is useful, if you set the cursor position manually. | |
6565 | |
712 | 6566 If you have changed the values the result is unpredictable. |
6567 If the window size changed the result won't be the same. | |
6568 | |
6569 *winsaveview()* | |
6570 winsaveview() Returns a |Dictionary| that contains information to restore | |
6571 the view of the current window. Use |winrestview()| to | |
6572 restore the view. | |
6573 This is useful if you have a mapping that jumps around in the | |
6574 buffer and you want to go back to the original view. | |
6575 This does not save fold information. Use the 'foldenable' | |
798 | 6576 option to temporarily switch off folding, so that folds are |
6070
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
6051
diff
changeset
|
6577 not opened when moving around. This may have side effects. |
712 | 6578 The return value includes: |
6579 lnum cursor line number | |
5940 | 6580 col cursor column (Note: the first column |
6581 zero, as opposed to what getpos() | |
6582 returns) | |
712 | 6583 coladd cursor column offset for 'virtualedit' |
6584 curswant column for vertical movement | |
6585 topline first line in the window | |
6586 topfill filler lines, only in diff mode | |
6587 leftcol first column displayed | |
6588 skipcol columns skipped | |
6589 Note that no option values are saved. | |
6590 | |
7 | 6591 |
6592 winwidth({nr}) *winwidth()* | |
6593 The result is a Number, which is the width of window {nr}. | |
6594 When {nr} is zero, the width of the current window is | |
6595 returned. When window {nr} doesn't exist, -1 is returned. | |
6596 An existing window always has a width of zero or more. | |
6597 Examples: > | |
6598 :echo "The current window has " . winwidth(0) . " columns." | |
6599 :if winwidth(0) <= 50 | |
6600 : exe "normal 50\<C-W>|" | |
6601 :endif | |
6602 < | |
158 | 6603 *writefile()* |
6341 | 6604 writefile({list}, {fname} [, {flags}]) |
685 | 6605 Write |List| {list} to file {fname}. Each list item is |
158 | 6606 separated with a NL. Each list item must be a String or |
6607 Number. | |
6341 | 6608 When {flags} contains "b" then binary mode is used: There will |
158 | 6609 not be a NL after the last list item. An empty item at the |
6610 end does cause the last line in the file to end in a NL. | |
6341 | 6611 |
6612 When {flags} contains "a" then append mode is used, lines are | |
6613 append to the file: > | |
6614 :call writefile(["foo"], "event.log", "a") | |
6615 :call writefile(["bar"], "event.log", "a") | |
6616 > | |
6617 < All NL characters are replaced with a NUL character. | |
158 | 6618 Inserting CR characters needs to be done before passing {list} |
6619 to writefile(). | |
6620 An existing file is overwritten, if possible. | |
6621 When the write fails -1 is returned, otherwise 0. There is an | |
6622 error message if the file can't be created or when writing | |
6623 fails. | |
6624 Also see |readfile()|. | |
6625 To copy a file byte for byte: > | |
6626 :let fl = readfile("foo", "b") | |
6627 :call writefile(fl, "foocopy", "b") | |
3214 | 6628 |
6629 | |
6630 xor({expr}, {expr}) *xor()* | |
6631 Bitwise XOR on the two arguments. The arguments are converted | |
6632 to a number. A List, Dict or Float argument causes an error. | |
6633 Example: > | |
6634 :let bits = xor(bits, 0x80) | |
3256 | 6635 < |
3214 | 6636 |
7 | 6637 |
6638 *feature-list* | |
6009 | 6639 There are four types of features: |
7 | 6640 1. Features that are only supported when they have been enabled when Vim |
6641 was compiled |+feature-list|. Example: > | |
6642 :if has("cindent") | |
6643 2. Features that are only supported when certain conditions have been met. | |
6644 Example: > | |
6645 :if has("gui_running") | |
6646 < *has-patch* | |
5814 | 6647 3. Included patches. The "patch123" feature means that patch 123 has been |
6648 included. Note that this form does not check the version of Vim, you need | |
6649 to inspect |v:version| for that. | |
6650 Example (checking version 6.2.148 or later): > | |
7 | 6651 :if v:version > 602 || v:version == 602 && has("patch148") |
5814 | 6652 < Note that it's possible for patch 147 to be omitted even though 148 is |
6653 included. | |
6654 | |
6655 4. Beyond a certain version or at a certain version and including a specific | |
5862 | 6656 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
6657 later, or it is version 7.4 and patch 237 was included. | |
6658 Note that this only works for patch 7.4.237 and later, before that you | |
6659 need to use the example above that checks v:version. Example: > | |
6660 :if has("patch-7.4.248") | |
5814 | 6661 < Note that it's possible for patch 147 to be omitted even though 148 is |
1156 | 6662 included. |
7 | 6663 |
5340 | 6664 acl Compiled with |ACL| support. |
7 | 6665 all_builtin_terms Compiled with all builtin terminals enabled. |
6666 amiga Amiga version of Vim. | |
6667 arabic Compiled with Arabic support |Arabic|. | |
6668 arp Compiled with ARP support (Amiga). | |
613 | 6669 autocmd Compiled with autocommand support. |autocommand| |
7 | 6670 balloon_eval Compiled with |balloon-eval| support. |
435 | 6671 balloon_multiline GUI supports multiline balloons. |
7 | 6672 beos BeOS version of Vim. |
6673 browse Compiled with |:browse| support, and browse() will | |
6674 work. | |
3682 | 6675 browsefilter Compiled with support for |browsefilter|. |
7 | 6676 builtin_terms Compiled with some builtin terminals. |
6677 byte_offset Compiled with support for 'o' in 'statusline' | |
6678 cindent Compiled with 'cindent' support. | |
6679 clientserver Compiled with remote invocation support |clientserver|. | |
6680 clipboard Compiled with 'clipboard' support. | |
6681 cmdline_compl Compiled with |cmdline-completion| support. | |
6682 cmdline_hist Compiled with |cmdline-history| support. | |
6683 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
6684 comments Compiled with |'comments'| support. | |
2681 | 6685 compatible Compiled to be very Vi compatible. |
7 | 6686 cryptv Compiled with encryption support |encryption|. |
6687 cscope Compiled with |cscope| support. | |
6688 debug Compiled with "DEBUG" defined. | |
6689 dialog_con Compiled with console dialog support. | |
6690 dialog_gui Compiled with GUI dialog support. | |
6691 diff Compiled with |vimdiff| and 'diff' support. | |
6692 digraphs Compiled with support for digraphs. | |
6110 | 6693 directx Compiled with support for Direct-X and 'renderoptions'. |
7 | 6694 dnd Compiled with support for the "~ register |quote_~|. |
2681 | 6695 dos16 16 bits DOS version of Vim. |
7 | 6696 dos32 32 bits DOS (DJGPP) version of Vim. |
6697 ebcdic Compiled on a machine with ebcdic character set. | |
6698 emacs_tags Compiled with support for Emacs tags. | |
6699 eval Compiled with expression evaluation support. Always | |
6700 true, of course! | |
6701 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
6702 extra_search Compiled with support for |'incsearch'| and | |
6703 |'hlsearch'| | |
6704 farsi Compiled with Farsi support |farsi|. | |
6705 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 6706 filterpipe When 'shelltemp' is off pipes are used for shell |
6707 read/write/filter commands | |
7 | 6708 find_in_path Compiled with support for include file searches |
6709 |+find_in_path|. | |
1621 | 6710 float Compiled with support for |Float|. |
7 | 6711 fname_case Case in file names matters (for Amiga, MS-DOS, and |
6712 Windows this is not present). | |
6713 folding Compiled with |folding| support. | |
6714 footer Compiled with GUI footer support. |gui-footer| | |
6715 fork Compiled to use fork()/exec() instead of system(). | |
6716 gettext Compiled with message translation |multi-lang| | |
6717 gui Compiled with GUI enabled. | |
6718 gui_athena Compiled with Athena GUI. | |
2681 | 6719 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 6720 gui_gtk Compiled with GTK+ GUI (any version). |
6721 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
6722 gui_mac Compiled with Macintosh GUI. | |
6723 gui_motif Compiled with Motif GUI. | |
6724 gui_photon Compiled with Photon GUI. | |
2681 | 6725 gui_running Vim is running in the GUI, or it will start soon. |
7 | 6726 gui_win32 Compiled with MS Windows Win32 GUI. |
6727 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
6728 hangul_input Compiled with Hangul input support. |hangul| | |
6729 iconv Can use iconv() for conversion. | |
6730 insert_expand Compiled with support for CTRL-X expansion commands in | |
6731 Insert mode. | |
6732 jumplist Compiled with |jumplist| support. | |
6733 keymap Compiled with 'keymap' support. | |
6734 langmap Compiled with 'langmap' support. | |
6735 libcall Compiled with |libcall()| support. | |
5995 | 6736 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
6737 'breakindent' support. | |
7 | 6738 lispindent Compiled with support for lisp indenting. |
6739 listcmds Compiled with commands for the buffer list |:files| | |
6740 and the argument list |arglist|. | |
6741 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
|
6742 lua Compiled with Lua interface |Lua|. |
7 | 6743 mac Macintosh version of Vim. |
6744 macunix Macintosh version of Vim, using Unix files (OS-X). | |
6745 menu Compiled with support for |:menu|. | |
6746 mksession Compiled with support for |:mksession|. | |
6747 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
6748 mouse Compiled with support mouse. | |
6749 mouse_dec Compiled with support for Dec terminal mouse. | |
6750 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
6751 mouse_netterm Compiled with support for netterm mouse. | |
6752 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 6753 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3750 | 6754 mouse_sgr Compiled with support for sgr mouse. |
3224 | 6755 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 6756 mouse_xterm Compiled with support for xterm mouse. |
2681 | 6757 mouseshape Compiled with support for 'mouseshape'. |
1768 | 6758 multi_byte Compiled with support for 'encoding' |
6759 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 6760 multi_byte_ime Compiled with support for IME input method. |
6761 multi_lang Compiled with support for multiple languages. | |
14 | 6762 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 6763 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 6764 netbeans_intg Compiled with support for |netbeans|. |
6765 ole Compiled with OLE automation support for Win32. | |
6766 os2 OS/2 version of Vim. | |
6767 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
6768 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
|
6769 persistent_undo Compiled with support for persistent undo history. |
7 | 6770 postscript Compiled with PostScript file printing. |
6771 printer Compiled with |:hardcopy| support. | |
170 | 6772 profile Compiled with |:profile| support. |
2826 | 6773 python Compiled with Python 2.x interface. |has-python| |
6774 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 6775 qnx QNX version of Vim. |
6776 quickfix Compiled with |quickfix| support. | |
857 | 6777 reltime Compiled with |reltime()| support. |
7 | 6778 rightleft Compiled with 'rightleft' support. |
6779 ruby Compiled with Ruby interface |ruby|. | |
6780 scrollbind Compiled with 'scrollbind' support. | |
6781 showcmd Compiled with 'showcmd' support. | |
6782 signs Compiled with |:sign| support. | |
6783 smartindent Compiled with 'smartindent' support. | |
9 | 6784 sniff Compiled with SNiFF interface support. |
2681 | 6785 spell Compiled with spell checking support |spell|. |
1989 | 6786 startuptime Compiled with |--startuptime| support. |
7 | 6787 statusline Compiled with support for 'statusline', 'rulerformat' |
6788 and special formats of 'titlestring' and 'iconstring'. | |
6789 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 6790 syntax Compiled with syntax highlighting support |syntax|. |
7 | 6791 syntax_items There are active syntax highlighting items for the |
6792 current buffer. | |
6793 system Compiled to use system() instead of fork()/exec(). | |
6794 tag_binary Compiled with binary searching in tags files | |
6795 |tag-binary-search|. | |
6796 tag_old_static Compiled with support for old static tags | |
6797 |tag-old-static|. | |
6798 tag_any_white Compiled with support for any white characters in tags | |
6799 files |tag-any-white|. | |
6800 tcl Compiled with Tcl interface. | |
6801 terminfo Compiled with terminfo instead of termcap. | |
6802 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
6803 textobjects Compiled with support for |text-objects|. | |
6804 tgetent Compiled with tgetent support, able to use a termcap | |
6805 or terminfo file. | |
6806 title Compiled with window title support |'title'|. | |
6807 toolbar Compiled with support for |gui-toolbar|. | |
6808 unix Unix version of Vim. | |
6809 user_commands User-defined commands. | |
2681 | 6810 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 6811 vim_starting True while initial source'ing takes place. |startup| |
2681 | 6812 viminfo Compiled with viminfo support. |
7 | 6813 virtualedit Compiled with 'virtualedit' option. |
6814 visual Compiled with Visual mode. | |
6815 visualextra Compiled with extra Visual mode commands. | |
6816 |blockwise-operators|. | |
6817 vms VMS version of Vim. | |
6818 vreplace Compiled with |gR| and |gr| commands. | |
6819 wildignore Compiled with 'wildignore' option. | |
6820 wildmenu Compiled with 'wildmenu' option. | |
6821 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
|
6822 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
|
6823 64 bits) |
2681 | 6824 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 6825 win64 Win64 version of Vim (MS-Windows 64 bit). |
6826 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 6827 winaltkeys Compiled with 'winaltkeys' option. |
6828 windows Compiled with support for more than one window. | |
7 | 6829 writebackup Compiled with 'writebackup' default on. |
6830 xfontset Compiled with X fontset support |xfontset|. | |
6831 xim Compiled with X input method support |xim|. | |
5340 | 6832 xpm Compiled with pixmap support. |
6833 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
6834 backward compatibility. Use "xpm" instead.) | |
7 | 6835 xsmp Compiled with X session management support. |
6836 xsmp_interact Compiled with interactive X session management support. | |
6837 xterm_clipboard Compiled with support for xterm clipboard. | |
6838 xterm_save Compiled with support for saving and restoring the | |
6839 xterm screen. | |
6840 x11 Compiled with X11 support. | |
6841 | |
6842 *string-match* | |
6843 Matching a pattern in a String | |
6844 | |
6845 A regexp pattern as explained at |pattern| is normally used to find a match in | |
6846 the buffer lines. When a pattern is used to find a match in a String, almost | |
6847 everything works in the same way. The difference is that a String is handled | |
6848 like it is one line. When it contains a "\n" character, this is not seen as a | |
6849 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
6850 with ".". Example: > | |
6851 :let a = "aaaa\nxxxx" | |
6852 :echo matchstr(a, "..\n..") | |
6853 aa | |
6854 xx | |
6855 :echo matchstr(a, "a.x") | |
6856 a | |
6857 x | |
6858 | |
6859 Don't forget that "^" will only match at the first character of the String and | |
6860 "$" at the last character of the string. They don't match after or before a | |
6861 "\n". | |
6862 | |
6863 ============================================================================== | |
6864 5. Defining functions *user-functions* | |
6865 | |
6866 New functions can be defined. These can be called just like builtin | |
6867 functions. The function executes a sequence of Ex commands. Normal mode | |
6868 commands can be executed with the |:normal| command. | |
6869 | |
6870 The function name must start with an uppercase letter, to avoid confusion with | |
6871 builtin functions. To prevent from using the same name in different scripts | |
6872 avoid obvious, short names. A good habit is to start the function name with | |
6873 the name of the script, e.g., "HTMLcolor()". | |
6874 | |
504 | 6875 It's also possible to use curly braces, see |curly-braces-names|. And the |
6876 |autoload| facility is useful to define a function only when it's called. | |
7 | 6877 |
6878 *local-function* | |
6879 A function local to a script must start with "s:". A local script function | |
6880 can only be called from within the script and from functions, user commands | |
6881 and autocommands defined in the script. It is also possible to call the | |
1698 | 6882 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 6883 instead of "s:" when the mapping is expanded outside of the script. |
5862 | 6884 There are only script-local functions, no buffer-local or window-local |
6885 functions. | |
7 | 6886 |
6887 *:fu* *:function* *E128* *E129* *E123* | |
6888 :fu[nction] List all functions and their arguments. | |
6889 | |
6890 :fu[nction] {name} List function {name}. | |
685 | 6891 {name} can also be a |Dictionary| entry that is a |
6892 |Funcref|: > | |
114 | 6893 :function dict.init |
504 | 6894 |
6895 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
6896 Example that lists all functions ending with "File": > | |
6897 :function /File$ | |
482 | 6898 < |
6899 *:function-verbose* | |
6900 When 'verbose' is non-zero, listing a function will also display where it was | |
6901 last defined. Example: > | |
6902 | |
6903 :verbose function SetFileTypeSH | |
6904 function SetFileTypeSH(name) | |
6905 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
6906 < | |
484 | 6907 See |:verbose-cmd| for more information. |
482 | 6908 |
5862 | 6909 *E124* *E125* *E853* *E884* |
102 | 6910 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 6911 Define a new function by the name {name}. The name |
6912 must be made of alphanumeric characters and '_', and | |
5862 | 6913 must start with a capital or "s:" (see above). Note |
6914 that using "b:" or "g:" is not allowed. (since patch | |
6915 7.4.260 E884 is given if the function name has a colon | |
6916 in the name, e.g. for "foo:bar()". Before that patch | |
6917 no error was given). | |
114 | 6918 |
685 | 6919 {name} can also be a |Dictionary| entry that is a |
6920 |Funcref|: > | |
114 | 6921 :function dict.init(arg) |
1621 | 6922 < "dict" must be an existing dictionary. The entry |
114 | 6923 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 6924 is required to overwrite an existing function. The |
114 | 6925 result is a |Funcref| to a numbered function. The |
6926 function can only be used with a |Funcref| and will be | |
6927 deleted if there are no more references to it. | |
7 | 6928 *E127* *E122* |
6929 When a function by this name already exists and [!] is | |
6930 not used an error message is given. When [!] is used, | |
6931 an existing function is silently replaced. Unless it | |
6932 is currently being executed, that is an error. | |
133 | 6933 |
6934 For the {arguments} see |function-argument|. | |
6935 | |
5618 | 6936 *:func-range* *a:firstline* *a:lastline* |
7 | 6937 When the [range] argument is added, the function is |
6938 expected to take care of a range itself. The range is | |
6939 passed as "a:firstline" and "a:lastline". If [range] | |
6940 is excluded, ":{range}call" will call the function for | |
6941 each line in the range, with the cursor on the start | |
6942 of each line. See |function-range-example|. | |
3967 | 6943 The cursor is still moved to the first line of the |
6944 range, as is the case with all Ex commands. | |
5618 | 6945 *:func-abort* |
7 | 6946 When the [abort] argument is added, the function will |
6947 abort as soon as an error is detected. | |
5618 | 6948 *:func-dict* |
102 | 6949 When the [dict] argument is added, the function must |
1621 | 6950 be invoked through an entry in a |Dictionary|. The |
102 | 6951 local variable "self" will then be set to the |
6952 dictionary. See |Dictionary-function|. | |
7 | 6953 |
1621 | 6954 *function-search-undo* |
653 | 6955 The last used search pattern and the redo command "." |
1621 | 6956 will not be changed by the function. This also |
6957 implies that the effect of |:nohlsearch| is undone | |
6958 when the function returns. | |
653 | 6959 |
7 | 6960 *:endf* *:endfunction* *E126* *E193* |
6961 :endf[unction] The end of a function definition. Must be on a line | |
6962 by its own, without other commands. | |
6963 | |
6964 *:delf* *:delfunction* *E130* *E131* | |
6965 :delf[unction] {name} Delete function {name}. | |
685 | 6966 {name} can also be a |Dictionary| entry that is a |
6967 |Funcref|: > | |
114 | 6968 :delfunc dict.init |
1621 | 6969 < This will remove the "init" entry from "dict". The |
114 | 6970 function is deleted if there are no more references to |
6971 it. | |
7 | 6972 *:retu* *:return* *E133* |
6973 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
6974 evaluated and returned as the result of the function. | |
6975 If "[expr]" is not given, the number 0 is returned. | |
6976 When a function ends without an explicit ":return", | |
6977 the number 0 is returned. | |
6978 Note that there is no check for unreachable lines, | |
6979 thus there is no warning if commands follow ":return". | |
6980 | |
6981 If the ":return" is used after a |:try| but before the | |
6982 matching |:finally| (if present), the commands | |
6983 following the ":finally" up to the matching |:endtry| | |
6984 are executed first. This process applies to all | |
6985 nested ":try"s inside the function. The function | |
6986 returns at the outermost ":endtry". | |
6987 | |
133 | 6988 *function-argument* *a:var* |
1621 | 6989 An argument can be defined by giving its name. In the function this can then |
133 | 6990 be used as "a:name" ("a:" for argument). |
1156 | 6991 *a:0* *a:1* *a:000* *E740* *...* |
133 | 6992 Up to 20 arguments can be given, separated by commas. After the named |
6993 arguments an argument "..." can be specified, which means that more arguments | |
6994 may optionally be following. In the function the extra arguments can be used | |
6995 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 6996 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
6997 that "a:1" is the same as "a:000[0]". | |
148 | 6998 *E742* |
6999 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 7000 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 7001 Thus you can pass a |List| to a function and have the function add an item to |
7002 it. If you want to make sure the function cannot change a |List| or | |
7003 |Dictionary| use |:lockvar|. | |
133 | 7004 |
7005 When not using "...", the number of arguments in a function call must be equal | |
7006 to the number of named arguments. When using "...", the number of arguments | |
7007 may be larger. | |
7008 | |
7009 It is also possible to define a function without any arguments. You must | |
7010 still supply the () then. The body of the function follows in the next lines, | |
7011 until the matching |:endfunction|. It is allowed to define another function | |
7012 inside a function body. | |
7013 | |
7014 *local-variables* | |
7 | 7015 Inside a function variables can be used. These are local variables, which |
7016 will disappear when the function returns. Global variables need to be | |
7017 accessed with "g:". | |
7018 | |
7019 Example: > | |
7020 :function Table(title, ...) | |
7021 : echohl Title | |
7022 : echo a:title | |
7023 : echohl None | |
140 | 7024 : echo a:0 . " items:" |
7025 : for s in a:000 | |
7026 : echon ' ' . s | |
7027 : endfor | |
7 | 7028 :endfunction |
7029 | |
7030 This function can then be called with: > | |
140 | 7031 call Table("Table", "line1", "line2") |
7032 call Table("Empty Table") | |
7 | 7033 |
1156 | 7034 To return more than one value, return a |List|: > |
7035 :function Compute(n1, n2) | |
7 | 7036 : if a:n2 == 0 |
1156 | 7037 : return ["fail", 0] |
7 | 7038 : endif |
1156 | 7039 : return ["ok", a:n1 / a:n2] |
7 | 7040 :endfunction |
7041 | |
7042 This function can then be called with: > | |
1156 | 7043 :let [success, div] = Compute(102, 6) |
7 | 7044 :if success == "ok" |
7045 : echo div | |
7046 :endif | |
1156 | 7047 < |
786 | 7048 *:cal* *:call* *E107* *E117* |
7 | 7049 :[range]cal[l] {name}([arguments]) |
7050 Call a function. The name of the function and its arguments | |
7051 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 7052 used. The returned value is discarded. |
7 | 7053 Without a range and for functions that accept a range, the |
7054 function is called once. When a range is given the cursor is | |
7055 positioned at the start of the first line before executing the | |
7056 function. | |
7057 When a range is given and the function doesn't handle it | |
7058 itself, the function is executed for each line in the range, | |
7059 with the cursor in the first column of that line. The cursor | |
7060 is left at the last line (possibly moved by the last function | |
1621 | 7061 call). The arguments are re-evaluated for each line. Thus |
7 | 7062 this works: |
7063 *function-range-example* > | |
7064 :function Mynumber(arg) | |
7065 : echo line(".") . " " . a:arg | |
7066 :endfunction | |
7067 :1,5call Mynumber(getline(".")) | |
7068 < | |
7069 The "a:firstline" and "a:lastline" are defined anyway, they | |
7070 can be used to do something different at the start or end of | |
7071 the range. | |
7072 | |
7073 Example of a function that handles the range itself: > | |
7074 | |
7075 :function Cont() range | |
7076 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
7077 :endfunction | |
7078 :4,8call Cont() | |
7079 < | |
7080 This function inserts the continuation character "\" in front | |
7081 of all the lines in the range, except the first one. | |
7082 | |
1156 | 7083 When the function returns a composite value it can be further |
7084 dereferenced, but the range will not be used then. Example: > | |
7085 :4,8call GetDict().method() | |
7086 < Here GetDict() gets the range but method() does not. | |
7087 | |
7 | 7088 *E132* |
7089 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
7090 option. | |
7091 | |
161 | 7092 |
7093 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 7094 *autoload-functions* |
7095 When using many or large functions, it's possible to automatically define them | |
161 | 7096 only when they are used. There are two methods: with an autocommand and with |
7097 the "autoload" directory in 'runtimepath'. | |
7098 | |
7099 | |
7100 Using an autocommand ~ | |
7101 | |
170 | 7102 This is introduced in the user manual, section |41.14|. |
7103 | |
161 | 7104 The autocommand is useful if you have a plugin that is a long Vim script file. |
7105 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 7106 That makes Vim startup faster. The autocommand should then load the same file |
161 | 7107 again, setting a variable to skip the |:finish| command. |
7108 | |
7109 Use the FuncUndefined autocommand event with a pattern that matches the | |
7110 function(s) to be defined. Example: > | |
7 | 7111 |
7112 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
7113 | |
7114 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
7115 "BufNet". Also see |FuncUndefined|. | |
7116 | |
161 | 7117 |
7118 Using an autoload script ~ | |
168 | 7119 *autoload* *E746* |
170 | 7120 This is introduced in the user manual, section |41.15|. |
7121 | |
161 | 7122 Using a script in the "autoload" directory is simpler, but requires using |
7123 exactly the right file name. A function that can be autoloaded has a name | |
7124 like this: > | |
7125 | |
270 | 7126 :call filename#funcname() |
161 | 7127 |
7128 When such a function is called, and it is not defined yet, Vim will search the | |
7129 "autoload" directories in 'runtimepath' for a script file called | |
7130 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
7131 then define the function like this: > | |
7132 | |
270 | 7133 function filename#funcname() |
161 | 7134 echo "Done!" |
7135 endfunction | |
7136 | |
530 | 7137 The file name and the name used before the # in the function must match |
161 | 7138 exactly, and the defined function must have the name exactly as it will be |
7139 called. | |
7140 | |
270 | 7141 It is possible to use subdirectories. Every # in the function name works like |
7142 a path separator. Thus when calling a function: > | |
7143 | |
7144 :call foo#bar#func() | |
161 | 7145 |
7146 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
7147 | |
168 | 7148 This also works when reading a variable that has not been set yet: > |
7149 | |
270 | 7150 :let l = foo#bar#lvar |
168 | 7151 |
557 | 7152 However, when the autoload script was already loaded it won't be loaded again |
7153 for an unknown variable. | |
7154 | |
168 | 7155 When assigning a value to such a variable nothing special happens. This can |
7156 be used to pass settings to the autoload script before it's loaded: > | |
7157 | |
270 | 7158 :let foo#bar#toggle = 1 |
7159 :call foo#bar#func() | |
168 | 7160 |
164 | 7161 Note that when you make a mistake and call a function that is supposed to be |
7162 defined in an autoload script, but the script doesn't actually define the | |
7163 function, the script will be sourced every time you try to call the function. | |
168 | 7164 And you will get an error message every time. |
7165 | |
7166 Also note that if you have two script files, and one calls a function in the | |
1621 | 7167 other and vice versa, before the used function is defined, it won't work. |
168 | 7168 Avoid using the autoload functionality at the toplevel. |
161 | 7169 |
794 | 7170 Hint: If you distribute a bunch of scripts you can pack them together with the |
7171 |vimball| utility. Also read the user manual |distribute-script|. | |
7172 | |
7 | 7173 ============================================================================== |
7174 6. Curly braces names *curly-braces-names* | |
7175 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7176 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
|
7177 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
|
7178 wrapped in braces {} like this: > |
7 | 7179 my_{adjective}_variable |
7180 | |
7181 When Vim encounters this, it evaluates the expression inside the braces, puts | |
7182 that in place of the expression, and re-interprets the whole as a variable | |
7183 name. So in the above example, if the variable "adjective" was set to | |
7184 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
7185 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
7186 | |
7187 One application for this is to create a set of variables governed by an option | |
1621 | 7188 value. For example, the statement > |
7 | 7189 echo my_{&background}_message |
7190 | |
7191 would output the contents of "my_dark_message" or "my_light_message" depending | |
7192 on the current value of 'background'. | |
7193 | |
7194 You can use multiple brace pairs: > | |
7195 echo my_{adverb}_{adjective}_message | |
7196 ..or even nest them: > | |
7197 echo my_{ad{end_of_word}}_message | |
7198 where "end_of_word" is either "verb" or "jective". | |
7199 | |
7200 However, the expression inside the braces must evaluate to a valid single | |
236 | 7201 variable name, e.g. this is invalid: > |
7 | 7202 :let foo='a + b' |
7203 :echo c{foo}d | |
7204 .. since the result of expansion is "ca + bd", which is not a variable name. | |
7205 | |
7206 *curly-braces-function-names* | |
7207 You can call and define functions by an evaluated name in a similar way. | |
7208 Example: > | |
7209 :let func_end='whizz' | |
7210 :call my_func_{func_end}(parameter) | |
7211 | |
7212 This would call the function "my_func_whizz(parameter)". | |
7213 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7214 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7215 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7216 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7217 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7218 |
7 | 7219 ============================================================================== |
7220 7. Commands *expression-commands* | |
7221 | |
7222 :let {var-name} = {expr1} *:let* *E18* | |
7223 Set internal variable {var-name} to the result of the | |
7224 expression {expr1}. The variable will get the type | |
7225 from the {expr}. If {var-name} didn't exist yet, it | |
7226 is created. | |
7227 | |
85 | 7228 :let {var-name}[{idx}] = {expr1} *E689* |
7229 Set a list item to the result of the expression | |
7230 {expr1}. {var-name} must refer to a list and {idx} | |
7231 must be a valid index in that list. For nested list | |
7232 the index can be repeated. | |
1621 | 7233 This cannot be used to add an item to a |List|. |
7234 This cannot be used to set a byte in a String. You | |
7235 can do that like this: > | |
7236 :let var = var[0:2] . 'X' . var[4:] | |
7237 < | |
114 | 7238 *E711* *E719* |
7239 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 7240 Set a sequence of items in a |List| to the result of |
7241 the expression {expr1}, which must be a list with the | |
87 | 7242 correct number of items. |
7243 {idx1} can be omitted, zero is used instead. | |
7244 {idx2} can be omitted, meaning the end of the list. | |
7245 When the selected range of items is partly past the | |
7246 end of the list, items will be added. | |
7247 | |
153 | 7248 *:let+=* *:let-=* *:let.=* *E734* |
114 | 7249 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
7250 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
7251 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
7252 These fail if {var} was not set yet and when the type | |
7253 of {var} and {expr1} don't fit the operator. | |
7254 | |
7255 | |
7 | 7256 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
7257 Set environment variable {env-name} to the result of | |
7258 the expression {expr1}. The type is always String. | |
114 | 7259 :let ${env-name} .= {expr1} |
7260 Append {expr1} to the environment variable {env-name}. | |
7261 If the environment variable didn't exist yet this | |
7262 works like "=". | |
7 | 7263 |
7264 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
7265 Write the result of the expression {expr1} in register | |
7266 {reg-name}. {reg-name} must be a single letter, and | |
7267 must be the name of a writable register (see | |
7268 |registers|). "@@" can be used for the unnamed | |
7269 register, "@/" for the search pattern. | |
7270 If the result of {expr1} ends in a <CR> or <NL>, the | |
7271 register will be linewise, otherwise it will be set to | |
7272 characterwise. | |
7273 This can be used to clear the last search pattern: > | |
7274 :let @/ = "" | |
7275 < This is different from searching for an empty string, | |
7276 that would match everywhere. | |
7277 | |
114 | 7278 :let @{reg-name} .= {expr1} |
1621 | 7279 Append {expr1} to register {reg-name}. If the |
114 | 7280 register was empty it's like setting it to {expr1}. |
7281 | |
1156 | 7282 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 7283 Set option {option-name} to the result of the |
68 | 7284 expression {expr1}. A String or Number value is |
7285 always converted to the type of the option. | |
7 | 7286 For an option local to a window or buffer the effect |
7287 is just like using the |:set| command: both the local | |
555 | 7288 value and the global value are changed. |
68 | 7289 Example: > |
7290 :let &path = &path . ',/usr/local/include' | |
7 | 7291 |
114 | 7292 :let &{option-name} .= {expr1} |
7293 For a string option: Append {expr1} to the value. | |
7294 Does not insert a comma like |:set+=|. | |
7295 | |
7296 :let &{option-name} += {expr1} | |
7297 :let &{option-name} -= {expr1} | |
7298 For a number or boolean option: Add or subtract | |
7299 {expr1}. | |
7300 | |
7 | 7301 :let &l:{option-name} = {expr1} |
114 | 7302 :let &l:{option-name} .= {expr1} |
7303 :let &l:{option-name} += {expr1} | |
7304 :let &l:{option-name} -= {expr1} | |
7 | 7305 Like above, but only set the local value of an option |
7306 (if there is one). Works like |:setlocal|. | |
7307 | |
7308 :let &g:{option-name} = {expr1} | |
114 | 7309 :let &g:{option-name} .= {expr1} |
7310 :let &g:{option-name} += {expr1} | |
7311 :let &g:{option-name} -= {expr1} | |
7 | 7312 Like above, but only set the global value of an option |
7313 (if there is one). Works like |:setglobal|. | |
7314 | |
85 | 7315 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 7316 {expr1} must evaluate to a |List|. The first item in |
68 | 7317 the list is assigned to {name1}, the second item to |
7318 {name2}, etc. | |
7319 The number of names must match the number of items in | |
685 | 7320 the |List|. |
68 | 7321 Each name can be one of the items of the ":let" |
7322 command as mentioned above. | |
7323 Example: > | |
7324 :let [s, item] = GetItem(s) | |
114 | 7325 < Detail: {expr1} is evaluated first, then the |
7326 assignments are done in sequence. This matters if | |
7327 {name2} depends on {name1}. Example: > | |
7328 :let x = [0, 1] | |
7329 :let i = 0 | |
7330 :let [i, x[i]] = [1, 2] | |
7331 :echo x | |
7332 < The result is [0, 2]. | |
7333 | |
7334 :let [{name1}, {name2}, ...] .= {expr1} | |
7335 :let [{name1}, {name2}, ...] += {expr1} | |
7336 :let [{name1}, {name2}, ...] -= {expr1} | |
7337 Like above, but append/add/subtract the value for each | |
685 | 7338 |List| item. |
68 | 7339 |
7340 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 7341 Like |:let-unpack| above, but the |List| may have more |
114 | 7342 items than there are names. A list of the remaining |
7343 items is assigned to {lastname}. If there are no | |
7344 remaining items {lastname} is set to an empty list. | |
68 | 7345 Example: > |
7346 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
7347 < | |
114 | 7348 :let [{name}, ..., ; {lastname}] .= {expr1} |
7349 :let [{name}, ..., ; {lastname}] += {expr1} | |
7350 :let [{name}, ..., ; {lastname}] -= {expr1} | |
7351 Like above, but append/add/subtract the value for each | |
685 | 7352 |List| item. |
2596 | 7353 |
7354 *E121* | |
1621 | 7355 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 7356 variable names may be given. Special names recognized |
7357 here: *E738* | |
777 | 7358 g: global variables |
7359 b: local buffer variables | |
7360 w: local window variables | |
819 | 7361 t: local tab page variables |
777 | 7362 s: script-local variables |
7363 l: local function variables | |
123 | 7364 v: Vim variables. |
7 | 7365 |
55 | 7366 :let List the values of all variables. The type of the |
7367 variable is indicated before the value: | |
7368 <nothing> String | |
7369 # Number | |
856 | 7370 * Funcref |
7 | 7371 |
148 | 7372 |
1156 | 7373 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 7374 Remove the internal variable {name}. Several variable |
7375 names can be given, they are all removed. The name | |
685 | 7376 may also be a |List| or |Dictionary| item. |
7 | 7377 With [!] no error message is given for non-existing |
7378 variables. | |
685 | 7379 One or more items from a |List| can be removed: > |
108 | 7380 :unlet list[3] " remove fourth item |
7381 :unlet list[3:] " remove fourth item to last | |
685 | 7382 < One item from a |Dictionary| can be removed at a time: > |
108 | 7383 :unlet dict['two'] |
7384 :unlet dict.two | |
1668 | 7385 < This is especially useful to clean up used global |
7386 variables and script-local variables (these are not | |
7387 deleted when the script ends). Function-local | |
7388 variables are automatically deleted when the function | |
7389 ends. | |
7 | 7390 |
148 | 7391 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
7392 Lock the internal variable {name}. Locking means that | |
7393 it can no longer be changed (until it is unlocked). | |
7394 A locked variable can be deleted: > | |
7395 :lockvar v | |
7396 :let v = 'asdf' " fails! | |
7397 :unlet v | |
7398 < *E741* | |
7399 If you try to change a locked variable you get an | |
6530 | 7400 error message: "E741: Value is locked: {name}" |
148 | 7401 |
685 | 7402 [depth] is relevant when locking a |List| or |
7403 |Dictionary|. It specifies how deep the locking goes: | |
7404 1 Lock the |List| or |Dictionary| itself, | |
148 | 7405 cannot add or remove items, but can |
7406 still change their values. | |
7407 2 Also lock the values, cannot change | |
685 | 7408 the items. If an item is a |List| or |
7409 |Dictionary|, cannot add or remove | |
148 | 7410 items, but can still change the |
7411 values. | |
685 | 7412 3 Like 2 but for the |List| / |
7413 |Dictionary| in the |List| / | |
7414 |Dictionary|, one level deeper. | |
7415 The default [depth] is 2, thus when {name} is a |List| | |
7416 or |Dictionary| the values cannot be changed. | |
148 | 7417 *E743* |
7418 For unlimited depth use [!] and omit [depth]. | |
7419 However, there is a maximum depth of 100 to catch | |
7420 loops. | |
7421 | |
685 | 7422 Note that when two variables refer to the same |List| |
7423 and you lock one of them, the |List| will also be | |
819 | 7424 locked when used through the other variable. |
7425 Example: > | |
148 | 7426 :let l = [0, 1, 2, 3] |
7427 :let cl = l | |
7428 :lockvar l | |
7429 :let cl[1] = 99 " won't work! | |
7430 < You may want to make a copy of a list to avoid this. | |
7431 See |deepcopy()|. | |
7432 | |
7433 | |
7434 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
7435 Unlock the internal variable {name}. Does the | |
7436 opposite of |:lockvar|. | |
7437 | |
7438 | |
7 | 7439 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
7440 :en[dif] Execute the commands until the next matching ":else" | |
7441 or ":endif" if {expr1} evaluates to non-zero. | |
7442 | |
7443 From Vim version 4.5 until 5.0, every Ex command in | |
7444 between the ":if" and ":endif" is ignored. These two | |
7445 commands were just to allow for future expansions in a | |
7446 backwards compatible way. Nesting was allowed. Note | |
7447 that any ":else" or ":elseif" was ignored, the "else" | |
7448 part was not executed either. | |
7449 | |
7450 You can use this to remain compatible with older | |
7451 versions: > | |
7452 :if version >= 500 | |
7453 : version-5-specific-commands | |
7454 :endif | |
7455 < The commands still need to be parsed to find the | |
7456 "endif". Sometimes an older Vim has a problem with a | |
7457 new command. For example, ":silent" is recognized as | |
7458 a ":substitute" command. In that case ":execute" can | |
7459 avoid problems: > | |
7460 :if version >= 600 | |
7461 : execute "silent 1,$delete" | |
7462 :endif | |
7463 < | |
7464 NOTE: The ":append" and ":insert" commands don't work | |
7465 properly in between ":if" and ":endif". | |
7466 | |
7467 *:else* *:el* *E581* *E583* | |
7468 :el[se] Execute the commands until the next matching ":else" | |
7469 or ":endif" if they previously were not being | |
7470 executed. | |
7471 | |
7472 *:elseif* *:elsei* *E582* *E584* | |
7473 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
7474 is no extra ":endif". | |
7475 | |
7476 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 7477 *E170* *E585* *E588* *E733* |
7 | 7478 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
7479 as long as {expr1} evaluates to non-zero. | |
7480 When an error is detected from a command inside the | |
7481 loop, execution continues after the "endwhile". | |
75 | 7482 Example: > |
7483 :let lnum = 1 | |
7484 :while lnum <= line("$") | |
7485 :call FixLine(lnum) | |
7486 :let lnum = lnum + 1 | |
7487 :endwhile | |
7488 < | |
7 | 7489 NOTE: The ":append" and ":insert" commands don't work |
99 | 7490 properly inside a ":while" and ":for" loop. |
75 | 7491 |
114 | 7492 :for {var} in {list} *:for* *E690* *E732* |
75 | 7493 :endfo[r] *:endfo* *:endfor* |
7494 Repeat the commands between ":for" and ":endfor" for | |
158 | 7495 each item in {list}. Variable {var} is set to the |
79 | 7496 value of each item. |
7497 When an error is detected for a command inside the | |
75 | 7498 loop, execution continues after the "endfor". |
464 | 7499 Changing {list} inside the loop affects what items are |
7500 used. Make a copy if this is unwanted: > | |
79 | 7501 :for item in copy(mylist) |
7502 < When not making a copy, Vim stores a reference to the | |
7503 next item in the list, before executing the commands | |
1621 | 7504 with the current item. Thus the current item can be |
79 | 7505 removed without effect. Removing any later item means |
7506 it will not be found. Thus the following example | |
7507 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7508 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7509 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7510 endfor |
87 | 7511 < Note that reordering the list (e.g., with sort() or |
7512 reverse()) may have unexpected effects. | |
7513 Note that the type of each list item should be | |
75 | 7514 identical to avoid errors for the type of {var} |
7515 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7516 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7517 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7518 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7519 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7520 endfor |
75 | 7521 |
7522 :for [{var1}, {var2}, ...] in {listlist} | |
7523 :endfo[r] | |
7524 Like ":for" above, but each item in {listlist} must be | |
7525 a list, of which each item is assigned to {var1}, | |
7526 {var2}, etc. Example: > | |
7527 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
7528 :echo getline(lnum)[col] | |
7529 :endfor | |
7530 < | |
7 | 7531 *:continue* *:con* *E586* |
75 | 7532 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
7533 to the start of the loop. | |
7534 If it is used after a |:try| inside the loop but | |
7535 before the matching |:finally| (if present), the | |
7536 commands following the ":finally" up to the matching | |
7537 |:endtry| are executed first. This process applies to | |
7538 all nested ":try"s inside the loop. The outermost | |
7539 ":endtry" then jumps back to the start of the loop. | |
7 | 7540 |
7541 *:break* *:brea* *E587* | |
75 | 7542 :brea[k] When used inside a ":while" or ":for" loop, skips to |
7543 the command after the matching ":endwhile" or | |
7544 ":endfor". | |
7545 If it is used after a |:try| inside the loop but | |
7546 before the matching |:finally| (if present), the | |
7547 commands following the ":finally" up to the matching | |
7548 |:endtry| are executed first. This process applies to | |
7549 all nested ":try"s inside the loop. The outermost | |
7550 ":endtry" then jumps to the command after the loop. | |
7 | 7551 |
7552 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
7553 :endt[ry] Change the error handling for the commands between | |
7554 ":try" and ":endtry" including everything being | |
7555 executed across ":source" commands, function calls, | |
7556 or autocommand invocations. | |
7557 | |
7558 When an error or interrupt is detected and there is | |
7559 a |:finally| command following, execution continues | |
7560 after the ":finally". Otherwise, or when the | |
7561 ":endtry" is reached thereafter, the next | |
7562 (dynamically) surrounding ":try" is checked for | |
7563 a corresponding ":finally" etc. Then the script | |
7564 processing is terminated. (Whether a function | |
7565 definition has an "abort" argument does not matter.) | |
7566 Example: > | |
7567 :try | edit too much | finally | echo "cleanup" | endtry | |
7568 :echo "impossible" " not reached, script terminated above | |
7569 < | |
7570 Moreover, an error or interrupt (dynamically) inside | |
7571 ":try" and ":endtry" is converted to an exception. It | |
7572 can be caught as if it were thrown by a |:throw| | |
7573 command (see |:catch|). In this case, the script | |
7574 processing is not terminated. | |
7575 | |
7576 The value "Vim:Interrupt" is used for an interrupt | |
7577 exception. An error in a Vim command is converted | |
7578 to a value of the form "Vim({command}):{errmsg}", | |
7579 other errors are converted to a value of the form | |
7580 "Vim:{errmsg}". {command} is the full command name, | |
7581 and {errmsg} is the message that is displayed if the | |
7582 error exception is not caught, always beginning with | |
7583 the error number. | |
7584 Examples: > | |
7585 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
7586 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
7587 < | |
7588 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7589 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 7590 |:finally|, or |:endtry| that belongs to the same |
7591 |:try| as the ":catch" are executed when an exception | |
7592 matching {pattern} is being thrown and has not yet | |
7593 been caught by a previous ":catch". Otherwise, these | |
7594 commands are skipped. | |
7595 When {pattern} is omitted all errors are caught. | |
7596 Examples: > | |
7597 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
7598 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
7599 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
7600 :catch /^Vim(write):/ " catch all errors in :write | |
7601 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
7602 :catch /my-exception/ " catch user exception | |
7603 :catch /.*/ " catch everything | |
7604 :catch " same as /.*/ | |
7605 < | |
7606 Another character can be used instead of / around the | |
7607 {pattern}, so long as it does not have a special | |
7608 meaning (e.g., '|' or '"') and doesn't occur inside | |
7609 {pattern}. | |
5814 | 7610 Information about the exception is available in |
7611 |v:exception|. Also see |throw-variables|. | |
7 | 7612 NOTE: It is not reliable to ":catch" the TEXT of |
7613 an error message because it may vary in different | |
7614 locales. | |
7615 | |
7616 *:fina* *:finally* *E606* *E607* | |
7617 :fina[lly] The following commands until the matching |:endtry| | |
7618 are executed whenever the part between the matching | |
7619 |:try| and the ":finally" is left: either by falling | |
7620 through to the ":finally" or by a |:continue|, | |
7621 |:break|, |:finish|, or |:return|, or by an error or | |
7622 interrupt or exception (see |:throw|). | |
7623 | |
7624 *:th* *:throw* *E608* | |
7625 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
7626 If the ":throw" is used after a |:try| but before the | |
7627 first corresponding |:catch|, commands are skipped | |
7628 until the first ":catch" matching {expr1} is reached. | |
7629 If there is no such ":catch" or if the ":throw" is | |
7630 used after a ":catch" but before the |:finally|, the | |
7631 commands following the ":finally" (if present) up to | |
7632 the matching |:endtry| are executed. If the ":throw" | |
7633 is after the ":finally", commands up to the ":endtry" | |
7634 are skipped. At the ":endtry", this process applies | |
7635 again for the next dynamically surrounding ":try" | |
7636 (which may be found in a calling function or sourcing | |
7637 script), until a matching ":catch" has been found. | |
7638 If the exception is not caught, the command processing | |
7639 is terminated. | |
7640 Example: > | |
7641 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 7642 < Note that "catch" may need to be on a separate line |
7643 for when an error causes the parsing to skip the whole | |
7644 line and not see the "|" that separates the commands. | |
7 | 7645 |
7646 *:ec* *:echo* | |
7647 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
7648 first {expr1} starts on a new line. | |
7649 Also see |:comment|. | |
7650 Use "\n" to start a new line. Use "\r" to move the | |
7651 cursor to the first column. | |
7652 Uses the highlighting set by the |:echohl| command. | |
7653 Cannot be followed by a comment. | |
7654 Example: > | |
7655 :echo "the value of 'shell' is" &shell | |
1156 | 7656 < *:echo-redraw* |
7657 A later redraw may make the message disappear again. | |
7658 And since Vim mostly postpones redrawing until it's | |
7659 finished with a sequence of commands this happens | |
7660 quite often. To avoid that a command from before the | |
7661 ":echo" causes a redraw afterwards (redraws are often | |
7662 postponed until you type something), force a redraw | |
7663 with the |:redraw| command. Example: > | |
7 | 7664 :new | redraw | echo "there is a new window" |
7665 < | |
7666 *:echon* | |
7667 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
7668 |:comment|. | |
7669 Uses the highlighting set by the |:echohl| command. | |
7670 Cannot be followed by a comment. | |
7671 Example: > | |
7672 :echon "the value of 'shell' is " &shell | |
7673 < | |
7674 Note the difference between using ":echo", which is a | |
7675 Vim command, and ":!echo", which is an external shell | |
7676 command: > | |
7677 :!echo % --> filename | |
7678 < The arguments of ":!" are expanded, see |:_%|. > | |
7679 :!echo "%" --> filename or "filename" | |
7680 < Like the previous example. Whether you see the double | |
7681 quotes or not depends on your 'shell'. > | |
7682 :echo % --> nothing | |
7683 < The '%' is an illegal character in an expression. > | |
7684 :echo "%" --> % | |
7685 < This just echoes the '%' character. > | |
7686 :echo expand("%") --> filename | |
7687 < This calls the expand() function to expand the '%'. | |
7688 | |
7689 *:echoh* *:echohl* | |
7690 :echoh[l] {name} Use the highlight group {name} for the following | |
7691 |:echo|, |:echon| and |:echomsg| commands. Also used | |
7692 for the |input()| prompt. Example: > | |
7693 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
7694 < Don't forget to set the group back to "None", | |
7695 otherwise all following echo's will be highlighted. | |
7696 | |
7697 *:echom* *:echomsg* | |
7698 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
7699 message in the |message-history|. | |
7700 Spaces are placed between the arguments as with the | |
7701 |:echo| command. But unprintable characters are | |
7702 displayed, not interpreted. | |
1156 | 7703 The parsing works slightly different from |:echo|, |
7704 more like |:execute|. All the expressions are first | |
7705 evaluated and concatenated before echoing anything. | |
7706 The expressions must evaluate to a Number or String, a | |
7707 Dictionary or List causes an error. | |
7 | 7708 Uses the highlighting set by the |:echohl| command. |
7709 Example: > | |
7710 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 7711 < See |:echo-redraw| to avoid the message disappearing |
7712 when the screen is redrawn. | |
7 | 7713 *:echoe* *:echoerr* |
7714 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
7715 message in the |message-history|. When used in a | |
7716 script or function the line number will be added. | |
7717 Spaces are placed between the arguments as with the | |
1621 | 7718 :echo command. When used inside a try conditional, |
7 | 7719 the message is raised as an error exception instead |
7720 (see |try-echoerr|). | |
7721 Example: > | |
7722 :echoerr "This script just failed!" | |
7723 < If you just want a highlighted message use |:echohl|. | |
7724 And to get a beep: > | |
7725 :exe "normal \<Esc>" | |
7726 < | |
7727 *:exe* *:execute* | |
7728 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 7729 of {expr1} as an Ex command. |
7730 Multiple arguments are concatenated, with a space in | |
7731 between. To avoid the extra space use the "." | |
7732 operator to concatenate strings into one argument. | |
7733 {expr1} is used as the processed command, command line | |
7734 editing keys are not recognized. | |
7 | 7735 Cannot be followed by a comment. |
7736 Examples: > | |
2152 | 7737 :execute "buffer" nextbuf |
7738 :execute "normal" count . "w" | |
7 | 7739 < |
7740 ":execute" can be used to append a command to commands | |
7741 that don't accept a '|'. Example: > | |
7742 :execute '!ls' | echo "theend" | |
7743 | |
7744 < ":execute" is also a nice way to avoid having to type | |
7745 control characters in a Vim script for a ":normal" | |
7746 command: > | |
7747 :execute "normal ixxx\<Esc>" | |
7748 < This has an <Esc> character, see |expr-string|. | |
7749 | |
1621 | 7750 Be careful to correctly escape special characters in |
7751 file names. The |fnameescape()| function can be used | |
1661 | 7752 for Vim commands, |shellescape()| for |:!| commands. |
7753 Examples: > | |
1621 | 7754 :execute "e " . fnameescape(filename) |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
7755 :execute "!ls " . shellescape(filename, 1) |
1621 | 7756 < |
7 | 7757 Note: The executed string may be any command-line, but |
5763 | 7758 starting or ending "if", "while" and "for" does not |
7759 always work, because when commands are skipped the | |
7760 ":execute" is not evaluated and Vim loses track of | |
7761 where blocks start and end. Also "break" and | |
7762 "continue" should not be inside ":execute". | |
7763 This example does not work, because the ":execute" is | |
7764 not evaluated and Vim does not see the "while", and | |
7765 gives an error for finding an ":endwhile": > | |
7766 :if 0 | |
7767 : execute 'while i > 5' | |
7768 : echo "test" | |
7769 : endwhile | |
7770 :endif | |
7 | 7771 < |
7772 It is allowed to have a "while" or "if" command | |
7773 completely in the executed string: > | |
7774 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
7775 < | |
7776 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7777 *:exe-comment* |
7 | 7778 ":execute", ":echo" and ":echon" cannot be followed by |
7779 a comment directly, because they see the '"' as the | |
7780 start of a string. But, you can use '|' followed by a | |
7781 comment. Example: > | |
7782 :echo "foo" | "this is a comment | |
7783 | |
7784 ============================================================================== | |
7785 8. Exception handling *exception-handling* | |
7786 | |
7787 The Vim script language comprises an exception handling feature. This section | |
7788 explains how it can be used in a Vim script. | |
7789 | |
7790 Exceptions may be raised by Vim on an error or on interrupt, see | |
7791 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
7792 exception by using the ":throw" command, see |throw-catch|. | |
7793 | |
7794 | |
7795 TRY CONDITIONALS *try-conditionals* | |
7796 | |
7797 Exceptions can be caught or can cause cleanup code to be executed. You can | |
7798 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
7799 a finally clause (to be executed for cleanup). | |
7800 A try conditional begins with a |:try| command and ends at the matching | |
7801 |:endtry| command. In between, you can use a |:catch| command to start | |
7802 a catch clause, or a |:finally| command to start a finally clause. There may | |
7803 be none or multiple catch clauses, but there is at most one finally clause, | |
7804 which must not be followed by any catch clauses. The lines before the catch | |
7805 clauses and the finally clause is called a try block. > | |
7806 | |
7807 :try | |
1621 | 7808 : ... |
7809 : ... TRY BLOCK | |
7810 : ... | |
7 | 7811 :catch /{pattern}/ |
1621 | 7812 : ... |
7813 : ... CATCH CLAUSE | |
7814 : ... | |
7 | 7815 :catch /{pattern}/ |
1621 | 7816 : ... |
7817 : ... CATCH CLAUSE | |
7818 : ... | |
7 | 7819 :finally |
1621 | 7820 : ... |
7821 : ... FINALLY CLAUSE | |
7822 : ... | |
7 | 7823 :endtry |
7824 | |
7825 The try conditional allows to watch code for exceptions and to take the | |
7826 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
7827 from the try block and also the catch clauses may cause cleanup actions. | |
7828 When no exception is thrown during execution of the try block, the control | |
7829 is transferred to the finally clause, if present. After its execution, the | |
7830 script continues with the line following the ":endtry". | |
7831 When an exception occurs during execution of the try block, the remaining | |
7832 lines in the try block are skipped. The exception is matched against the | |
7833 patterns specified as arguments to the ":catch" commands. The catch clause | |
7834 after the first matching ":catch" is taken, other catch clauses are not | |
7835 executed. The catch clause ends when the next ":catch", ":finally", or | |
7836 ":endtry" command is reached - whatever is first. Then, the finally clause | |
7837 (if present) is executed. When the ":endtry" is reached, the script execution | |
7838 continues in the following line as usual. | |
7839 When an exception that does not match any of the patterns specified by the | |
7840 ":catch" commands is thrown in the try block, the exception is not caught by | |
7841 that try conditional and none of the catch clauses is executed. Only the | |
7842 finally clause, if present, is taken. The exception pends during execution of | |
7843 the finally clause. It is resumed at the ":endtry", so that commands after | |
7844 the ":endtry" are not executed and the exception might be caught elsewhere, | |
7845 see |try-nesting|. | |
7846 When during execution of a catch clause another exception is thrown, the | |
1621 | 7847 remaining lines in that catch clause are not executed. The new exception is |
7 | 7848 not matched against the patterns in any of the ":catch" commands of the same |
7849 try conditional and none of its catch clauses is taken. If there is, however, | |
7850 a finally clause, it is executed, and the exception pends during its | |
7851 execution. The commands following the ":endtry" are not executed. The new | |
7852 exception might, however, be caught elsewhere, see |try-nesting|. | |
7853 When during execution of the finally clause (if present) an exception is | |
1621 | 7854 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 7855 clause has been taken because of an exception from the try block or one of the |
7856 catch clauses, the original (pending) exception is discarded. The commands | |
7857 following the ":endtry" are not executed, and the exception from the finally | |
7858 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
7859 | |
7860 The finally clause is also executed, when a ":break" or ":continue" for | |
7861 a ":while" loop enclosing the complete try conditional is executed from the | |
7862 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
7863 from the try block or a catch clause of a try conditional in a function or | |
7864 sourced script, respectively. The ":break", ":continue", ":return", or | |
7865 ":finish" pends during execution of the finally clause and is resumed when the | |
7866 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
7867 from the finally clause. | |
7868 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
7869 try conditional or when a ":return" or ":finish" is encountered in the finally | |
7870 clause, the rest of the finally clause is skipped, and the ":break", | |
7871 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
7872 clause has been taken because of an exception or an earlier ":break", | |
7873 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
7874 this pending exception or command is discarded. | |
7875 | |
7876 For examples see |throw-catch| and |try-finally|. | |
7877 | |
7878 | |
7879 NESTING OF TRY CONDITIONALS *try-nesting* | |
7880 | |
7881 Try conditionals can be nested arbitrarily. That is, a complete try | |
7882 conditional can be put into the try block, a catch clause, or the finally | |
7883 clause of another try conditional. If the inner try conditional does not | |
7884 catch an exception thrown in its try block or throws a new exception from one | |
7885 of its catch clauses or its finally clause, the outer try conditional is | |
7886 checked according to the rules above. If the inner try conditional is in the | |
7887 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 7888 otherwise only the finally clause is executed. It does not matter for |
7 | 7889 nesting, whether the inner try conditional is directly contained in the outer |
7890 one, or whether the outer one sources a script or calls a function containing | |
7891 the inner try conditional. | |
7892 | |
7893 When none of the active try conditionals catches an exception, just their | |
7894 finally clauses are executed. Thereafter, the script processing terminates. | |
7895 An error message is displayed in case of an uncaught exception explicitly | |
7896 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
7897 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
7898 as usual. | |
7899 | |
7900 For examples see |throw-catch|. | |
7901 | |
7902 | |
7903 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
7904 | |
7905 Exception handling code can get tricky. If you are in doubt what happens, set | |
7906 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
7907 script file. Then you see when an exception is thrown, discarded, caught, or | |
7908 finished. When using a verbosity level of at least 14, things pending in | |
7909 a finally clause are also shown. This information is also given in debug mode | |
7910 (see |debug-scripts|). | |
7911 | |
7912 | |
7913 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
7914 | |
7915 You can throw any number or string as an exception. Use the |:throw| command | |
7916 and pass the value to be thrown as argument: > | |
7917 :throw 4711 | |
7918 :throw "string" | |
7919 < *throw-expression* | |
7920 You can also specify an expression argument. The expression is then evaluated | |
7921 first, and the result is thrown: > | |
7922 :throw 4705 + strlen("string") | |
7923 :throw strpart("strings", 0, 6) | |
7924 | |
7925 An exception might be thrown during evaluation of the argument of the ":throw" | |
7926 command. Unless it is caught there, the expression evaluation is abandoned. | |
7927 The ":throw" command then does not throw a new exception. | |
7928 Example: > | |
7929 | |
7930 :function! Foo(arg) | |
7931 : try | |
7932 : throw a:arg | |
7933 : catch /foo/ | |
7934 : endtry | |
7935 : return 1 | |
7936 :endfunction | |
7937 : | |
7938 :function! Bar() | |
7939 : echo "in Bar" | |
7940 : return 4710 | |
7941 :endfunction | |
7942 : | |
7943 :throw Foo("arrgh") + Bar() | |
7944 | |
7945 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
7946 executed. > | |
7947 :throw Foo("foo") + Bar() | |
7948 however displays "in Bar" and throws 4711. | |
7949 | |
7950 Any other command that takes an expression as argument might also be | |
1621 | 7951 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 7952 exception is then propagated to the caller of the command. |
7953 Example: > | |
7954 | |
7955 :if Foo("arrgh") | |
7956 : echo "then" | |
7957 :else | |
7958 : echo "else" | |
7959 :endif | |
7960 | |
7961 Here neither of "then" or "else" is displayed. | |
7962 | |
7963 *catch-order* | |
7964 Exceptions can be caught by a try conditional with one or more |:catch| | |
7965 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
7966 command can be specified as a pattern argument. The subsequent catch clause | |
7967 gets executed when a matching exception is caught. | |
7968 Example: > | |
7969 | |
7970 :function! Foo(value) | |
7971 : try | |
7972 : throw a:value | |
7973 : catch /^\d\+$/ | |
7974 : echo "Number thrown" | |
7975 : catch /.*/ | |
7976 : echo "String thrown" | |
7977 : endtry | |
7978 :endfunction | |
7979 : | |
7980 :call Foo(0x1267) | |
7981 :call Foo('string') | |
7982 | |
7983 The first call to Foo() displays "Number thrown", the second "String thrown". | |
7984 An exception is matched against the ":catch" commands in the order they are | |
7985 specified. Only the first match counts. So you should place the more | |
7986 specific ":catch" first. The following order does not make sense: > | |
7987 | |
7988 : catch /.*/ | |
7989 : echo "String thrown" | |
7990 : catch /^\d\+$/ | |
7991 : echo "Number thrown" | |
7992 | |
7993 The first ":catch" here matches always, so that the second catch clause is | |
7994 never taken. | |
7995 | |
7996 *throw-variables* | |
7997 If you catch an exception by a general pattern, you may access the exact value | |
7998 in the variable |v:exception|: > | |
7999 | |
8000 : catch /^\d\+$/ | |
8001 : echo "Number thrown. Value is" v:exception | |
8002 | |
8003 You may also be interested where an exception was thrown. This is stored in | |
8004 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
8005 exception most recently caught as long it is not finished. | |
8006 Example: > | |
8007 | |
8008 :function! Caught() | |
8009 : if v:exception != "" | |
8010 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
8011 : else | |
8012 : echo 'Nothing caught' | |
8013 : endif | |
8014 :endfunction | |
8015 : | |
8016 :function! Foo() | |
8017 : try | |
8018 : try | |
8019 : try | |
8020 : throw 4711 | |
8021 : finally | |
8022 : call Caught() | |
8023 : endtry | |
8024 : catch /.*/ | |
8025 : call Caught() | |
8026 : throw "oops" | |
8027 : endtry | |
8028 : catch /.*/ | |
8029 : call Caught() | |
8030 : finally | |
8031 : call Caught() | |
8032 : endtry | |
8033 :endfunction | |
8034 : | |
8035 :call Foo() | |
8036 | |
8037 This displays > | |
8038 | |
8039 Nothing caught | |
8040 Caught "4711" in function Foo, line 4 | |
8041 Caught "oops" in function Foo, line 10 | |
8042 Nothing caught | |
8043 | |
8044 A practical example: The following command ":LineNumber" displays the line | |
8045 number in the script or function where it has been used: > | |
8046 | |
8047 :function! LineNumber() | |
8048 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
8049 :endfunction | |
8050 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
8051 < | |
8052 *try-nested* | |
8053 An exception that is not caught by a try conditional can be caught by | |
8054 a surrounding try conditional: > | |
8055 | |
8056 :try | |
8057 : try | |
8058 : throw "foo" | |
8059 : catch /foobar/ | |
8060 : echo "foobar" | |
8061 : finally | |
8062 : echo "inner finally" | |
8063 : endtry | |
8064 :catch /foo/ | |
8065 : echo "foo" | |
8066 :endtry | |
8067 | |
8068 The inner try conditional does not catch the exception, just its finally | |
8069 clause is executed. The exception is then caught by the outer try | |
8070 conditional. The example displays "inner finally" and then "foo". | |
8071 | |
8072 *throw-from-catch* | |
8073 You can catch an exception and throw a new one to be caught elsewhere from the | |
8074 catch clause: > | |
8075 | |
8076 :function! Foo() | |
8077 : throw "foo" | |
8078 :endfunction | |
8079 : | |
8080 :function! Bar() | |
8081 : try | |
8082 : call Foo() | |
8083 : catch /foo/ | |
8084 : echo "Caught foo, throw bar" | |
8085 : throw "bar" | |
8086 : endtry | |
8087 :endfunction | |
8088 : | |
8089 :try | |
8090 : call Bar() | |
8091 :catch /.*/ | |
8092 : echo "Caught" v:exception | |
8093 :endtry | |
8094 | |
8095 This displays "Caught foo, throw bar" and then "Caught bar". | |
8096 | |
8097 *rethrow* | |
8098 There is no real rethrow in the Vim script language, but you may throw | |
8099 "v:exception" instead: > | |
8100 | |
8101 :function! Bar() | |
8102 : try | |
8103 : call Foo() | |
8104 : catch /.*/ | |
8105 : echo "Rethrow" v:exception | |
8106 : throw v:exception | |
8107 : endtry | |
8108 :endfunction | |
8109 < *try-echoerr* | |
8110 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
8111 exceptions, because it is not possible to fake Vim internal exceptions. | |
8112 Trying so causes an error exception. You should throw your own exception | |
8113 denoting the situation. If you want to cause a Vim error exception containing | |
8114 the original error exception value, you can use the |:echoerr| command: > | |
8115 | |
8116 :try | |
8117 : try | |
8118 : asdf | |
8119 : catch /.*/ | |
8120 : echoerr v:exception | |
8121 : endtry | |
8122 :catch /.*/ | |
8123 : echo v:exception | |
8124 :endtry | |
8125 | |
8126 This code displays | |
8127 | |
1621 | 8128 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 8129 |
8130 | |
8131 CLEANUP CODE *try-finally* | |
8132 | |
8133 Scripts often change global settings and restore them at their end. If the | |
8134 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 8135 an inconsistent state. The same may happen to you in the development phase of |
7 | 8136 a script when an error occurs or you explicitly throw an exception without |
8137 catching it. You can solve these problems by using a try conditional with | |
8138 a finally clause for restoring the settings. Its execution is guaranteed on | |
8139 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
8140 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 8141 to exceptions. When not caught, they terminate the script after the finally |
7 | 8142 clause has been executed.) |
8143 Example: > | |
8144 | |
8145 :try | |
8146 : let s:saved_ts = &ts | |
8147 : set ts=17 | |
8148 : | |
8149 : " Do the hard work here. | |
8150 : | |
8151 :finally | |
8152 : let &ts = s:saved_ts | |
8153 : unlet s:saved_ts | |
8154 :endtry | |
8155 | |
8156 This method should be used locally whenever a function or part of a script | |
8157 changes global settings which need to be restored on failure or normal exit of | |
8158 that function or script part. | |
8159 | |
8160 *break-finally* | |
8161 Cleanup code works also when the try block or a catch clause is left by | |
8162 a ":continue", ":break", ":return", or ":finish". | |
8163 Example: > | |
8164 | |
8165 :let first = 1 | |
8166 :while 1 | |
8167 : try | |
8168 : if first | |
8169 : echo "first" | |
8170 : let first = 0 | |
8171 : continue | |
8172 : else | |
8173 : throw "second" | |
8174 : endif | |
8175 : catch /.*/ | |
8176 : echo v:exception | |
8177 : break | |
8178 : finally | |
8179 : echo "cleanup" | |
8180 : endtry | |
8181 : echo "still in while" | |
8182 :endwhile | |
8183 :echo "end" | |
8184 | |
8185 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
8186 | |
8187 :function! Foo() | |
8188 : try | |
8189 : return 4711 | |
8190 : finally | |
8191 : echo "cleanup\n" | |
8192 : endtry | |
8193 : echo "Foo still active" | |
8194 :endfunction | |
8195 : | |
8196 :echo Foo() "returned by Foo" | |
8197 | |
8198 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 8199 extra ":return" in the finally clause. (Above all, this would override the |
7 | 8200 return value.) |
8201 | |
8202 *except-from-finally* | |
8203 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
8204 a finally clause is possible, but not recommended since it abandons the | |
8205 cleanup actions for the try conditional. But, of course, interrupt and error | |
8206 exceptions might get raised from a finally clause. | |
8207 Example where an error in the finally clause stops an interrupt from | |
8208 working correctly: > | |
8209 | |
8210 :try | |
8211 : try | |
8212 : echo "Press CTRL-C for interrupt" | |
8213 : while 1 | |
8214 : endwhile | |
8215 : finally | |
8216 : unlet novar | |
8217 : endtry | |
8218 :catch /novar/ | |
8219 :endtry | |
8220 :echo "Script still running" | |
8221 :sleep 1 | |
8222 | |
8223 If you need to put commands that could fail into a finally clause, you should | |
8224 think about catching or ignoring the errors in these commands, see | |
8225 |catch-errors| and |ignore-errors|. | |
8226 | |
8227 | |
8228 CATCHING ERRORS *catch-errors* | |
8229 | |
8230 If you want to catch specific errors, you just have to put the code to be | |
8231 watched in a try block and add a catch clause for the error message. The | |
8232 presence of the try conditional causes all errors to be converted to an | |
8233 exception. No message is displayed and |v:errmsg| is not set then. To find | |
8234 the right pattern for the ":catch" command, you have to know how the format of | |
8235 the error exception is. | |
8236 Error exceptions have the following format: > | |
8237 | |
8238 Vim({cmdname}):{errmsg} | |
8239 or > | |
8240 Vim:{errmsg} | |
8241 | |
8242 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 8243 the command name is not known. {errmsg} is the error message usually produced |
7 | 8244 when the error occurs outside try conditionals. It always begins with |
8245 a capital "E", followed by a two or three-digit error number, a colon, and | |
8246 a space. | |
8247 | |
8248 Examples: | |
8249 | |
8250 The command > | |
8251 :unlet novar | |
8252 normally produces the error message > | |
8253 E108: No such variable: "novar" | |
8254 which is converted inside try conditionals to an exception > | |
8255 Vim(unlet):E108: No such variable: "novar" | |
8256 | |
8257 The command > | |
8258 :dwim | |
8259 normally produces the error message > | |
8260 E492: Not an editor command: dwim | |
8261 which is converted inside try conditionals to an exception > | |
8262 Vim:E492: Not an editor command: dwim | |
8263 | |
8264 You can catch all ":unlet" errors by a > | |
8265 :catch /^Vim(unlet):/ | |
8266 or all errors for misspelled command names by a > | |
8267 :catch /^Vim:E492:/ | |
8268 | |
8269 Some error messages may be produced by different commands: > | |
8270 :function nofunc | |
8271 and > | |
8272 :delfunction nofunc | |
8273 both produce the error message > | |
8274 E128: Function name must start with a capital: nofunc | |
8275 which is converted inside try conditionals to an exception > | |
8276 Vim(function):E128: Function name must start with a capital: nofunc | |
8277 or > | |
8278 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
8279 respectively. You can catch the error by its number independently on the | |
8280 command that caused it if you use the following pattern: > | |
8281 :catch /^Vim(\a\+):E128:/ | |
8282 | |
8283 Some commands like > | |
8284 :let x = novar | |
8285 produce multiple error messages, here: > | |
8286 E121: Undefined variable: novar | |
8287 E15: Invalid expression: novar | |
8288 Only the first is used for the exception value, since it is the most specific | |
8289 one (see |except-several-errors|). So you can catch it by > | |
8290 :catch /^Vim(\a\+):E121:/ | |
8291 | |
8292 You can catch all errors related to the name "nofunc" by > | |
8293 :catch /\<nofunc\>/ | |
8294 | |
8295 You can catch all Vim errors in the ":write" and ":read" commands by > | |
8296 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
8297 | |
8298 You can catch all Vim errors by the pattern > | |
8299 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
8300 < | |
8301 *catch-text* | |
8302 NOTE: You should never catch the error message text itself: > | |
8303 :catch /No such variable/ | |
6647 | 8304 only works in the English locale, but not when the user has selected |
7 | 8305 a different language by the |:language| command. It is however helpful to |
8306 cite the message text in a comment: > | |
8307 :catch /^Vim(\a\+):E108:/ " No such variable | |
8308 | |
8309 | |
8310 IGNORING ERRORS *ignore-errors* | |
8311 | |
8312 You can ignore errors in a specific Vim command by catching them locally: > | |
8313 | |
8314 :try | |
8315 : write | |
8316 :catch | |
8317 :endtry | |
8318 | |
8319 But you are strongly recommended NOT to use this simple form, since it could | |
8320 catch more than you want. With the ":write" command, some autocommands could | |
8321 be executed and cause errors not related to writing, for instance: > | |
8322 | |
8323 :au BufWritePre * unlet novar | |
8324 | |
8325 There could even be such errors you are not responsible for as a script | |
8326 writer: a user of your script might have defined such autocommands. You would | |
8327 then hide the error from the user. | |
8328 It is much better to use > | |
8329 | |
8330 :try | |
8331 : write | |
8332 :catch /^Vim(write):/ | |
8333 :endtry | |
8334 | |
8335 which only catches real write errors. So catch only what you'd like to ignore | |
8336 intentionally. | |
8337 | |
8338 For a single command that does not cause execution of autocommands, you could | |
8339 even suppress the conversion of errors to exceptions by the ":silent!" | |
8340 command: > | |
8341 :silent! nunmap k | |
8342 This works also when a try conditional is active. | |
8343 | |
8344 | |
8345 CATCHING INTERRUPTS *catch-interrupt* | |
8346 | |
8347 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 8348 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 8349 script is not terminated, then. |
8350 Example: > | |
8351 | |
8352 :function! TASK1() | |
8353 : sleep 10 | |
8354 :endfunction | |
8355 | |
8356 :function! TASK2() | |
8357 : sleep 20 | |
8358 :endfunction | |
8359 | |
8360 :while 1 | |
8361 : let command = input("Type a command: ") | |
8362 : try | |
8363 : if command == "" | |
8364 : continue | |
8365 : elseif command == "END" | |
8366 : break | |
8367 : elseif command == "TASK1" | |
8368 : call TASK1() | |
8369 : elseif command == "TASK2" | |
8370 : call TASK2() | |
8371 : else | |
8372 : echo "\nIllegal command:" command | |
8373 : continue | |
8374 : endif | |
8375 : catch /^Vim:Interrupt$/ | |
8376 : echo "\nCommand interrupted" | |
8377 : " Caught the interrupt. Continue with next prompt. | |
8378 : endtry | |
8379 :endwhile | |
8380 | |
8381 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 8382 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 8383 |
8384 For testing what happens when CTRL-C would be pressed on a specific line in | |
8385 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
8386 command on that line. See |debug-scripts|. | |
8387 | |
8388 | |
8389 CATCHING ALL *catch-all* | |
8390 | |
8391 The commands > | |
8392 | |
8393 :catch /.*/ | |
8394 :catch // | |
8395 :catch | |
8396 | |
8397 catch everything, error exceptions, interrupt exceptions and exceptions | |
8398 explicitly thrown by the |:throw| command. This is useful at the top level of | |
8399 a script in order to catch unexpected things. | |
8400 Example: > | |
8401 | |
8402 :try | |
8403 : | |
8404 : " do the hard work here | |
8405 : | |
8406 :catch /MyException/ | |
8407 : | |
8408 : " handle known problem | |
8409 : | |
8410 :catch /^Vim:Interrupt$/ | |
8411 : echo "Script interrupted" | |
8412 :catch /.*/ | |
8413 : echo "Internal error (" . v:exception . ")" | |
8414 : echo " - occurred at " . v:throwpoint | |
8415 :endtry | |
8416 :" end of script | |
8417 | |
8418 Note: Catching all might catch more things than you want. Thus, you are | |
8419 strongly encouraged to catch only for problems that you can really handle by | |
8420 specifying a pattern argument to the ":catch". | |
8421 Example: Catching all could make it nearly impossible to interrupt a script | |
8422 by pressing CTRL-C: > | |
8423 | |
8424 :while 1 | |
8425 : try | |
8426 : sleep 1 | |
8427 : catch | |
8428 : endtry | |
8429 :endwhile | |
8430 | |
8431 | |
8432 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
8433 | |
8434 Exceptions may be used during execution of autocommands. Example: > | |
8435 | |
8436 :autocmd User x try | |
8437 :autocmd User x throw "Oops!" | |
8438 :autocmd User x catch | |
8439 :autocmd User x echo v:exception | |
8440 :autocmd User x endtry | |
8441 :autocmd User x throw "Arrgh!" | |
8442 :autocmd User x echo "Should not be displayed" | |
8443 : | |
8444 :try | |
8445 : doautocmd User x | |
8446 :catch | |
8447 : echo v:exception | |
8448 :endtry | |
8449 | |
8450 This displays "Oops!" and "Arrgh!". | |
8451 | |
8452 *except-autocmd-Pre* | |
8453 For some commands, autocommands get executed before the main action of the | |
8454 command takes place. If an exception is thrown and not caught in the sequence | |
8455 of autocommands, the sequence and the command that caused its execution are | |
8456 abandoned and the exception is propagated to the caller of the command. | |
8457 Example: > | |
8458 | |
8459 :autocmd BufWritePre * throw "FAIL" | |
8460 :autocmd BufWritePre * echo "Should not be displayed" | |
8461 : | |
8462 :try | |
8463 : write | |
8464 :catch | |
8465 : echo "Caught:" v:exception "from" v:throwpoint | |
8466 :endtry | |
8467 | |
8468 Here, the ":write" command does not write the file currently being edited (as | |
8469 you can see by checking 'modified'), since the exception from the BufWritePre | |
8470 autocommand abandons the ":write". The exception is then caught and the | |
8471 script displays: > | |
8472 | |
8473 Caught: FAIL from BufWrite Auto commands for "*" | |
8474 < | |
8475 *except-autocmd-Post* | |
8476 For some commands, autocommands get executed after the main action of the | |
8477 command has taken place. If this main action fails and the command is inside | |
8478 an active try conditional, the autocommands are skipped and an error exception | |
8479 is thrown that can be caught by the caller of the command. | |
8480 Example: > | |
8481 | |
8482 :autocmd BufWritePost * echo "File successfully written!" | |
8483 : | |
8484 :try | |
8485 : write /i/m/p/o/s/s/i/b/l/e | |
8486 :catch | |
8487 : echo v:exception | |
8488 :endtry | |
8489 | |
8490 This just displays: > | |
8491 | |
8492 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
8493 | |
8494 If you really need to execute the autocommands even when the main action | |
8495 fails, trigger the event from the catch clause. | |
8496 Example: > | |
8497 | |
8498 :autocmd BufWritePre * set noreadonly | |
8499 :autocmd BufWritePost * set readonly | |
8500 : | |
8501 :try | |
8502 : write /i/m/p/o/s/s/i/b/l/e | |
8503 :catch | |
8504 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
8505 :endtry | |
8506 < | |
8507 You can also use ":silent!": > | |
8508 | |
8509 :let x = "ok" | |
8510 :let v:errmsg = "" | |
8511 :autocmd BufWritePost * if v:errmsg != "" | |
8512 :autocmd BufWritePost * let x = "after fail" | |
8513 :autocmd BufWritePost * endif | |
8514 :try | |
8515 : silent! write /i/m/p/o/s/s/i/b/l/e | |
8516 :catch | |
8517 :endtry | |
8518 :echo x | |
8519 | |
8520 This displays "after fail". | |
8521 | |
8522 If the main action of the command does not fail, exceptions from the | |
8523 autocommands will be catchable by the caller of the command: > | |
8524 | |
8525 :autocmd BufWritePost * throw ":-(" | |
8526 :autocmd BufWritePost * echo "Should not be displayed" | |
8527 : | |
8528 :try | |
8529 : write | |
8530 :catch | |
8531 : echo v:exception | |
8532 :endtry | |
8533 < | |
8534 *except-autocmd-Cmd* | |
8535 For some commands, the normal action can be replaced by a sequence of | |
8536 autocommands. Exceptions from that sequence will be catchable by the caller | |
8537 of the command. | |
8538 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 8539 had actually been written when the exception occurred. You need to tell it in |
7 | 8540 some way. > |
8541 | |
8542 :if !exists("cnt") | |
8543 : let cnt = 0 | |
8544 : | |
8545 : autocmd BufWriteCmd * if &modified | |
8546 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
8547 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
8548 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8549 : autocmd BufWriteCmd * endif | |
8550 : autocmd BufWriteCmd * write | set nomodified | |
8551 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
8552 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8553 : autocmd BufWriteCmd * endif | |
8554 : autocmd BufWriteCmd * echo "File successfully written!" | |
8555 : autocmd BufWriteCmd * endif | |
8556 :endif | |
8557 : | |
8558 :try | |
8559 : write | |
8560 :catch /^BufWriteCmdError$/ | |
8561 : if &modified | |
8562 : echo "Error on writing (file contents not changed)" | |
8563 : else | |
8564 : echo "Error after writing" | |
8565 : endif | |
8566 :catch /^Vim(write):/ | |
8567 : echo "Error on writing" | |
8568 :endtry | |
8569 | |
8570 When this script is sourced several times after making changes, it displays | |
8571 first > | |
8572 File successfully written! | |
8573 then > | |
8574 Error on writing (file contents not changed) | |
8575 then > | |
8576 Error after writing | |
8577 etc. | |
8578 | |
8579 *except-autocmd-ill* | |
8580 You cannot spread a try conditional over autocommands for different events. | |
8581 The following code is ill-formed: > | |
8582 | |
8583 :autocmd BufWritePre * try | |
8584 : | |
8585 :autocmd BufWritePost * catch | |
8586 :autocmd BufWritePost * echo v:exception | |
8587 :autocmd BufWritePost * endtry | |
8588 : | |
8589 :write | |
8590 | |
8591 | |
8592 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
8593 | |
8594 Some programming languages allow to use hierarchies of exception classes or to | |
8595 pass additional information with the object of an exception class. You can do | |
8596 similar things in Vim. | |
8597 In order to throw an exception from a hierarchy, just throw the complete | |
8598 class name with the components separated by a colon, for instance throw the | |
8599 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
8600 When you want to pass additional information with your exception class, add | |
8601 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
8602 for an error when writing "myfile". | |
8603 With the appropriate patterns in the ":catch" command, you can catch for | |
8604 base classes or derived classes of your hierarchy. Additional information in | |
8605 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
8606 Example: > | |
8607 | |
8608 :function! CheckRange(a, func) | |
8609 : if a:a < 0 | |
8610 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
8611 : endif | |
8612 :endfunction | |
8613 : | |
8614 :function! Add(a, b) | |
8615 : call CheckRange(a:a, "Add") | |
8616 : call CheckRange(a:b, "Add") | |
8617 : let c = a:a + a:b | |
8618 : if c < 0 | |
8619 : throw "EXCEPT:MATHERR:OVERFLOW" | |
8620 : endif | |
8621 : return c | |
8622 :endfunction | |
8623 : | |
8624 :function! Div(a, b) | |
8625 : call CheckRange(a:a, "Div") | |
8626 : call CheckRange(a:b, "Div") | |
8627 : if (a:b == 0) | |
8628 : throw "EXCEPT:MATHERR:ZERODIV" | |
8629 : endif | |
8630 : return a:a / a:b | |
8631 :endfunction | |
8632 : | |
8633 :function! Write(file) | |
8634 : try | |
1621 | 8635 : execute "write" fnameescape(a:file) |
7 | 8636 : catch /^Vim(write):/ |
8637 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
8638 : endtry | |
8639 :endfunction | |
8640 : | |
8641 :try | |
8642 : | |
8643 : " something with arithmetics and I/O | |
8644 : | |
8645 :catch /^EXCEPT:MATHERR:RANGE/ | |
8646 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
8647 : echo "Range error in" function | |
8648 : | |
8649 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
8650 : echo "Math error" | |
8651 : | |
8652 :catch /^EXCEPT:IO/ | |
8653 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
8654 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
8655 : if file !~ '^/' | |
8656 : let file = dir . "/" . file | |
8657 : endif | |
8658 : echo 'I/O error for "' . file . '"' | |
8659 : | |
8660 :catch /^EXCEPT/ | |
8661 : echo "Unspecified error" | |
8662 : | |
8663 :endtry | |
8664 | |
8665 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
8666 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
8667 exceptions with the "Vim" prefix; they are reserved for Vim. | |
8668 Vim error exceptions are parameterized with the name of the command that | |
8669 failed, if known. See |catch-errors|. | |
8670 | |
8671 | |
8672 PECULIARITIES | |
8673 *except-compat* | |
8674 The exception handling concept requires that the command sequence causing the | |
8675 exception is aborted immediately and control is transferred to finally clauses | |
8676 and/or a catch clause. | |
8677 | |
8678 In the Vim script language there are cases where scripts and functions | |
8679 continue after an error: in functions without the "abort" flag or in a command | |
8680 after ":silent!", control flow goes to the following line, and outside | |
8681 functions, control flow goes to the line following the outermost ":endwhile" | |
8682 or ":endif". On the other hand, errors should be catchable as exceptions | |
8683 (thus, requiring the immediate abortion). | |
8684 | |
8685 This problem has been solved by converting errors to exceptions and using | |
8686 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 8687 conditional is active. This is no restriction since an (error) exception can |
8688 be caught only from an active try conditional. If you want an immediate | |
7 | 8689 termination without catching the error, just use a try conditional without |
8690 catch clause. (You can cause cleanup code being executed before termination | |
8691 by specifying a finally clause.) | |
8692 | |
8693 When no try conditional is active, the usual abortion and continuation | |
8694 behavior is used instead of immediate abortion. This ensures compatibility of | |
8695 scripts written for Vim 6.1 and earlier. | |
8696 | |
8697 However, when sourcing an existing script that does not use exception handling | |
8698 commands (or when calling one of its functions) from inside an active try | |
8699 conditional of a new script, you might change the control flow of the existing | |
8700 script on error. You get the immediate abortion on error and can catch the | |
8701 error in the new script. If however the sourced script suppresses error | |
8702 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 8703 |v:errmsg| if appropriate), its execution path is not changed. The error is |
8704 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 8705 where this happens is for scripts that don't care about errors and produce |
8706 error messages. You probably won't want to use such code from your new | |
8707 scripts. | |
8708 | |
8709 *except-syntax-err* | |
8710 Syntax errors in the exception handling commands are never caught by any of | |
8711 the ":catch" commands of the try conditional they belong to. Its finally | |
8712 clauses, however, is executed. | |
8713 Example: > | |
8714 | |
8715 :try | |
8716 : try | |
8717 : throw 4711 | |
8718 : catch /\(/ | |
8719 : echo "in catch with syntax error" | |
8720 : catch | |
8721 : echo "inner catch-all" | |
8722 : finally | |
8723 : echo "inner finally" | |
8724 : endtry | |
8725 :catch | |
8726 : echo 'outer catch-all caught "' . v:exception . '"' | |
8727 : finally | |
8728 : echo "outer finally" | |
8729 :endtry | |
8730 | |
8731 This displays: > | |
8732 inner finally | |
8733 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
8734 outer finally | |
8735 The original exception is discarded and an error exception is raised, instead. | |
8736 | |
8737 *except-single-line* | |
8738 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
8739 a single line, but then syntax errors may make it difficult to recognize the | |
8740 "catch" line, thus you better avoid this. | |
8741 Example: > | |
8742 :try | unlet! foo # | catch | endtry | |
8743 raises an error exception for the trailing characters after the ":unlet!" | |
8744 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
8745 error exception is discarded and the "E488: Trailing characters" message gets | |
8746 displayed. | |
8747 | |
8748 *except-several-errors* | |
8749 When several errors appear in a single command, the first error message is | |
8750 usually the most specific one and therefor converted to the error exception. | |
8751 Example: > | |
8752 echo novar | |
8753 causes > | |
8754 E121: Undefined variable: novar | |
8755 E15: Invalid expression: novar | |
8756 The value of the error exception inside try conditionals is: > | |
8757 Vim(echo):E121: Undefined variable: novar | |
8758 < *except-syntax-error* | |
8759 But when a syntax error is detected after a normal error in the same command, | |
8760 the syntax error is used for the exception being thrown. | |
8761 Example: > | |
8762 unlet novar # | |
8763 causes > | |
8764 E108: No such variable: "novar" | |
8765 E488: Trailing characters | |
8766 The value of the error exception inside try conditionals is: > | |
8767 Vim(unlet):E488: Trailing characters | |
8768 This is done because the syntax error might change the execution path in a way | |
8769 not intended by the user. Example: > | |
8770 try | |
8771 try | unlet novar # | catch | echo v:exception | endtry | |
8772 catch /.*/ | |
8773 echo "outer catch:" v:exception | |
8774 endtry | |
8775 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
8776 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
8777 | |
8778 ============================================================================== | |
8779 9. Examples *eval-examples* | |
8780 | |
1156 | 8781 Printing in Binary ~ |
7 | 8782 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8783 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 8784 :func Nr2Bin(nr) |
7 | 8785 : let n = a:nr |
8786 : let r = "" | |
8787 : while n | |
1156 | 8788 : let r = '01'[n % 2] . r |
8789 : let n = n / 2 | |
7 | 8790 : endwhile |
8791 : return r | |
8792 :endfunc | |
8793 | |
1156 | 8794 :" The function String2Bin() converts each character in a string to a |
8795 :" binary string, separated with dashes. | |
8796 :func String2Bin(str) | |
7 | 8797 : let out = '' |
1156 | 8798 : for ix in range(strlen(a:str)) |
8799 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
8800 : endfor | |
8801 : return out[1:] | |
7 | 8802 :endfunc |
8803 | |
8804 Example of its use: > | |
1156 | 8805 :echo Nr2Bin(32) |
8806 result: "100000" > | |
8807 :echo String2Bin("32") | |
8808 result: "110011-110010" | |
8809 | |
8810 | |
8811 Sorting lines ~ | |
8812 | |
8813 This example sorts lines with a specific compare function. > | |
8814 | |
8815 :func SortBuffer() | |
8816 : let lines = getline(1, '$') | |
8817 : call sort(lines, function("Strcmp")) | |
8818 : call setline(1, lines) | |
7 | 8819 :endfunction |
8820 | |
1156 | 8821 As a one-liner: > |
8822 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
8823 | |
8824 | |
8825 scanf() replacement ~ | |
7 | 8826 *sscanf* |
8827 There is no sscanf() function in Vim. If you need to extract parts from a | |
8828 line, you can use matchstr() and substitute() to do it. This example shows | |
8829 how to get the file name, line number and column number out of a line like | |
8830 "foobar.txt, 123, 45". > | |
8831 :" Set up the match bit | |
8832 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
8833 :"get the part matching the whole expression | |
8834 :let l = matchstr(line, mx) | |
8835 :"get each item out of the match | |
8836 :let file = substitute(l, mx, '\1', '') | |
8837 :let lnum = substitute(l, mx, '\2', '') | |
8838 :let col = substitute(l, mx, '\3', '') | |
8839 | |
8840 The input is in the variable "line", the results in the variables "file", | |
8841 "lnum" and "col". (idea from Michael Geddes) | |
8842 | |
1156 | 8843 |
8844 getting the scriptnames in a Dictionary ~ | |
8845 *scriptnames-dictionary* | |
8846 The |:scriptnames| command can be used to get a list of all script files that | |
8847 have been sourced. There is no equivalent function or variable for this | |
8848 (because it's rarely needed). In case you need to manipulate the list this | |
8849 code can be used: > | |
8850 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
8851 let scriptnames_output = '' | |
8852 redir => scriptnames_output | |
8853 silent scriptnames | |
8854 redir END | |
8855 | |
1621 | 8856 " Split the output into lines and parse each line. Add an entry to the |
1156 | 8857 " "scripts" dictionary. |
8858 let scripts = {} | |
8859 for line in split(scriptnames_output, "\n") | |
8860 " Only do non-blank lines. | |
8861 if line =~ '\S' | |
8862 " Get the first number in the line. | |
1621 | 8863 let nr = matchstr(line, '\d\+') |
1156 | 8864 " Get the file name, remove the script number " 123: ". |
1621 | 8865 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 8866 " Add an item to the Dictionary |
1621 | 8867 let scripts[nr] = name |
1156 | 8868 endif |
8869 endfor | |
8870 unlet scriptnames_output | |
8871 | |
7 | 8872 ============================================================================== |
8873 10. No +eval feature *no-eval-feature* | |
8874 | |
8875 When the |+eval| feature was disabled at compile time, none of the expression | |
8876 evaluation commands are available. To prevent this from causing Vim scripts | |
8877 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
8878 recognized, though the argument of the ":if" and everything between the ":if" | |
8879 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
8880 only if the commands are at the start of the line. The ":else" command is not | |
8881 recognized. | |
8882 | |
8883 Example of how to avoid executing commands when the |+eval| feature is | |
8884 missing: > | |
8885 | |
8886 :if 1 | |
8887 : echo "Expression evaluation is compiled in" | |
8888 :else | |
8889 : echo "You will _never_ see this message" | |
8890 :endif | |
8891 | |
8892 ============================================================================== | |
8893 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
8894 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8895 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
|
8896 '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
|
8897 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
|
8898 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
|
8899 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 8900 The sandbox is also used for the |:sandbox| command. |
7 | 8901 |
8902 These items are not allowed in the sandbox: | |
8903 - changing the buffer text | |
8904 - defining or changing mapping, autocommands, functions, user commands | |
8905 - setting certain options (see |option-summary|) | |
1156 | 8906 - setting certain v: variables (see |v:var|) *E794* |
7 | 8907 - executing a shell command |
8908 - reading or writing a file | |
8909 - jumping to another buffer or editing a file | |
625 | 8910 - executing Python, Perl, etc. commands |
29 | 8911 This is not guaranteed 100% secure, but it should block most attacks. |
8912 | |
8913 *:san* *:sandbox* | |
401 | 8914 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 8915 option that may have been set from a modeline, e.g. |
8916 'foldexpr'. | |
8917 | |
634 | 8918 *sandbox-option* |
8919 A few options contain an expression. When this expression is evaluated it may | |
790 | 8920 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 8921 restrictive, thus this only happens when the option was set from an insecure |
8922 location. Insecure in this context are: | |
843 | 8923 - sourcing a .vimrc or .exrc in the current directory |
634 | 8924 - while executing in the sandbox |
8925 - value coming from a modeline | |
8926 | |
8927 Note that when in the sandbox and saving an option value and restoring it, the | |
8928 option will still be marked as it was set in the sandbox. | |
8929 | |
8930 ============================================================================== | |
8931 12. Textlock *textlock* | |
8932 | |
8933 In a few situations it is not allowed to change the text in the buffer, jump | |
8934 to another window and some other things that might confuse or break what Vim | |
8935 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 8936 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 8937 happen any moment the mouse cursor is resting at some position. |
8938 | |
8939 This is not allowed when the textlock is active: | |
8940 - changing the buffer text | |
8941 - jumping to another buffer or window | |
8942 - editing another file | |
8943 - closing a window or quitting Vim | |
8944 - etc. | |
8945 | |
7 | 8946 |
8947 vim:tw=78:ts=8:ft=help:norl: |