Mercurial > vim
annotate runtime/doc/eval.txt @ 7611:9c420b8db435 v7.4.1105
commit https://github.com/vim/vim/commit/9bbf63dbf8286fadc0cd6b3428010abb67b1b64d
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Jan 16 16:49:28 2016 +0100
patch 7.4.1105
Problem: When using slices there is a mixup of variable name and namespace.
Solution: Recognize variables that can't be a namespace. (Hirohito Higashi)
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sat, 16 Jan 2016 17:00:05 +0100 |
parents | 3012eaddb6b2 |
children | 228ff048db20 |
rev | line source |
---|---|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7593
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Jan 15 |
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* |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
71 Conversion from a String to a Number is done by converting the first digits to |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
72 a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
73 recognized. If the String doesn't start with digits, the result is zero. |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
74 Examples: |
2581 | 75 String "456" --> Number 456 ~ |
76 String "6bar" --> Number 6 ~ | |
77 String "foo" --> Number 0 ~ | |
78 String "0xf1" --> Number 241 ~ | |
79 String "0100" --> Number 64 ~ | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
80 String "0b101" --> Number 5 ~ |
2581 | 81 String "-8" --> Number -8 ~ |
82 String "+8" --> Number 0 ~ | |
7 | 83 |
84 To force conversion from String to Number, add zero to it: > | |
85 :echo "0100" + 0 | |
782 | 86 < 64 ~ |
87 | |
88 To avoid a leading zero to cause octal conversion, or for using a different | |
89 base, use |str2nr()|. | |
7 | 90 |
91 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
92 | |
93 Note that in the command > | |
94 :if "foo" | |
95 "foo" is converted to 0, which means FALSE. To test for a non-empty string, | |
3893 | 96 use empty(): > |
97 :if !empty("foo") | |
153 | 98 < *E745* *E728* *E703* *E729* *E730* *E731* |
99 List, Dictionary and Funcref types are not automatically converted. | |
85 | 100 |
1621 | 101 *E805* *E806* *E808* |
102 When mixing Number and Float the Number is converted to Float. Otherwise | |
103 there is no automatic conversion of Float. You can use str2float() for String | |
104 to Float, printf() for Float to String and float2nr() for Float to Number. | |
105 | |
106 *E706* *sticky-type-checking* | |
85 | 107 You will get an error if you try to change the type of a variable. You need |
108 to |:unlet| it first to avoid this error. String and Number are considered | |
1621 | 109 equivalent though, as well are Float and Number. Consider this sequence of |
110 commands: > | |
85 | 111 :let l = "string" |
87 | 112 :let l = 44 " changes type from String to Number |
1621 | 113 :let l = [1, 2, 3] " error! l is still a Number |
114 :let l = 4.4 " changes type from Number to Float | |
115 :let l = "string" " error! | |
85 | 116 |
117 | |
87 | 118 1.2 Function references ~ |
153 | 119 *Funcref* *E695* *E718* |
1621 | 120 A Funcref variable is obtained with the |function()| function. It can be used |
114 | 121 in an expression in the place of a function name, before the parenthesis |
122 around the arguments, to invoke the function it refers to. Example: > | |
55 | 123 |
124 :let Fn = function("MyFunc") | |
125 :echo Fn() | |
114 | 126 < *E704* *E705* *E707* |
819 | 127 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
5340 | 128 can use "g:" but the following name must still start with a capital. You |
819 | 129 cannot have both a Funcref variable and a function with the same name. |
85 | 130 |
114 | 131 A special case is defining a function and directly assigning its Funcref to a |
132 Dictionary entry. Example: > | |
133 :function dict.init() dict | |
134 : let self.val = 0 | |
135 :endfunction | |
136 | |
137 The key of the Dictionary can start with a lower case letter. The actual | |
138 function name is not used here. Also see |numbered-function|. | |
139 | |
140 A Funcref can also be used with the |:call| command: > | |
141 :call Fn() | |
142 :call dict.init() | |
85 | 143 |
144 The name of the referenced function can be obtained with |string()|. > | |
119 | 145 :let func = string(Fn) |
85 | 146 |
147 You can use |call()| to invoke a Funcref and use a list variable for the | |
148 arguments: > | |
119 | 149 :let r = call(Fn, mylist) |
85 | 150 |
151 | |
87 | 152 1.3 Lists ~ |
5814 | 153 *list* *List* *Lists* *E686* |
55 | 154 A List is an ordered sequence of items. An item can be of any type. Items |
1621 | 155 can be accessed by their index number. Items can be added and removed at any |
55 | 156 position in the sequence. |
157 | |
85 | 158 |
159 List creation ~ | |
160 *E696* *E697* | |
55 | 161 A List is created with a comma separated list of items in square brackets. |
85 | 162 Examples: > |
163 :let mylist = [1, two, 3, "four"] | |
164 :let emptylist = [] | |
55 | 165 |
1621 | 166 An item can be any expression. Using a List for an item creates a |
842 | 167 List of Lists: > |
85 | 168 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 169 |
170 An extra comma after the last item is ignored. | |
171 | |
85 | 172 |
173 List index ~ | |
174 *list-index* *E684* | |
55 | 175 An item in the List can be accessed by putting the index in square brackets |
85 | 176 after the List. Indexes are zero-based, thus the first item has index zero. > |
177 :let item = mylist[0] " get the first item: 1 | |
55 | 178 :let item = mylist[2] " get the third item: 3 |
85 | 179 |
87 | 180 When the resulting item is a list this can be repeated: > |
85 | 181 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 182 < |
85 | 183 A negative index is counted from the end. Index -1 refers to the last item in |
184 the List, -2 to the last but one item, etc. > | |
55 | 185 :let last = mylist[-1] " get the last item: "four" |
186 | |
85 | 187 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 188 is not available it returns zero or the default value you specify: > |
85 | 189 :echo get(mylist, idx) |
190 :echo get(mylist, idx, "NONE") | |
191 | |
192 | |
193 List concatenation ~ | |
194 | |
195 Two lists can be concatenated with the "+" operator: > | |
196 :let longlist = mylist + [5, 6] | |
119 | 197 :let mylist += [7, 8] |
85 | 198 |
199 To prepend or append an item turn the item into a list by putting [] around | |
200 it. To change a list in-place see |list-modification| below. | |
201 | |
202 | |
203 Sublist ~ | |
204 | |
55 | 205 A part of the List can be obtained by specifying the first and last index, |
206 separated by a colon in square brackets: > | |
85 | 207 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 208 |
209 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 210 similar to -1. > |
90 | 211 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
212 :let shortlist = mylist[2:2] " List with one item: [3] | |
213 :let otherlist = mylist[:] " make a copy of the List | |
85 | 214 |
842 | 215 If the first index is beyond the last item of the List or the second item is |
216 before the first item, the result is an empty list. There is no error | |
217 message. | |
218 | |
219 If the second index is equal to or greater than the length of the list the | |
220 length minus one is used: > | |
829 | 221 :let mylist = [0, 1, 2, 3] |
222 :echo mylist[2:8] " result: [2, 3] | |
223 | |
270 | 224 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
1621 | 225 using a single letter variable before the ":". Insert a space when needed: |
270 | 226 mylist[s : e]. |
227 | |
85 | 228 |
229 List identity ~ | |
99 | 230 *list-identity* |
85 | 231 When variable "aa" is a list and you assign it to another variable "bb", both |
232 variables refer to the same list. Thus changing the list "aa" will also | |
233 change "bb": > | |
234 :let aa = [1, 2, 3] | |
235 :let bb = aa | |
236 :call add(aa, 4) | |
237 :echo bb | |
114 | 238 < [1, 2, 3, 4] |
85 | 239 |
240 Making a copy of a list is done with the |copy()| function. Using [:] also | |
241 works, as explained above. This creates a shallow copy of the list: Changing | |
87 | 242 a list item in the list will also change the item in the copied list: > |
85 | 243 :let aa = [[1, 'a'], 2, 3] |
244 :let bb = copy(aa) | |
114 | 245 :call add(aa, 4) |
85 | 246 :let aa[0][1] = 'aaa' |
247 :echo aa | |
114 | 248 < [[1, aaa], 2, 3, 4] > |
85 | 249 :echo bb |
114 | 250 < [[1, aaa], 2, 3] |
85 | 251 |
87 | 252 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 253 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 254 |
255 The operator "is" can be used to check if two variables refer to the same | |
114 | 256 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 257 the same value. > |
258 :let alist = [1, 2, 3] | |
259 :let blist = [1, 2, 3] | |
260 :echo alist is blist | |
114 | 261 < 0 > |
87 | 262 :echo alist == blist |
114 | 263 < 1 |
85 | 264 |
323 | 265 Note about comparing lists: Two lists are considered equal if they have the |
266 same length and all items compare equal, as with using "==". There is one | |
388 | 267 exception: When comparing a number with a string they are considered |
268 different. There is no automatic type conversion, as with using "==" on | |
269 variables. Example: > | |
270 echo 4 == "4" | |
323 | 271 < 1 > |
388 | 272 echo [4] == ["4"] |
323 | 273 < 0 |
274 | |
388 | 275 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 276 can compare simple values this way too by putting them in a list: > |
388 | 277 |
278 :let a = 5 | |
279 :let b = "5" | |
1621 | 280 :echo a == b |
388 | 281 < 1 > |
1621 | 282 :echo [a] == [b] |
388 | 283 < 0 |
323 | 284 |
85 | 285 |
286 List unpack ~ | |
287 | |
288 To unpack the items in a list to individual variables, put the variables in | |
289 square brackets, like list items: > | |
290 :let [var1, var2] = mylist | |
291 | |
292 When the number of variables does not match the number of items in the list | |
293 this produces an error. To handle any extra items from the list append ";" | |
294 and a variable name: > | |
295 :let [var1, var2; rest] = mylist | |
296 | |
297 This works like: > | |
298 :let var1 = mylist[0] | |
299 :let var2 = mylist[1] | |
95 | 300 :let rest = mylist[2:] |
85 | 301 |
302 Except that there is no error if there are only two items. "rest" will be an | |
303 empty list then. | |
304 | |
305 | |
306 List modification ~ | |
307 *list-modification* | |
87 | 308 To change a specific item of a list use |:let| this way: > |
85 | 309 :let list[4] = "four" |
310 :let listlist[0][3] = item | |
311 | |
87 | 312 To change part of a list you can specify the first and last item to be |
114 | 313 modified. The value must at least have the number of items in the range: > |
87 | 314 :let list[3:5] = [3, 4, 5] |
315 | |
85 | 316 Adding and removing items from a list is done with functions. Here are a few |
317 examples: > | |
318 :call insert(list, 'a') " prepend item 'a' | |
319 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
320 :call add(list, "new") " append String item | |
114 | 321 :call add(list, [1, 2]) " append a List as one new item |
85 | 322 :call extend(list, [1, 2]) " extend the list with two more items |
323 :let i = remove(list, 3) " remove item 3 | |
108 | 324 :unlet list[3] " idem |
85 | 325 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 326 :unlet list[3 : ] " idem |
114 | 327 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
328 | |
329 Changing the order of items in a list: > | |
87 | 330 :call sort(list) " sort a list alphabetically |
331 :call reverse(list) " reverse the order of items | |
5747 | 332 :call uniq(sort(list)) " sort and remove duplicates |
87 | 333 |
85 | 334 |
335 For loop ~ | |
336 | |
87 | 337 The |:for| loop executes commands for each item in a list. A variable is set |
338 to each item in the list in sequence. Example: > | |
114 | 339 :for item in mylist |
340 : call Doit(item) | |
85 | 341 :endfor |
342 | |
343 This works like: > | |
344 :let index = 0 | |
345 :while index < len(mylist) | |
114 | 346 : let item = mylist[index] |
347 : :call Doit(item) | |
85 | 348 : let index = index + 1 |
349 :endwhile | |
350 | |
351 Note that all items in the list should be of the same type, otherwise this | |
114 | 352 results in error |E706|. To avoid this |:unlet| the variable at the end of |
87 | 353 the loop. |
85 | 354 |
95 | 355 If all you want to do is modify each item in the list then the |map()| |
114 | 356 function will be a simpler method than a for loop. |
95 | 357 |
1621 | 358 Just like the |:let| command, |:for| also accepts a list of variables. This |
85 | 359 requires the argument to be a list of lists. > |
360 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
361 : call Doit(lnum, col) | |
362 :endfor | |
363 | |
364 This works like a |:let| command is done for each list item. Again, the types | |
365 must remain the same to avoid an error. | |
366 | |
114 | 367 It is also possible to put remaining items in a List variable: > |
85 | 368 :for [i, j; rest] in listlist |
369 : call Doit(i, j) | |
370 : if !empty(rest) | |
371 : echo "remainder: " . string(rest) | |
372 : endif | |
373 :endfor | |
374 | |
375 | |
376 List functions ~ | |
114 | 377 *E714* |
85 | 378 Functions that are useful with a List: > |
87 | 379 :let r = call(funcname, list) " call a function with an argument list |
85 | 380 :if empty(list) " check if list is empty |
102 | 381 :let l = len(list) " number of items in list |
382 :let big = max(list) " maximum value in list | |
383 :let small = min(list) " minimum value in list | |
87 | 384 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
385 :let i = index(list, 'x') " index of first 'x' in list | |
85 | 386 :let lines = getline(1, 10) " get ten text lines from buffer |
387 :call append('$', lines) " append text lines in buffer | |
95 | 388 :let list = split("a b c") " create list from items in a string |
389 :let string = join(list, ', ') " create string from list items | |
102 | 390 :let s = string(list) " String representation of list |
391 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
99 | 392 |
258 | 393 Don't forget that a combination of features can make things simple. For |
394 example, to add up all the numbers in a list: > | |
395 :exe 'let sum = ' . join(nrlist, '+') | |
396 | |
99 | 397 |
398 1.4 Dictionaries ~ | |
5814 | 399 *dict* *Dictionaries* *Dictionary* |
99 | 400 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 401 entry can be located with the key. The entries are stored without a specific |
402 ordering. | |
99 | 403 |
404 | |
405 Dictionary creation ~ | |
114 | 406 *E720* *E721* *E722* *E723* |
99 | 407 A Dictionary is created with a comma separated list of entries in curly |
114 | 408 braces. Each entry has a key and a value, separated by a colon. Each key can |
409 only appear once. Examples: > | |
99 | 410 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
411 :let emptydict = {} | |
114 | 412 < *E713* *E716* *E717* |
99 | 413 A key is always a String. You can use a Number, it will be converted to a |
414 String automatically. Thus the String '4' and the number 4 will find the same | |
1621 | 415 entry. Note that the String '04' and the Number 04 are different, since the |
114 | 416 Number will be converted to the String '4'. |
417 | |
1621 | 418 A value can be any expression. Using a Dictionary for a value creates a |
99 | 419 nested Dictionary: > |
420 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
421 | |
422 An extra comma after the last entry is ignored. | |
423 | |
424 | |
425 Accessing entries ~ | |
426 | |
427 The normal way to access an entry is by putting the key in square brackets: > | |
428 :let val = mydict["one"] | |
429 :let mydict["four"] = 4 | |
430 | |
114 | 431 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 432 |
433 For keys that consist entirely of letters, digits and underscore the following | |
434 form can be used |expr-entry|: > | |
435 :let val = mydict.one | |
436 :let mydict.four = 4 | |
437 | |
438 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
439 key lookup can be repeated: > | |
114 | 440 :echo dict.key[idx].key |
99 | 441 |
442 | |
443 Dictionary to List conversion ~ | |
444 | |
1621 | 445 You may want to loop over the entries in a dictionary. For this you need to |
99 | 446 turn the Dictionary into a List and pass it to |:for|. |
447 | |
448 Most often you want to loop over the keys, using the |keys()| function: > | |
449 :for key in keys(mydict) | |
450 : echo key . ': ' . mydict[key] | |
451 :endfor | |
452 | |
453 The List of keys is unsorted. You may want to sort them first: > | |
454 :for key in sort(keys(mydict)) | |
455 | |
456 To loop over the values use the |values()| function: > | |
457 :for v in values(mydict) | |
458 : echo "value: " . v | |
459 :endfor | |
460 | |
461 If you want both the key and the value use the |items()| function. It returns | |
1621 | 462 a List in which each item is a List with two items, the key and the value: > |
1156 | 463 :for [key, value] in items(mydict) |
464 : echo key . ': ' . value | |
99 | 465 :endfor |
466 | |
467 | |
468 Dictionary identity ~ | |
161 | 469 *dict-identity* |
99 | 470 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
471 Dictionary. Otherwise, assignment results in referring to the same | |
472 Dictionary: > | |
473 :let onedict = {'a': 1, 'b': 2} | |
474 :let adict = onedict | |
475 :let adict['a'] = 11 | |
476 :echo onedict['a'] | |
477 11 | |
478 | |
327 | 479 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
480 more info see |list-identity|. | |
99 | 481 |
482 | |
483 Dictionary modification ~ | |
484 *dict-modification* | |
485 To change an already existing entry of a Dictionary, or to add a new entry, | |
486 use |:let| this way: > | |
487 :let dict[4] = "four" | |
488 :let dict['one'] = item | |
489 | |
108 | 490 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
491 Three ways to remove the entry with key "aaa" from dict: > | |
492 :let i = remove(dict, 'aaa') | |
493 :unlet dict.aaa | |
494 :unlet dict['aaa'] | |
99 | 495 |
496 Merging a Dictionary with another is done with |extend()|: > | |
114 | 497 :call extend(adict, bdict) |
498 This extends adict with all entries from bdict. Duplicate keys cause entries | |
499 in adict to be overwritten. An optional third argument can change this. | |
119 | 500 Note that the order of entries in a Dictionary is irrelevant, thus don't |
501 expect ":echo adict" to show the items from bdict after the older entries in | |
502 adict. | |
99 | 503 |
504 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 505 :call filter(dict, 'v:val =~ "x"') |
114 | 506 This removes all entries from "dict" with a value not matching 'x'. |
102 | 507 |
508 | |
509 Dictionary function ~ | |
4159 | 510 *Dictionary-function* *self* *E725* *E862* |
102 | 511 When a function is defined with the "dict" attribute it can be used in a |
1621 | 512 special way with a dictionary. Example: > |
102 | 513 :function Mylen() dict |
114 | 514 : return len(self.data) |
102 | 515 :endfunction |
114 | 516 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
517 :echo mydict.len() | |
102 | 518 |
519 This is like a method in object oriented programming. The entry in the | |
520 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
521 the function was invoked from. | |
522 | |
114 | 523 It is also possible to add a function without the "dict" attribute as a |
524 Funcref to a Dictionary, but the "self" variable is not available then. | |
525 | |
819 | 526 *numbered-function* *anonymous-function* |
102 | 527 To avoid the extra name for the function it can be defined and directly |
528 assigned to a Dictionary in this way: > | |
114 | 529 :let mydict = {'data': [0, 1, 2, 3]} |
6741 | 530 :function mydict.len() |
114 | 531 : return len(self.data) |
102 | 532 :endfunction |
114 | 533 :echo mydict.len() |
534 | |
535 The function will then get a number and the value of dict.len is a |Funcref| | |
1621 | 536 that references this function. The function can only be used through a |
114 | 537 |Funcref|. It will automatically be deleted when there is no |Funcref| |
538 remaining that refers to it. | |
539 | |
540 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 541 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
542 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
|
543 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
|
544 :function {42} |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
545 |
102 | 546 |
547 Functions for Dictionaries ~ | |
114 | 548 *E715* |
549 Functions that can be used with a Dictionary: > | |
102 | 550 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
551 :if empty(dict) " TRUE if dict is empty | |
552 :let l = len(dict) " number of items in dict | |
553 :let big = max(dict) " maximum value in dict | |
554 :let small = min(dict) " minimum value in dict | |
555 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
556 :let s = string(dict) " String representation of dict | |
557 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
99 | 558 |
559 | |
560 1.5 More about variables ~ | |
85 | 561 *more-variables* |
7 | 562 If you need to know the type of a variable or expression, use the |type()| |
563 function. | |
564 | |
565 When the '!' flag is included in the 'viminfo' option, global variables that | |
566 start with an uppercase letter, and don't contain a lowercase letter, are | |
567 stored in the viminfo file |viminfo-file|. | |
568 | |
569 When the 'sessionoptions' option contains "global", global variables that | |
570 start with an uppercase letter and contain at least one lowercase letter are | |
571 stored in the session file |session-file|. | |
572 | |
573 variable name can be stored where ~ | |
574 my_var_6 not | |
575 My_Var_6 session file | |
576 MY_VAR_6 viminfo file | |
577 | |
578 | |
579 It's possible to form a variable name with curly braces, see | |
580 |curly-braces-names|. | |
581 | |
582 ============================================================================== | |
583 2. Expression syntax *expression-syntax* | |
584 | |
585 Expression syntax summary, from least to most significant: | |
586 | |
587 |expr1| expr2 ? expr1 : expr1 if-then-else | |
588 | |
589 |expr2| expr3 || expr3 .. logical OR | |
590 | |
591 |expr3| expr4 && expr4 .. logical AND | |
592 | |
593 |expr4| expr5 == expr5 equal | |
594 expr5 != expr5 not equal | |
595 expr5 > expr5 greater than | |
596 expr5 >= expr5 greater than or equal | |
597 expr5 < expr5 smaller than | |
598 expr5 <= expr5 smaller than or equal | |
599 expr5 =~ expr5 regexp matches | |
600 expr5 !~ expr5 regexp doesn't match | |
601 | |
602 expr5 ==? expr5 equal, ignoring case | |
603 expr5 ==# expr5 equal, match case | |
604 etc. As above, append ? for ignoring case, # for | |
605 matching case | |
606 | |
685 | 607 expr5 is expr5 same |List| instance |
608 expr5 isnot expr5 different |List| instance | |
79 | 609 |
610 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 611 expr6 - expr6 .. number subtraction |
612 expr6 . expr6 .. string concatenation | |
613 | |
614 |expr6| expr7 * expr7 .. number multiplication | |
615 expr7 / expr7 .. number division | |
616 expr7 % expr7 .. number modulo | |
617 | |
618 |expr7| ! expr7 logical NOT | |
619 - expr7 unary minus | |
620 + expr7 unary plus | |
102 | 621 |
685 | 622 |expr8| expr8[expr1] byte of a String or item of a |List| |
623 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
624 expr8.name entry in a |Dictionary| | |
625 expr8(expr1, ...) function call with |Funcref| variable | |
102 | 626 |
627 |expr9| number number constant | |
26 | 628 "string" string constant, backslash is special |
99 | 629 'string' string constant, ' is doubled |
685 | 630 [expr1, ...] |List| |
631 {expr1: expr1, ...} |Dictionary| | |
7 | 632 &option option value |
633 (expr1) nested expression | |
634 variable internal variable | |
635 va{ria}ble internal variable with curly braces | |
636 $VAR environment variable | |
637 @r contents of register 'r' | |
638 function(expr1, ...) function call | |
639 func{ti}on(expr1, ...) function call with curly braces | |
640 | |
641 | |
642 ".." indicates that the operations in this level can be concatenated. | |
643 Example: > | |
644 &nu || &list && &shell == "csh" | |
645 | |
646 All expressions within one level are parsed from left to right. | |
647 | |
648 | |
649 expr1 *expr1* *E109* | |
650 ----- | |
651 | |
652 expr2 ? expr1 : expr1 | |
653 | |
654 The expression before the '?' is evaluated to a number. If it evaluates to | |
655 non-zero, the result is the value of the expression between the '?' and ':', | |
656 otherwise the result is the value of the expression after the ':'. | |
657 Example: > | |
658 :echo lnum == 1 ? "top" : lnum | |
659 | |
660 Since the first expression is an "expr2", it cannot contain another ?:. The | |
661 other two expressions can, thus allow for recursive use of ?:. | |
662 Example: > | |
663 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
664 | |
665 To keep this readable, using |line-continuation| is suggested: > | |
666 :echo lnum == 1 | |
667 :\ ? "top" | |
668 :\ : lnum == 1000 | |
669 :\ ? "last" | |
670 :\ : lnum | |
671 | |
1156 | 672 You should always put a space before the ':', otherwise it can be mistaken for |
673 use in a variable such as "a:1". | |
674 | |
7 | 675 |
676 expr2 and expr3 *expr2* *expr3* | |
677 --------------- | |
678 | |
679 *expr-barbar* *expr-&&* | |
680 The "||" and "&&" operators take one argument on each side. The arguments | |
681 are (converted to) Numbers. The result is: | |
682 | |
683 input output ~ | |
684 n1 n2 n1 || n2 n1 && n2 ~ | |
685 zero zero zero zero | |
686 zero non-zero non-zero zero | |
687 non-zero zero non-zero zero | |
688 non-zero non-zero non-zero non-zero | |
689 | |
690 The operators can be concatenated, for example: > | |
691 | |
692 &nu || &list && &shell == "csh" | |
693 | |
694 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
695 | |
696 &nu || (&list && &shell == "csh") | |
697 | |
698 Once the result is known, the expression "short-circuits", that is, further | |
699 arguments are not evaluated. This is like what happens in C. For example: > | |
700 | |
701 let a = 1 | |
702 echo a || b | |
703 | |
704 This is valid even if there is no variable called "b" because "a" is non-zero, | |
705 so the result must be non-zero. Similarly below: > | |
706 | |
707 echo exists("b") && b == "yes" | |
708 | |
709 This is valid whether "b" has been defined or not. The second clause will | |
710 only be evaluated if "b" has been defined. | |
711 | |
712 | |
713 expr4 *expr4* | |
714 ----- | |
715 | |
716 expr5 {cmp} expr5 | |
717 | |
718 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
719 if it evaluates to true. | |
720 | |
1621 | 721 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 722 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
723 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
724 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
725 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
726 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 727 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
728 *expr-is?* *expr-isnot?* | |
7 | 729 use 'ignorecase' match case ignore case ~ |
730 equal == ==# ==? | |
731 not equal != !=# !=? | |
732 greater than > ># >? | |
733 greater than or equal >= >=# >=? | |
734 smaller than < <# <? | |
735 smaller than or equal <= <=# <=? | |
736 regexp matches =~ =~# =~? | |
737 regexp doesn't match !~ !~# !~? | |
2908 | 738 same instance is is# is? |
739 different instance isnot isnot# isnot? | |
7 | 740 |
741 Examples: | |
742 "abc" ==# "Abc" evaluates to 0 | |
743 "abc" ==? "Abc" evaluates to 1 | |
744 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
745 | |
85 | 746 *E691* *E692* |
685 | 747 A |List| can only be compared with a |List| and only "equal", "not equal" and |
748 "is" can be used. This compares the values of the list, recursively. | |
749 Ignoring case means case is ignored when comparing item values. | |
79 | 750 |
114 | 751 *E735* *E736* |
685 | 752 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
753 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
114 | 754 recursively. Ignoring case means case is ignored when comparing item values. |
755 | |
85 | 756 *E693* *E694* |
685 | 757 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
758 equal" can be used. Case is never ignored. | |
759 | |
2908 | 760 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
761 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
762 of a |List| is different from the original |List|. When using "is" without | |
763 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
764 equivalent to using "not equal". Except that a different type means the | |
765 values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is | |
3830 | 766 false and not an error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match |
2908 | 767 and ignore case. |
79 | 768 |
7 | 769 When comparing a String with a Number, the String is converted to a Number, |
1621 | 770 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
7 | 771 because 'x' converted to a Number is zero. |
772 | |
773 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
774 results in the mathematical difference (comparing byte values), not | |
775 necessarily the alphabetical difference in the local language. | |
776 | |
1621 | 777 When using the operators with a trailing '#', or the short version and |
1156 | 778 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 779 |
780 When using the operators with a trailing '?', or the short version and | |
1156 | 781 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
782 | |
783 'smartcase' is not used. | |
7 | 784 |
785 The "=~" and "!~" operators match the lefthand argument with the righthand | |
786 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
787 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
788 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
789 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
790 single-quote string, see |literal-string|. | |
791 Since a string is considered to be a single line, a multi-line pattern | |
792 (containing \n, backslash-n) will not match. However, a literal NL character | |
793 can be matched like an ordinary character. Examples: | |
794 "foo\nbar" =~ "\n" evaluates to 1 | |
795 "foo\nbar" =~ "\\n" evaluates to 0 | |
796 | |
797 | |
798 expr5 and expr6 *expr5* *expr6* | |
799 --------------- | |
685 | 800 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 801 expr6 - expr6 .. Number subtraction *expr--* |
802 expr6 . expr6 .. String concatenation *expr-.* | |
803 | |
692 | 804 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 805 result is a new list with the two lists Concatenated. |
79 | 806 |
3214 | 807 expr7 * expr7 .. Number multiplication *expr-star* |
808 expr7 / expr7 .. Number division *expr-/* | |
809 expr7 % expr7 .. Number modulo *expr-%* | |
7 | 810 |
811 For all, except ".", Strings are converted to Numbers. | |
3214 | 812 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 813 |
814 Note the difference between "+" and ".": | |
815 "123" + "456" = 579 | |
816 "123" . "456" = "123456" | |
817 | |
1621 | 818 Since '.' has the same precedence as '+' and '-', you need to read: > |
819 1 . 90 + 90.0 | |
820 As: > | |
821 (1 . 90) + 90.0 | |
822 That works, since the String "190" is automatically converted to the Number | |
823 190, which can be added to the Float 90.0. However: > | |
824 1 . 90 * 90.0 | |
825 Should be read as: > | |
826 1 . (90 * 90.0) | |
827 Since '.' has lower precedence than '*'. This does NOT work, since this | |
828 attempts to concatenate a Float and a String. | |
829 | |
830 When dividing a Number by zero the result depends on the value: | |
831 0 / 0 = -0x80000000 (like NaN for Float) | |
832 >0 / 0 = 0x7fffffff (like positive infinity) | |
833 <0 / 0 = -0x7fffffff (like negative infinity) | |
834 (before Vim 7.2 it was always 0x7fffffff) | |
835 | |
7 | 836 When the righthand side of '%' is zero, the result is 0. |
837 | |
685 | 838 None of these work for |Funcref|s. |
79 | 839 |
1621 | 840 . and % do not work for Float. *E804* |
841 | |
7 | 842 |
843 expr7 *expr7* | |
844 ----- | |
845 ! expr7 logical NOT *expr-!* | |
846 - expr7 unary minus *expr-unary--* | |
847 + expr7 unary plus *expr-unary-+* | |
848 | |
849 For '!' non-zero becomes zero, zero becomes one. | |
850 For '-' the sign of the number is changed. | |
851 For '+' the number is unchanged. | |
852 | |
853 A String will be converted to a Number first. | |
854 | |
1621 | 855 These three can be repeated and mixed. Examples: |
7 | 856 !-1 == 0 |
857 !!8 == 1 | |
858 --9 == 9 | |
859 | |
860 | |
861 expr8 *expr8* | |
862 ----- | |
685 | 863 expr8[expr1] item of String or |List| *expr-[]* *E111* |
102 | 864 |
865 If expr8 is a Number or String this results in a String that contains the | |
866 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
|
867 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
868 an alternative. |
55 | 869 |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
870 Index zero gives the first byte. This is like it works in C. Careful: |
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
871 text column numbers start with one! Example, to get the byte under the |
55 | 872 cursor: > |
823 | 873 :let c = getline(".")[col(".") - 1] |
7 | 874 |
875 If the length of the String is less than the index, the result is an empty | |
55 | 876 String. A negative index always results in an empty string (reason: backwards |
877 compatibility). Use [-1:] to get the last byte. | |
878 | |
685 | 879 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 880 for possible index values. If the index is out of range this results in an |
1621 | 881 error. Example: > |
55 | 882 :let item = mylist[-1] " get last item |
883 | |
685 | 884 Generally, if a |List| index is equal to or higher than the length of the |
885 |List|, or more negative than the length of the |List|, this results in an | |
886 error. | |
55 | 887 |
99 | 888 |
102 | 889 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
890 | |
891 If expr8 is a Number or String this results in the substring with the bytes | |
892 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
|
893 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
|
894 |byteidx()| for computing the indexes. |
55 | 895 |
896 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
897 string minus one is used. | |
898 | |
899 A negative number can be used to measure from the end of the string. -1 is | |
900 the last character, -2 the last but one, etc. | |
901 | |
902 If an index goes out of range for the string characters are omitted. If | |
903 expr1b is smaller than expr1a the result is an empty string. | |
904 | |
905 Examples: > | |
906 :let c = name[-1:] " last byte of a string | |
907 :let c = name[-2:-2] " last but one byte of a string | |
908 :let s = line(".")[4:] " from the fifth byte to the end | |
909 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
910 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
911 *sublist* *slice* |
685 | 912 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 913 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 914 just above, except that indexes out of range cause an error. Examples: > |
55 | 915 :let l = mylist[:3] " first four items |
916 :let l = mylist[4:4] " List with one item | |
917 :let l = mylist[:] " shallow copy of a List | |
918 | |
685 | 919 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
920 error. | |
921 | |
922 | |
923 expr8.name entry in a |Dictionary| *expr-entry* | |
924 | |
925 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
926 name will be used as a key in the |Dictionary|. This is just like: | |
927 expr8[name]. | |
99 | 928 |
929 The name must consist of alphanumeric characters, just like a variable name, | |
930 but it may start with a number. Curly braces cannot be used. | |
931 | |
932 There must not be white space before or after the dot. | |
933 | |
934 Examples: > | |
935 :let dict = {"one": 1, 2: "two"} | |
936 :echo dict.one | |
937 :echo dict .2 | |
938 | |
939 Note that the dot is also used for String concatenation. To avoid confusion | |
940 always put spaces around the dot for String concatenation. | |
941 | |
942 | |
685 | 943 expr8(expr1, ...) |Funcref| function call |
102 | 944 |
945 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
946 | |
947 | |
948 | |
949 *expr9* | |
7 | 950 number |
951 ------ | |
3224 | 952 number number constant *expr-number* |
953 *hex-number* *octal-number* | |
7 | 954 |
955 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
956 | |
1621 | 957 *floating-point-format* |
958 Floating point numbers can be written in two forms: | |
959 | |
960 [-+]{N}.{M} | |
6530 | 961 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 962 |
963 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
964 contain digits. | |
965 [-+] means there is an optional plus or minus sign. | |
966 {exp} is the exponent, power of 10. | |
967 Only a decimal point is accepted, not a comma. No matter what the current | |
968 locale is. | |
969 {only when compiled with the |+float| feature} | |
970 | |
971 Examples: | |
972 123.456 | |
973 +0.0001 | |
974 55.0 | |
975 -0.123 | |
976 1.234e03 | |
977 1.0E-6 | |
978 -3.1416e+88 | |
979 | |
980 These are INVALID: | |
981 3. empty {M} | |
982 1e40 missing .{M} | |
983 | |
1698 | 984 *float-pi* *float-e* |
985 A few useful values to copy&paste: > | |
986 :let pi = 3.14159265359 | |
987 :let e = 2.71828182846 | |
988 | |
1621 | 989 Rationale: |
990 Before floating point was introduced, the text "123.456" was interpreted as | |
991 the two numbers "123" and "456", both converted to a string and concatenated, | |
992 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 993 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 994 incompatibility was accepted in favor of being able to use the normal notation |
995 for floating point numbers. | |
996 | |
997 *floating-point-precision* | |
998 The precision and range of floating points numbers depends on what "double" | |
999 means in the library Vim was compiled with. There is no way to change this at | |
1000 runtime. | |
1001 | |
1002 The default for displaying a |Float| is to use 6 decimal places, like using | |
1003 printf("%g", f). You can select something else when using the |printf()| | |
1004 function. Example: > | |
1005 :echo printf('%.15e', atan(1)) | |
1006 < 7.853981633974483e-01 | |
1007 | |
1008 | |
7 | 1009 |
6884 | 1010 string *string* *String* *expr-string* *E114* |
7 | 1011 ------ |
1012 "string" string constant *expr-quote* | |
1013 | |
1014 Note that double quotes are used. | |
1015 | |
1016 A string constant accepts these special characters: | |
1017 \... three-digit octal number (e.g., "\316") | |
1018 \.. two-digit octal number (must be followed by non-digit) | |
1019 \. one-digit octal number (must be followed by non-digit) | |
1020 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1021 \x. byte specified with one hex number (must be followed by non-hex char) | |
1022 \X.. same as \x.. | |
1023 \X. same as \x. | |
1621 | 1024 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1025 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1026 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1027 \b backspace <BS> |
1028 \e escape <Esc> | |
1029 \f formfeed <FF> | |
1030 \n newline <NL> | |
1031 \r return <CR> | |
1032 \t tab <Tab> | |
1033 \\ backslash | |
1034 \" double quote | |
2152 | 1035 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1036 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1037 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1038 |
1156 | 1039 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1040 encodings. Use "\u00ff" to store character 255 according to the current value | |
1041 of 'encoding'. | |
1042 | |
7 | 1043 Note that "\000" and "\x00" force the end of the string. |
1044 | |
1045 | |
1046 literal-string *literal-string* *E115* | |
1047 --------------- | |
26 | 1048 'string' string constant *expr-'* |
7 | 1049 |
1050 Note that single quotes are used. | |
1051 | |
1621 | 1052 This string is taken as it is. No backslashes are removed or have a special |
99 | 1053 meaning. The only exception is that two quotes stand for one quote. |
26 | 1054 |
1055 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1056 to be doubled. These two commands are equivalent: > |
26 | 1057 if a =~ "\\s*" |
1058 if a =~ '\s*' | |
7 | 1059 |
1060 | |
1061 option *expr-option* *E112* *E113* | |
1062 ------ | |
1063 &option option value, local value if possible | |
1064 &g:option global option value | |
1065 &l:option local option value | |
1066 | |
1067 Examples: > | |
1068 echo "tabstop is " . &tabstop | |
1069 if &insertmode | |
1070 | |
1071 Any option name can be used here. See |options|. When using the local value | |
1072 and there is no buffer-local or window-local value, the global value is used | |
1073 anyway. | |
1074 | |
1075 | |
1156 | 1076 register *expr-register* *@r* |
7 | 1077 -------- |
1078 @r contents of register 'r' | |
1079 | |
1080 The result is the contents of the named register, as a single string. | |
1081 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1082 register use @" or @@. See |registers| for an explanation of the available |
336 | 1083 registers. |
1084 | |
1085 When using the '=' register you get the expression itself, not what it | |
1086 evaluates to. Use |eval()| to evaluate it. | |
7 | 1087 |
1088 | |
1089 nesting *expr-nesting* *E110* | |
1090 ------- | |
1091 (expr1) nested expression | |
1092 | |
1093 | |
1094 environment variable *expr-env* | |
1095 -------------------- | |
1096 $VAR environment variable | |
1097 | |
1098 The String value of any environment variable. When it is not defined, the | |
1099 result is an empty string. | |
1100 *expr-env-expand* | |
1101 Note that there is a difference between using $VAR directly and using | |
1102 expand("$VAR"). Using it directly will only expand environment variables that | |
1103 are known inside the current Vim session. Using expand() will first try using | |
1104 the environment variables known inside the current Vim session. If that | |
1105 fails, a shell will be used to expand the variable. This can be slow, but it | |
1106 does expand all variables that the shell knows about. Example: > | |
6180 | 1107 :echo $shell |
1108 :echo expand("$shell") | |
1109 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1110 variable (if your shell supports it). |
1111 | |
1112 | |
1113 internal variable *expr-variable* | |
1114 ----------------- | |
1115 variable internal variable | |
1116 See below |internal-variables|. | |
1117 | |
1118 | |
170 | 1119 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1120 ------------- |
1121 function(expr1, ...) function call | |
1122 See below |functions|. | |
1123 | |
1124 | |
1125 ============================================================================== | |
2596 | 1126 3. Internal variable *internal-variables* *E461* |
1127 | |
7 | 1128 An internal variable name can be made up of letters, digits and '_'. But it |
1129 cannot start with a digit. It's also possible to use curly braces, see | |
1130 |curly-braces-names|. | |
1131 | |
1132 An internal variable is created with the ":let" command |:let|. | |
87 | 1133 An internal variable is explicitly destroyed with the ":unlet" command |
1134 |:unlet|. | |
1135 Using a name that is not an internal variable or refers to a variable that has | |
1136 been destroyed results in an error. | |
7 | 1137 |
1138 There are several name spaces for variables. Which one is to be used is | |
1139 specified by what is prepended: | |
1140 | |
1141 (nothing) In a function: local to a function; otherwise: global | |
1142 |buffer-variable| b: Local to the current buffer. | |
1143 |window-variable| w: Local to the current window. | |
819 | 1144 |tabpage-variable| t: Local to the current tab page. |
7 | 1145 |global-variable| g: Global. |
1146 |local-variable| l: Local to a function. | |
1147 |script-variable| s: Local to a |:source|'ed Vim script. | |
1148 |function-argument| a: Function argument (only inside a function). | |
5815 | 1149 |vim-variable| v: Global, predefined by Vim. |
7 | 1150 |
685 | 1151 The scope name by itself can be used as a |Dictionary|. For example, to |
1152 delete all script-local variables: > | |
133 | 1153 :for k in keys(s:) |
1154 : unlet s:[k] | |
1155 :endfor | |
1156 < | |
4358 | 1157 *buffer-variable* *b:var* *b:* |
7 | 1158 A variable name that is preceded with "b:" is local to the current buffer. |
1159 Thus you can have several "b:foo" variables, one for each buffer. | |
1160 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1161 |:bdelete|. | |
1162 | |
1163 One local buffer variable is predefined: | |
4264 | 1164 *b:changedtick* *changetick* |
7 | 1165 b:changedtick The total number of changes to the current buffer. It is |
1166 incremented for each change. An undo command is also a change | |
1167 in this case. This can be used to perform an action only when | |
1168 the buffer has changed. Example: > | |
1169 :if my_changedtick != b:changedtick | |
1621 | 1170 : let my_changedtick = b:changedtick |
1171 : call My_Update() | |
7 | 1172 :endif |
1173 < | |
4358 | 1174 *window-variable* *w:var* *w:* |
7 | 1175 A variable name that is preceded with "w:" is local to the current window. It |
1176 is deleted when the window is closed. | |
1177 | |
4437 | 1178 *tabpage-variable* *t:var* *t:* |
819 | 1179 A variable name that is preceded with "t:" is local to the current tab page, |
1180 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
|
1181 without the |+windows| feature} |
819 | 1182 |
4358 | 1183 *global-variable* *g:var* *g:* |
7 | 1184 Inside functions global variables are accessed with "g:". Omitting this will |
1621 | 1185 access a variable local to a function. But "g:" can also be used in any other |
7 | 1186 place if you like. |
1187 | |
4358 | 1188 *local-variable* *l:var* *l:* |
7 | 1189 Inside functions local variables are accessed without prepending anything. |
1156 | 1190 But you can also prepend "l:" if you like. However, without prepending "l:" |
1191 you may run into reserved variable names. For example "count". By itself it | |
1192 refers to "v:count". Using "l:count" you can have a local variable with the | |
1193 same name. | |
7 | 1194 |
1195 *script-variable* *s:var* | |
1196 In a Vim script variables starting with "s:" can be used. They cannot be | |
1197 accessed from outside of the scripts, thus are local to the script. | |
1198 | |
1199 They can be used in: | |
1200 - commands executed while the script is sourced | |
1201 - functions defined in the script | |
1202 - autocommands defined in the script | |
1203 - functions and autocommands defined in functions and autocommands which were | |
1204 defined in the script (recursively) | |
1205 - user defined commands defined in the script | |
1206 Thus not in: | |
1207 - other scripts sourced from this one | |
1208 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1209 - menus |
7 | 1210 - etc. |
1211 | |
1156 | 1212 Script variables can be used to avoid conflicts with global variable names. |
1213 Take this example: > | |
7 | 1214 |
1215 let s:counter = 0 | |
1216 function MyCounter() | |
1217 let s:counter = s:counter + 1 | |
1218 echo s:counter | |
1219 endfunction | |
1220 command Tick call MyCounter() | |
1221 | |
1222 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1223 that script will not be changed, only the "s:counter" in the script where | |
1224 "Tick" was defined is used. | |
1225 | |
1226 Another example that does the same: > | |
1227 | |
1228 let s:counter = 0 | |
1229 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1230 | |
1231 When calling a function and invoking a user-defined command, the context for | |
9 | 1232 script variables is set to the script where the function or command was |
7 | 1233 defined. |
1234 | |
1235 The script variables are also available when a function is defined inside a | |
1236 function that is defined in a script. Example: > | |
1237 | |
1238 let s:counter = 0 | |
1239 function StartCounting(incr) | |
1240 if a:incr | |
1241 function MyCounter() | |
1242 let s:counter = s:counter + 1 | |
1243 endfunction | |
1244 else | |
1245 function MyCounter() | |
1246 let s:counter = s:counter - 1 | |
1247 endfunction | |
1248 endif | |
1249 endfunction | |
1250 | |
1251 This defines the MyCounter() function either for counting up or counting down | |
1252 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1253 called, the s:counter variable will be accessible in MyCounter(). | |
1254 | |
1255 When the same script is sourced again it will use the same script variables. | |
1256 They will remain valid as long as Vim is running. This can be used to | |
1257 maintain a counter: > | |
1258 | |
1259 if !exists("s:counter") | |
1260 let s:counter = 1 | |
1261 echo "script executed for the first time" | |
1262 else | |
1263 let s:counter = s:counter + 1 | |
1264 echo "script executed " . s:counter . " times now" | |
1265 endif | |
1266 | |
1267 Note that this means that filetype plugins don't get a different set of script | |
1268 variables for each buffer. Use local buffer variables instead |b:var|. | |
1269 | |
1270 | |
4358 | 1271 Predefined Vim variables: *vim-variable* *v:var* *v:* |
7 | 1272 |
189 | 1273 *v:beval_col* *beval_col-variable* |
1274 v:beval_col The number of the column, over which the mouse pointer is. | |
1275 This is the byte index in the |v:beval_lnum| line. | |
1276 Only valid while evaluating the 'balloonexpr' option. | |
1277 | |
1278 *v:beval_bufnr* *beval_bufnr-variable* | |
1279 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1280 valid while evaluating the 'balloonexpr' option. | |
1281 | |
1282 *v:beval_lnum* *beval_lnum-variable* | |
1283 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1284 valid while evaluating the 'balloonexpr' option. | |
1285 | |
1286 *v:beval_text* *beval_text-variable* | |
374 | 1287 v:beval_text The text under or after the mouse pointer. Usually a word as |
1288 it is useful for debugging a C program. 'iskeyword' applies, | |
1289 but a dot and "->" before the position is included. When on a | |
1290 ']' the text before it is used, including the matching '[' and | |
189 | 1291 word before it. When on a Visual area within one line the |
1292 highlighted text is used. | |
1293 Only valid while evaluating the 'balloonexpr' option. | |
1294 | |
1295 *v:beval_winnr* *beval_winnr-variable* | |
1296 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1297 valid while evaluating the 'balloonexpr' option. The first |
1298 window has number zero (unlike most other places where a | |
1299 window gets a number). | |
189 | 1300 |
844 | 1301 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1302 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
|
1303 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
|
1304 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1305 |
7 | 1306 *v:charconvert_from* *charconvert_from-variable* |
1307 v:charconvert_from | |
1308 The name of the character encoding of a file to be converted. | |
1309 Only valid while evaluating the 'charconvert' option. | |
1310 | |
1311 *v:charconvert_to* *charconvert_to-variable* | |
1312 v:charconvert_to | |
1313 The name of the character encoding of a file after conversion. | |
1314 Only valid while evaluating the 'charconvert' option. | |
1315 | |
1316 *v:cmdarg* *cmdarg-variable* | |
1317 v:cmdarg This variable is used for two purposes: | |
1318 1. The extra arguments given to a file read/write command. | |
1319 Currently these are "++enc=" and "++ff=". This variable is | |
1320 set before an autocommand event for a file read/write | |
1321 command is triggered. There is a leading space to make it | |
1322 possible to append this variable directly after the | |
1621 | 1323 read/write command. Note: The "+cmd" argument isn't |
7 | 1324 included here, because it will be executed anyway. |
1325 2. When printing a PostScript file with ":hardcopy" this is | |
1326 the argument for the ":hardcopy" command. This can be used | |
1327 in 'printexpr'. | |
1328 | |
1329 *v:cmdbang* *cmdbang-variable* | |
1330 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1331 was used the value is 1, otherwise it is 0. Note that this | |
1332 can only be used in autocommands. For user commands |<bang>| | |
1333 can be used. | |
1334 | |
6909 | 1335 *v:completed_item* *completed_item-variable* |
1336 v:completed_item | |
1337 |Dictionary| containing the |complete-items| for the most | |
1338 recently completed word after |CompleteDone|. The | |
1339 |Dictionary| is empty if the completion failed. | |
1340 | |
7 | 1341 *v:count* *count-variable* |
1342 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1343 to get the count before a mapping. Read-only. Example: > |
7 | 1344 :map _x :<C-U>echo "the count is " . v:count<CR> |
1345 < Note: The <C-U> is required to remove the line range that you | |
1346 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1347 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1348 just like what happens in the command, "d6w" for the example. |
667 | 1349 Also used for evaluating the 'formatexpr' option. |
7 | 1350 "count" also works, for backwards compatibility. |
1351 | |
1352 *v:count1* *count1-variable* | |
1353 v:count1 Just like "v:count", but defaults to one when no count is | |
1354 used. | |
1355 | |
1356 *v:ctype* *ctype-variable* | |
1357 v:ctype The current locale setting for characters of the runtime | |
1358 environment. This allows Vim scripts to be aware of the | |
1359 current locale encoding. Technical: it's the value of | |
1360 LC_CTYPE. When not using a locale the value is "C". | |
1361 This variable can not be set directly, use the |:language| | |
1362 command. | |
1363 See |multi-lang|. | |
1364 | |
1365 *v:dying* *dying-variable* | |
1621 | 1366 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1367 one. When multiple signals are caught the number increases. |
1368 Can be used in an autocommand to check if Vim didn't | |
1369 terminate normally. {only works on Unix} | |
1370 Example: > | |
1371 :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
|
1372 < 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
|
1373 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
|
1374 |
7 | 1375 *v:errmsg* *errmsg-variable* |
1376 v:errmsg Last given error message. It's allowed to set this variable. | |
1377 Example: > | |
1378 :let v:errmsg = "" | |
1379 :silent! next | |
1380 :if v:errmsg != "" | |
1381 : ... handle error | |
1382 < "errmsg" also works, for backwards compatibility. | |
1383 | |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1384 *v:errors* *errors-variable* |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1385 v:errors Errors found by assert functions, such as |assert_true()|. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1386 This is a list of strings. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1387 The assert functions append an item when an assert fails. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1388 To remove old results make it empty: > |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1389 :let v:errors = [] |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1390 < If v:errors is set to anything but a list it is made an empty |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1391 list by the assert function. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1392 |
7 | 1393 *v:exception* *exception-variable* |
1394 v:exception The value of the exception most recently caught and not | |
1395 finished. See also |v:throwpoint| and |throw-variables|. | |
1396 Example: > | |
1397 :try | |
1398 : throw "oops" | |
1399 :catch /.*/ | |
1400 : echo "caught" v:exception | |
1401 :endtry | |
1402 < Output: "caught oops". | |
1403 | |
179 | 1404 *v:fcs_reason* *fcs_reason-variable* |
1405 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1406 Can be used in an autocommand to decide what to do and/or what | |
1407 to set v:fcs_choice to. Possible values: | |
1408 deleted file no longer exists | |
1409 conflict file contents, mode or timestamp was | |
1410 changed and buffer is modified | |
1411 changed file contents has changed | |
1412 mode mode of file changed | |
1413 time only file timestamp changed | |
1414 | |
1415 *v:fcs_choice* *fcs_choice-variable* | |
1416 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1417 triggered. Can be used in an autocommand to tell Vim what to | |
1418 do with the affected buffer: | |
1419 reload Reload the buffer (does not work if | |
1420 the file was deleted). | |
1421 ask Ask the user what to do, as if there | |
1422 was no autocommand. Except that when | |
1423 only the timestamp changed nothing | |
1424 will happen. | |
1425 <empty> Nothing, the autocommand should do | |
1426 everything that needs to be done. | |
1427 The default is empty. If another (invalid) value is used then | |
1428 Vim behaves like it is empty, there is no warning message. | |
1429 | |
7 | 1430 *v:fname_in* *fname_in-variable* |
579 | 1431 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1432 option used for ~ |
1433 'charconvert' file to be converted | |
1434 'diffexpr' original file | |
1435 'patchexpr' original file | |
1436 'printexpr' file to be printed | |
593 | 1437 And set to the swap file name for |SwapExists|. |
7 | 1438 |
1439 *v:fname_out* *fname_out-variable* | |
1440 v:fname_out The name of the output file. Only valid while | |
1441 evaluating: | |
1442 option used for ~ | |
1443 'charconvert' resulting converted file (*) | |
1444 'diffexpr' output of diff | |
1445 'patchexpr' resulting patched file | |
1446 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1447 file") it will be equal to v:fname_in. When doing conversion |
7 | 1448 for a read command (e.g., ":e file") it will be a temporary |
1449 file and different from v:fname_in. | |
1450 | |
1451 *v:fname_new* *fname_new-variable* | |
1452 v:fname_new The name of the new version of the file. Only valid while | |
1453 evaluating 'diffexpr'. | |
1454 | |
1455 *v:fname_diff* *fname_diff-variable* | |
1456 v:fname_diff The name of the diff (patch) file. Only valid while | |
1457 evaluating 'patchexpr'. | |
1458 | |
1459 *v:folddashes* *folddashes-variable* | |
1460 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1461 fold. | |
29 | 1462 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1463 |
1464 *v:foldlevel* *foldlevel-variable* | |
1465 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1466 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1467 |
1468 *v:foldend* *foldend-variable* | |
1469 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1470 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1471 |
1472 *v:foldstart* *foldstart-variable* | |
1473 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1474 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1475 |
5460 | 1476 *v:hlsearch* *hlsearch-variable* |
6413 | 1477 v:hlsearch Variable that indicates whether search highlighting is on. |
1478 Setting it makes sense only if 'hlsearch' is enabled which | |
1479 requires |+extra_search|. Setting this variable to zero acts | |
1480 the like |:nohlsearch| command, setting it to one acts like > | |
5460 | 1481 let &hlsearch = &hlsearch |
6918 | 1482 < Note that the value is restored when returning from a |
1483 function. |function-search-undo|. | |
1484 | |
11 | 1485 *v:insertmode* *insertmode-variable* |
1486 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1487 events. Values: | |
1488 i Insert mode | |
1489 r Replace mode | |
1490 v Virtual Replace mode | |
1491 | |
102 | 1492 *v:key* *key-variable* |
685 | 1493 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1494 evaluating the expression used with |map()| and |filter()|. |
1495 Read-only. | |
1496 | |
7 | 1497 *v:lang* *lang-variable* |
1498 v:lang The current locale setting for messages of the runtime | |
1499 environment. This allows Vim scripts to be aware of the | |
1500 current language. Technical: it's the value of LC_MESSAGES. | |
1501 The value is system dependent. | |
1502 This variable can not be set directly, use the |:language| | |
1503 command. | |
1504 It can be different from |v:ctype| when messages are desired | |
1505 in a different language than what is used for character | |
1506 encoding. See |multi-lang|. | |
1507 | |
1508 *v:lc_time* *lc_time-variable* | |
1509 v:lc_time The current locale setting for time messages of the runtime | |
1510 environment. This allows Vim scripts to be aware of the | |
1511 current language. Technical: it's the value of LC_TIME. | |
1512 This variable can not be set directly, use the |:language| | |
1513 command. See |multi-lang|. | |
1514 | |
1515 *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
|
1516 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
|
1517 '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
|
1518 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
|
1519 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
|
1520 |sandbox|. |
7 | 1521 |
1029 | 1522 *v:mouse_win* *mouse_win-variable* |
1523 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1524 First window has number 1, like with |winnr()|. The value is | |
1525 zero when there was no mouse button click. | |
1526 | |
1527 *v:mouse_lnum* *mouse_lnum-variable* | |
1528 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1529 This is the text line number, not the screen line number. The | |
1530 value is zero when there was no mouse button click. | |
1531 | |
1532 *v:mouse_col* *mouse_col-variable* | |
1533 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1534 This is the screen column number, like with |virtcol()|. The | |
1535 value is zero when there was no mouse button click. | |
1536 | |
1733 | 1537 *v:oldfiles* *oldfiles-variable* |
1538 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1539 startup. These are the files that Vim remembers marks for. | |
1540 The length of the List is limited by the ' argument of the | |
1541 'viminfo' option (default is 100). | |
5618 | 1542 When the |viminfo| file is not used the List is empty. |
1733 | 1543 Also see |:oldfiles| and |c_#<|. |
1544 The List can be modified, but this has no effect on what is | |
1545 stored in the |viminfo| file later. If you use values other | |
1546 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
|
1547 {only when compiled with the |+viminfo| feature} |
1733 | 1548 |
6935 | 1549 *v:option_new* |
1550 v:option_new New value of the option. Valid while executing an |OptionSet| | |
1551 autocommand. | |
1552 *v:option_old* | |
1553 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
1554 autocommand. | |
1555 *v:option_type* | |
1556 v:option_type Scope of the set command. Valid while executing an | |
1557 |OptionSet| autocommand. Can be either "global" or "local" | |
1490 | 1558 *v:operator* *operator-variable* |
1559 v:operator The last operator given in Normal mode. This is a single | |
1560 character except for commands starting with <g> or <z>, | |
1561 in which case it is two characters. Best used alongside | |
1562 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1563 Operator-pending mode and then use the operator, e.g.: > | |
1564 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1565 < The value remains set until another operator is entered, thus | |
1566 don't expect it to be empty. | |
1567 v:operator is not set for |:delete|, |:yank| or other Ex | |
1568 commands. | |
1569 Read-only. | |
1570 | |
7 | 1571 *v:prevcount* *prevcount-variable* |
1572 v:prevcount The count given for the last but one Normal mode command. | |
1573 This is the v:count value of the previous command. Useful if | |
1490 | 1574 you want to cancel Visual or Operator-pending mode and then |
1575 use the count, e.g.: > | |
7 | 1576 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1577 < Read-only. | |
1578 | |
170 | 1579 *v:profiling* *profiling-variable* |
1621 | 1580 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1581 See |profiling|. |
1582 | |
7 | 1583 *v:progname* *progname-variable* |
1584 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 1585 invoked. Allows you to do special initialisations for |view|, |
1586 |evim| etc., or any other name you might symlink to Vim. | |
7 | 1587 Read-only. |
1588 | |
5780 | 1589 *v:progpath* *progpath-variable* |
1590 v:progpath Contains the command with which Vim was invoked, including the | |
1591 path. Useful if you want to message a Vim server using a | |
1592 |--remote-expr|. | |
5782 | 1593 To get the full path use: > |
1594 echo exepath(v:progpath) | |
1595 < NOTE: This does not work when the command is a relative path | |
1596 and the current directory has changed. | |
5780 | 1597 Read-only. |
1598 | |
7 | 1599 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1600 v:register The name of the register in effect for the current normal mode |
3492 | 1601 command (regardless of whether that command actually used a |
1602 register). Or for the currently executing normal mode mapping | |
1603 (use this in custom commands that take a register). | |
1604 If none is supplied it is the default register '"', unless | |
1605 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
1606 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1607 Also see |getreg()| and |setreg()| |
7 | 1608 |
540 | 1609 *v:scrollstart* *scrollstart-variable* |
1610 v:scrollstart String describing the script or function that caused the | |
1611 screen to scroll up. It's only set when it is empty, thus the | |
1612 first reason is remembered. It is set to "Unknown" for a | |
1613 typed command. | |
1614 This can be used to find out why your script causes the | |
1615 hit-enter prompt. | |
1616 | |
7 | 1617 *v:servername* *servername-variable* |
1618 v:servername The resulting registered |x11-clientserver| name if any. | |
1619 Read-only. | |
1620 | |
1621 | 1621 |
1622 v:searchforward *v:searchforward* *searchforward-variable* | |
1623 Search direction: 1 after a forward search, 0 after a | |
1624 backward search. It is reset to forward when directly setting | |
1625 the last search pattern, see |quote/|. | |
1626 Note that the value is restored when returning from a | |
1627 function. |function-search-undo|. | |
1628 Read-write. | |
1629 | |
7 | 1630 *v:shell_error* *shell_error-variable* |
1631 v:shell_error Result of the last shell command. When non-zero, the last | |
1632 shell command had an error. When zero, there was no problem. | |
1633 This only works when the shell returns the error code to Vim. | |
1634 The value -1 is often used when the command could not be | |
1635 executed. Read-only. | |
1636 Example: > | |
1637 :!mv foo bar | |
1638 :if v:shell_error | |
1639 : echo 'could not rename "foo" to "bar"!' | |
1640 :endif | |
1641 < "shell_error" also works, for backwards compatibility. | |
1642 | |
1643 *v:statusmsg* *statusmsg-variable* | |
1644 v:statusmsg Last given status message. It's allowed to set this variable. | |
1645 | |
579 | 1646 *v:swapname* *swapname-variable* |
1647 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1648 the swap file found. Read-only. | |
1649 | |
1650 *v:swapchoice* *swapchoice-variable* | |
1651 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1652 for handling an existing swap file: | |
1653 'o' Open read-only | |
1654 'e' Edit anyway | |
1655 'r' Recover | |
1656 'd' Delete swapfile | |
1657 'q' Quit | |
1658 'a' Abort | |
1621 | 1659 The value should be a single-character string. An empty value |
579 | 1660 results in the user being asked, as would happen when there is |
1661 no SwapExists autocommand. The default is empty. | |
1662 | |
590 | 1663 *v:swapcommand* *swapcommand-variable* |
625 | 1664 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1665 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1666 another Vim open the file and jump to the right place. For |
590 | 1667 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1668 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1669 |
7 | 1670 *v:termresponse* *termresponse-variable* |
1671 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1672 termcap entry. It is set when Vim receives an escape sequence |
7 | 1673 that starts with ESC [ or CSI and ends in a 'c', with only |
1674 digits, ';' and '.' in between. | |
1675 When this option is set, the TermResponse autocommand event is | |
1676 fired, so that you can react to the response from the | |
1677 terminal. | |
1678 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1679 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1680 patch level (since this was introduced in patch 95, it's | |
1681 always 95 or bigger). Pc is always zero. | |
1682 {only when compiled with |+termresponse| feature} | |
1683 | |
1684 *v:this_session* *this_session-variable* | |
1685 v:this_session Full filename of the last loaded or saved session file. See | |
1686 |:mksession|. It is allowed to set this variable. When no | |
1687 session file has been saved, this variable is empty. | |
1688 "this_session" also works, for backwards compatibility. | |
1689 | |
1690 *v:throwpoint* *throwpoint-variable* | |
1691 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1692 finished was thrown. Not set when commands are typed. See |
7 | 1693 also |v:exception| and |throw-variables|. |
1694 Example: > | |
1695 :try | |
1696 : throw "oops" | |
1697 :catch /.*/ | |
1698 : echo "Exception from" v:throwpoint | |
1699 :endtry | |
1700 < Output: "Exception from test.vim, line 2" | |
1701 | |
102 | 1702 *v:val* *val-variable* |
1621 | 1703 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1704 valid while evaluating the expression used with |map()| and |
102 | 1705 |filter()|. Read-only. |
1706 | |
7 | 1707 *v:version* *version-variable* |
1708 v:version Version number of Vim: Major version number times 100 plus | |
1709 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1710 is 501. Read-only. "version" also works, for backwards | |
1711 compatibility. | |
1712 Use |has()| to check if a certain patch was included, e.g.: > | |
5786 | 1713 if has("patch-7.4.123") |
7 | 1714 < Note that patch numbers are specific to the version, thus both |
1715 version 5.0 and 5.1 may have a patch 123, but these are | |
1716 completely different. | |
1717 | |
1718 *v:warningmsg* *warningmsg-variable* | |
1719 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1720 | |
2609 | 1721 *v:windowid* *windowid-variable* |
1722 v:windowid When any X11 based GUI is running or when running in a | |
1723 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1724 set to the window ID. |
1725 When an MS-Windows GUI is running this will be set to the | |
1726 window handle. | |
1727 Otherwise the value is zero. | |
1728 Note: for windows inside Vim use |winnr()|. | |
2609 | 1729 |
7 | 1730 ============================================================================== |
1731 4. Builtin Functions *functions* | |
1732 | |
1733 See |function-list| for a list grouped by what the function is used for. | |
1734 | |
236 | 1735 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1736 |
1737 USAGE RESULT DESCRIPTION ~ | |
1738 | |
1621 | 1739 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
|
1740 acos( {expr}) Float arc cosine of {expr} |
685 | 1741 add( {list}, {item}) List append {item} to |List| {list} |
7557
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1742 alloc_fail( {id}, {countdown}, {repeat}) |
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1743 none make memory allocation fail |
3214 | 1744 and( {expr}, {expr}) Number bitwise AND |
55 | 1745 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1746 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1747 argc() Number number of files in the argument list |
55 | 1748 argidx() Number current index in the argument list |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1749 arglistid( [{winnr} [, {tabnr}]]) |
5942 | 1750 Number argument list id |
7 | 1751 argv( {nr}) String {nr} entry of the argument list |
818 | 1752 argv( ) List the argument list |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1753 assert_equal( {exp}, {act} [, {msg}]) none assert {exp} equals {act} |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1754 assert_exception({error} [, {msg}]) none assert {error} is in v:exception |
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
1755 assert_fails( {cmd} [, {error}]) none assert {cmd} fails |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1756 assert_false( {actual} [, {msg}]) none assert {actual} is false |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1757 assert_true( {actual} [, {msg}]) none assert {actual} is true |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1758 asin( {expr}) Float arc sine of {expr} |
1621 | 1759 atan( {expr}) Float arc tangent of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1760 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
7 | 1761 browse( {save}, {title}, {initdir}, {default}) |
1762 String put up a file requester | |
1621 | 1763 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1764 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1765 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1766 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1767 bufname( {expr}) String Name of the buffer {expr} |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
1768 bufnr( {expr} [, {create}]) Number Number of the buffer {expr} |
7 | 1769 bufwinnr( {expr}) Number window number of buffer {expr} |
1770 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1771 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
5413 | 1772 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1773 call( {func}, {arglist} [, {dict}]) |
1774 any call {func} with arguments {arglist} | |
1621 | 1775 ceil( {expr}) Float round {expr} up |
1776 changenr() Number current change number | |
4051 | 1777 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
55 | 1778 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1779 clearmatches() none clear all matches |
7 | 1780 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1781 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1782 complete_add( {expr}) Number add completion match |
1621 | 1783 complete_check() Number check for key typed during completion |
7 | 1784 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1785 Number number of choice picked by user | |
55 | 1786 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1787 cos( {expr}) Float cosine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1788 cosh( {expr}) Float hyperbolic cosine of {expr} |
6259 | 1789 count( {list}, {expr} [, {ic} [, {start}]]) |
95 | 1790 Number count how many {expr} are in {list} |
7 | 1791 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1792 Number checks existence of cscope connection | |
6385 | 1793 cursor( {lnum}, {col} [, {off}]) |
1794 Number move cursor to {lnum}, {col}, {off} | |
703 | 1795 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
|
1796 deepcopy( {expr} [, {noref}]) any make a full copy of {expr} |
7 | 1797 delete( {fname}) Number delete file {fname} |
1798 did_filetype() Number TRUE if FileType autocommand event used | |
55 | 1799 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1800 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
85 | 1801 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1802 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1803 eval( {string}) any evaluate {string} into its value |
55 | 1804 eventhandler( ) Number TRUE if inside an event handler |
7 | 1805 executable( {expr}) Number 1 if executable {expr} exists |
5782 | 1806 exepath( {expr}) String full path of the command {expr} |
7 | 1807 exists( {expr}) Number TRUE if {expr} exists |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1808 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1809 List/Dict insert items of {expr2} into {expr1} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1810 exp( {expr}) Float exponential of {expr} |
3398 | 1811 expand( {expr} [, {nosuf} [, {list}]]) |
1812 any expand special keywords in {expr} | |
1621 | 1813 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1814 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1815 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1816 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1817 {string} is 0 | |
95 | 1818 finddir( {name}[, {path}[, {count}]]) |
824 | 1819 String find directory {name} in {path} |
19 | 1820 findfile( {name}[, {path}[, {count}]]) |
824 | 1821 String find file {name} in {path} |
1621 | 1822 float2nr( {expr}) Number convert Float {expr} to a Number |
1823 floor( {expr}) Float round {expr} down | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1824 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
1586 | 1825 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1826 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1827 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1828 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1829 foldlevel( {lnum}) Number fold level at {lnum} |
55 | 1830 foldtext( ) String line displayed for closed fold |
824 | 1831 foldtextresult( {lnum}) String text for closed fold at {lnum} |
7 | 1832 foreground( ) Number bring the Vim window to the foreground |
55 | 1833 function( {name}) Funcref reference to function {name} |
3224 | 1834 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
82 | 1835 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1836 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1837 getbufline( {expr}, {lnum} [, {end}]) |
1838 List lines {lnum} to {end} of buffer {expr} | |
4157 | 1839 getbufvar( {expr}, {varname} [, {def}]) |
1840 any variable {varname} in buffer {expr} | |
55 | 1841 getchar( [expr]) Number get one character from the user |
1842 getcharmod( ) Number modifiers for the last typed character | |
7013 | 1843 getcharsearch() Dict last character search |
7 | 1844 getcmdline() String return the current command-line |
1845 getcmdpos() Number return cursor position in command-line | |
6153 | 1846 getcmdtype() String return current command-line type |
1847 getcmdwintype() String return current command-line window type | |
5944 | 1848 getcurpos() List position of the cursor |
7 | 1849 getcwd() String the current working directory |
5944 | 1850 getfontname( [{name}]) String name of font being used |
20 | 1851 getfperm( {fname}) String file permissions of file {fname} |
1852 getfsize( {fname}) Number size in bytes of file {fname} | |
7 | 1853 getftime( {fname}) Number last modification time of file |
20 | 1854 getftype( {fname}) String description of type of file {fname} |
161 | 1855 getline( {lnum}) String line {lnum} of current buffer |
1856 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
|
1857 getloclist( {nr}) List list of location list items |
1326 | 1858 getmatches() List list of current matches |
1548 | 1859 getpid() Number process ID of Vim |
703 | 1860 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1861 getqflist() List list of quickfix items |
5796 | 1862 getreg( [{regname} [, 1 [, {list}]]]) |
1863 String or List contents of register | |
55 | 1864 getregtype( [{regname}]) String type of register |
4157 | 1865 gettabvar( {nr}, {varname} [, {def}]) |
1866 any variable {varname} in tab {nr} or {def} | |
1867 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
831 | 1868 any {name} in {winnr} in tab page {tabnr} |
7 | 1869 getwinposx() Number X coord in pixels of GUI Vim window |
1870 getwinposy() Number Y coord in pixels of GUI Vim window | |
4157 | 1871 getwinvar( {nr}, {varname} [, {def}]) |
1872 any variable {varname} in window {nr} | |
6663 | 1873 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
3398 | 1874 any expand file wildcards in {expr} |
6697 | 1875 glob2regpat( {expr}) String convert a glob pat into a search pat |
6663 | 1876 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
1754 | 1877 String do glob({expr}) for all dirs in {path} |
7 | 1878 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1879 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
1104 | 1880 haslocaldir() Number TRUE if current window executed |:lcd| |
782 | 1881 hasmapto( {what} [, {mode} [, {abbr}]]) |
1882 Number TRUE if mapping to {what} exists | |
7 | 1883 histadd( {history},{item}) String add an item to a history |
1884 histdel( {history} [, {item}]) String remove an item from a history | |
1885 histget( {history} [, {index}]) String get the item {index} from a history | |
1886 histnr( {history}) Number highest index of a history | |
1887 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1888 hlID( {name}) Number syntax ID of highlight group {name} | |
1889 hostname() String name of the machine Vim is running on | |
55 | 1890 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1891 indent( {lnum}) Number indent of line {lnum} | |
95 | 1892 index( {list}, {expr} [, {start} [, {ic}]]) |
1893 Number index in {list} where {expr} appears | |
531 | 1894 input( {prompt} [, {text} [, {completion}]]) |
1895 String get input from the user | |
7 | 1896 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1897 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1898 inputrestore() Number restore typeahead |
1899 inputsave() Number save and clear typeahead | |
7 | 1900 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1901 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
3214 | 1902 invert( {expr}) Number bitwise invert |
7 | 1903 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1904 islocked( {expr}) Number TRUE if {expr} is locked |
685 | 1905 items( {dict}) List key-value pairs in {dict} |
95 | 1906 join( {list} [, {sep}]) String join {list} items into one String |
685 | 1907 keys( {dict}) List keys in {dict} |
55 | 1908 len( {expr}) Number the length of {expr} |
1909 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1910 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1911 line( {expr}) Number line nr of cursor, last line or mark | |
1912 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1913 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1914 localtime() Number current time |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1915 log( {expr}) Float natural logarithm (base e) of {expr} |
1621 | 1916 log10( {expr}) Float logarithm of Float {expr} to base 10 |
3492 | 1917 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
102 | 1918 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
2610 | 1919 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 1920 String or Dict |
1921 rhs of mapping {name} in mode {mode} | |
782 | 1922 mapcheck( {name}[, {mode} [, {abbr}]]) |
1923 String check for mappings matching {name} | |
19 | 1924 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1925 Number position where {pat} matches in {expr} |
1326 | 1926 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
1927 Number highlight {pattern} with {group} | |
5979 | 1928 matchaddpos( {group}, {list}[, {priority}[, {id}]]) |
1929 Number highlight positions with {group} | |
819 | 1930 matcharg( {nr}) List arguments of |:match| |
1326 | 1931 matchdelete( {id}) Number delete match identified by {id} |
19 | 1932 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1933 Number position where {pat} ends in {expr} |
158 | 1934 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
1935 List match and submatches of {pat} in {expr} | |
19 | 1936 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
1937 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1938 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1939 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1940 mkdir( {name} [, {path} [, {prot}]]) |
168 | 1941 Number create directory {name} |
1621 | 1942 mode( [expr]) String current editing mode |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1943 mzeval( {expr}) any evaluate |MzScheme| expression |
7 | 1944 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
4051 | 1945 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
3214 | 1946 or( {expr}, {expr}) Number bitwise OR |
819 | 1947 pathshorten( {expr}) String shorten directory names in a path |
1621 | 1948 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 1949 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 1950 printf( {fmt}, {expr1}...) String format text |
1951 pumvisible() Number whether popup menu is visible | |
3682 | 1952 pyeval( {expr}) any evaluate |Python| expression |
1953 py3eval( {expr}) any evaluate |python3| expression | |
99 | 1954 range( {expr} [, {max} [, {stride}]]) |
1955 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1956 readfile( {fname} [, {binary} [, {max}]]) |
168 | 1957 List get list of lines from file {fname} |
794 | 1958 reltime( [{start} [, {end}]]) List get time value |
1959 reltimestr( {time}) String turn time value into a String | |
7 | 1960 remote_expr( {server}, {string} [, {idvar}]) |
1961 String send expression | |
1962 remote_foreground( {server}) Number bring Vim server to the foreground | |
1963 remote_peek( {serverid} [, {retvar}]) | |
1964 Number check for reply string | |
1965 remote_read( {serverid}) String read reply string | |
1966 remote_send( {server}, {string} [, {idvar}]) | |
1967 String send key sequence | |
79 | 1968 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 1969 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 1970 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
1971 repeat( {expr}, {count}) String repeat {expr} {count} times | |
1972 resolve( {filename}) String get filename a shortcut points to | |
82 | 1973 reverse( {list}) List reverse {list} in-place |
1621 | 1974 round( {expr}) Float round off {expr} |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1975 screenattr( {row}, {col}) Number attribute at screen position |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1976 screenchar( {row}, {col}) Number character at screen position |
3986 | 1977 screencol() Number current cursor column |
1978 screenrow() Number current cursor row | |
1496 | 1979 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1980 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1981 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 1982 Number search for variable declaration |
1496 | 1983 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 1984 Number search for other end of start/end pair |
1496 | 1985 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 1986 List search for other end of start/end pair |
1496 | 1987 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 1988 List search for {pattern} |
7 | 1989 server2client( {clientid}, {string}) |
1990 Number send reply string | |
1991 serverlist() String get a list of available servers | |
1992 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
6991 | 1993 setcharsearch( {dict}) Dict set character search from {dict} |
7 | 1994 setcmdpos( {pos}) Number set cursor position in command-line |
1995 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
647 | 1996 setloclist( {nr}, {list}[, {action}]) |
1997 Number modify location list using {list} | |
1326 | 1998 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1999 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 2000 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 2001 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
|
2002 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
831 | 2003 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
2004 {winnr} in tab page {tabnr} to {val} | |
7 | 2005 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
4126 | 2006 sha256( {string}) String SHA256 checksum of {string} |
1661 | 2007 shellescape( {string} [, {special}]) |
2008 String escape {string} for use as shell | |
985 | 2009 command argument |
3875 | 2010 shiftwidth() Number effective value of 'shiftwidth' |
55 | 2011 simplify( {filename}) String simplify filename as much as possible |
1621 | 2012 sin( {expr}) Float sine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2013 sinh( {expr}) Float hyperbolic sine of {expr} |
2902 | 2014 sort( {list} [, {func} [, {dict}]]) |
2015 List sort {list}, using {func} to compare | |
374 | 2016 soundfold( {word}) String sound-fold {word} |
344 | 2017 spellbadword() String badly spelled word at cursor |
537 | 2018 spellsuggest( {word} [, {max} [, {capital}]]) |
2019 List spelling suggestions | |
282 | 2020 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 2021 List make |List| from {pat} separated {expr} |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2022 sqrt( {expr}) Float square root of {expr} |
1621 | 2023 str2float( {expr}) Float convert String to Float |
2024 str2nr( {expr} [, {base}]) Number convert String to Number | |
6870 | 2025 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
2026 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
7 | 2027 strftime( {format}[, {time}]) String time in specified format |
133 | 2028 stridx( {haystack}, {needle}[, {start}]) |
2029 Number index of {needle} in {haystack} | |
95 | 2030 string( {expr}) String String representation of {expr} value |
7 | 2031 strlen( {expr}) Number length of the String {expr} |
2032 strpart( {src}, {start}[, {len}]) | |
2033 String {len} characters of {src} at {start} | |
140 | 2034 strridx( {haystack}, {needle} [, {start}]) |
2035 Number last index of {needle} in {haystack} | |
7 | 2036 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
|
2037 strwidth( {expr}) Number display cell length of the String {expr} |
5794 | 2038 submatch( {nr}[, {list}]) String or List |
2039 specific match in ":s" or substitute() | |
7 | 2040 substitute( {expr}, {pat}, {sub}, {flags}) |
2041 String all {pat} in {expr} replaced with {sub} | |
32 | 2042 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 2043 synIDattr( {synID}, {what} [, {mode}]) |
2044 String attribute {what} of syntax ID {synID} | |
2045 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2046 synconcealed( {lnum}, {col}) List info about concealing |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2047 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 2048 system( {expr} [, {input}]) String output of shell command/filter {expr} |
5808 | 2049 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
677 | 2050 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
2051 tabpagenr( [{arg}]) Number number of current or last tab page | |
2052 tabpagewinnr( {tabarg}[, {arg}]) | |
2053 Number number of current window in tab page | |
2054 taglist( {expr}) List list of tags matching {expr} | |
1621 | 2055 tagfiles() List tags files used |
7 | 2056 tempname() String name for a temporary file |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2057 tan( {expr}) Float tangent of {expr} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2058 tanh( {expr}) Float hyperbolic tangent of {expr} |
7 | 2059 tolower( {expr}) String the String {expr} switched to lowercase |
2060 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 2061 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
2062 to chars in {tostr} | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2063 trunc( {expr}) Float truncate Float {expr} |
7 | 2064 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
|
2065 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
|
2066 undotree() List undo file tree |
5747 | 2067 uniq( {list} [, {func} [, {dict}]]) |
2068 List remove adjacent duplicates from a list | |
685 | 2069 values( {dict}) List values in {dict} |
7 | 2070 virtcol( {expr}) Number screen column of cursor or mark |
2071 visualmode( [expr]) String last visual mode used | |
4151 | 2072 wildmenumode() Number whether 'wildmenu' mode is active |
7 | 2073 winbufnr( {nr}) Number buffer number of window {nr} |
2074 wincol() Number window column of the cursor | |
2075 winheight( {nr}) Number height of window {nr} | |
2076 winline() Number window line of the cursor | |
674 | 2077 winnr( [{expr}]) Number number of current window |
55 | 2078 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2079 winrestview( {dict}) none restore view of current window |
712 | 2080 winsaveview() Dict save view of current window |
7 | 2081 winwidth( {nr}) Number width of window {nr} |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
2082 wordcount() Dict get byte/char/word statistics |
6341 | 2083 writefile( {list}, {fname} [, {flags}]) |
158 | 2084 Number write list of lines to file {fname} |
3214 | 2085 xor( {expr}, {expr}) Number bitwise XOR |
7 | 2086 |
1621 | 2087 abs({expr}) *abs()* |
2088 Return the absolute value of {expr}. When {expr} evaluates to | |
2089 a |Float| abs() returns a |Float|. When {expr} can be | |
2090 converted to a |Number| abs() returns a |Number|. Otherwise | |
2091 abs() gives an error message and returns -1. | |
2092 Examples: > | |
2093 echo abs(1.456) | |
2094 < 1.456 > | |
2095 echo abs(-5.456) | |
2096 < 5.456 > | |
2097 echo abs(-4) | |
2098 < 4 | |
2099 {only available when compiled with the |+float| feature} | |
2100 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2101 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2102 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2103 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
|
2104 |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
|
2105 {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
|
2106 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2107 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2108 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2109 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2110 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2111 < 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
|
2112 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2113 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2114 |
82 | 2115 add({list}, {expr}) *add()* |
685 | 2116 Append the item {expr} to |List| {list}. Returns the |
2117 resulting |List|. Examples: > | |
82 | 2118 :let alist = add([1, 2, 3], item) |
2119 :call add(mylist, "woodstock") | |
685 | 2120 < Note that when {expr} is a |List| it is appended as a single |
692 | 2121 item. Use |extend()| to concatenate |Lists|. |
85 | 2122 Use |insert()| to add an item at another position. |
55 | 2123 |
82 | 2124 |
7513
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2125 alloc_fail({id}, {countdown}, {repeat}) *alloc_fail()* |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2126 This is for testing: If the memory allocation with {id} is |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2127 called, then decrement {countdown}, and when it reaches zero |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2128 let memory allocation fail {repeat} times. When {repeat} is |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2129 smaller than one it fails one time. |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2130 |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2131 |
3214 | 2132 and({expr}, {expr}) *and()* |
2133 Bitwise AND on the two arguments. The arguments are converted | |
2134 to a number. A List, Dict or Float argument causes an error. | |
2135 Example: > | |
2136 :let flag = and(bits, 0x80) | |
2137 | |
2138 | |
82 | 2139 append({lnum}, {expr}) *append()* |
685 | 2140 When {expr} is a |List|: Append each item of the |List| as a |
2141 text line below line {lnum} in the current buffer. | |
153 | 2142 Otherwise append {expr} as one text line below line {lnum} in |
2143 the current buffer. | |
2144 {lnum} can be zero to insert a line before the first one. | |
82 | 2145 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2146 0 for success. Example: > |
55 | 2147 :let failed = append(line('$'), "# THE END") |
82 | 2148 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2149 < |
7 | 2150 *argc()* |
2151 argc() The result is the number of files in the argument list of the | |
2152 current window. See |arglist|. | |
2153 | |
2154 *argidx()* | |
2155 argidx() The result is the current index in the argument list. 0 is | |
2156 the first file. argc() - 1 is the last one. See |arglist|. | |
2157 | |
5942 | 2158 *arglistid()* |
2159 arglistid([{winnr}, [ {tabnr} ]]) | |
2160 Return the argument list ID. This is a number which | |
2161 identifies the argument list being used. Zero is used for the | |
6153 | 2162 global argument list. See |arglist|. |
2163 Return -1 if the arguments are invalid. | |
5942 | 2164 |
2165 Without arguments use the current window. | |
2166 With {winnr} only use this window in the current tab page. | |
2167 With {winnr} and {tabnr} use the window in the specified tab | |
2168 page. | |
2169 | |
7 | 2170 *argv()* |
818 | 2171 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2172 current window. See |arglist|. "argv(0)" is the first one. |
2173 Example: > | |
2174 :let i = 0 | |
2175 :while i < argc() | |
1621 | 2176 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2177 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2178 : let i = i + 1 | |
2179 :endwhile | |
818 | 2180 < Without the {nr} argument a |List| with the whole |arglist| is |
2181 returned. | |
2182 | |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2183 *assert_equal()* |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2184 assert_equal({expected}, {actual} [, {msg}]) |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2185 When {expected} and {actual} are not equal an error message is |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2186 added to |v:errors|. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2187 There is no automatic conversion, the String "4" is different |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2188 from the Number 4. And the number 4 is different from the |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2189 Float 4.0. The value of 'ignorecase' is not used here, case |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2190 always matters. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2191 When {msg} is omitted an error in the form "Expected |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2192 {expected} but got {actual}" is produced. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2193 Example: > |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2194 assert_equal('foo', 'bar') |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2195 < Will result in a string to be added to |v:errors|: |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2196 test.vim line 12: Expected 'foo' but got 'bar' ~ |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2197 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2198 assert_exception({error} [, {msg}]) *assert_exception()* |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2199 When v:exception does not contain the string {error} an error |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2200 message is added to |v:errors|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2201 This can be used to assert that a command throws an exception. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2202 Using the error number, followed by a colon, avoids problems |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2203 with translations: > |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2204 try |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2205 commandthatfails |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2206 call assert_false(1, 'command should have failed') |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2207 catch |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2208 call assert_exception('E492:') |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2209 endtry |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2210 |
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2211 assert_fails({cmd} [, {error}]) *assert_fails()* |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2212 Run {cmd} and add an error message to |v:errors| if it does |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2213 NOT produce an error. |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2214 When {error} is given it must match |v:errmsg|. |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2215 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2216 assert_false({actual} [, {msg}]) *assert_false()* |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2217 When {actual} is not false an error message is added to |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2218 |v:errors|, like with |assert_equal()|. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2219 A value is false when it is zero. When "{actual}" is not a |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2220 number the assert fails. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2221 When {msg} is omitted an error in the form "Expected False but |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2222 got {actual}" is produced. |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2223 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2224 assert_true({actual} [, {msg}]) *assert_true()* |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2225 When {actual} is not true an error message is added to |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2226 |v:errors|, like with |assert_equal()|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2227 A value is true when it is a non-zero number. When {actual} |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2228 is not a number the assert fails. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2229 When {msg} is omitted an error in the form "Expected True but |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2230 got {actual}" is produced. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2231 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2232 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2233 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
|
2234 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
|
2235 {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
|
2236 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2237 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2238 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2239 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2240 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2241 < -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
|
2242 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2243 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2244 |
1621 | 2245 atan({expr}) *atan()* |
2246 Return the principal value of the arc tangent of {expr}, in | |
2247 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2248 {expr} must evaluate to a |Float| or a |Number|. | |
2249 Examples: > | |
2250 :echo atan(100) | |
2251 < 1.560797 > | |
2252 :echo atan(-4.01) | |
2253 < -1.326405 | |
2254 {only available when compiled with the |+float| feature} | |
2255 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2256 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2257 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2258 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
|
2259 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
|
2260 {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
|
2261 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2262 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2263 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2264 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2265 < 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
|
2266 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2267 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2268 |
7 | 2269 *browse()* |
2270 browse({save}, {title}, {initdir}, {default}) | |
2271 Put up a file requester. This only works when "has("browse")" | |
2272 returns non-zero (only in some GUI versions). | |
2273 The input fields are: | |
2274 {save} when non-zero, select file to write | |
2275 {title} title for the requester | |
2276 {initdir} directory to start browsing in | |
2277 {default} default file name | |
2278 When the "Cancel" button is hit, something went wrong, or | |
2279 browsing is not possible, an empty string is returned. | |
2280 | |
29 | 2281 *browsedir()* |
2282 browsedir({title}, {initdir}) | |
2283 Put up a directory requester. This only works when | |
2284 "has("browse")" returns non-zero (only in some GUI versions). | |
2285 On systems where a directory browser is not supported a file | |
2286 browser is used. In that case: select a file in the directory | |
2287 to be used. | |
2288 The input fields are: | |
2289 {title} title for the requester | |
2290 {initdir} directory to start browsing in | |
2291 When the "Cancel" button is hit, something went wrong, or | |
2292 browsing is not possible, an empty string is returned. | |
2293 | |
7 | 2294 bufexists({expr}) *bufexists()* |
2295 The result is a Number, which is non-zero if a buffer called | |
2296 {expr} exists. | |
9 | 2297 If the {expr} argument is a number, buffer numbers are used. |
7 | 2298 If the {expr} argument is a string it must match a buffer name |
9 | 2299 exactly. The name can be: |
2300 - Relative to the current directory. | |
2301 - A full path. | |
1621 | 2302 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2303 - A URL name. |
7 | 2304 Unlisted buffers will be found. |
2305 Note that help files are listed by their short name in the | |
2306 output of |:buffers|, but bufexists() requires using their | |
2307 long name to be able to find them. | |
1621 | 2308 bufexists() may report a buffer exists, but to use the name |
2309 with a |:buffer| command you may need to use |expand()|. Esp | |
2310 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2311 Use "bufexists(0)" to test for the existence of an alternate |
2312 file name. | |
2313 *buffer_exists()* | |
2314 Obsolete name: buffer_exists(). | |
2315 | |
2316 buflisted({expr}) *buflisted()* | |
2317 The result is a Number, which is non-zero if a buffer called | |
2318 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2319 The {expr} argument is used like with |bufexists()|. |
7 | 2320 |
2321 bufloaded({expr}) *bufloaded()* | |
2322 The result is a Number, which is non-zero if a buffer called | |
2323 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2324 The {expr} argument is used like with |bufexists()|. |
7 | 2325 |
2326 bufname({expr}) *bufname()* | |
2327 The result is the name of a buffer, as it is displayed by the | |
2328 ":ls" command. | |
2329 If {expr} is a Number, that buffer number's name is given. | |
2330 Number zero is the alternate buffer for the current window. | |
2331 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2332 with the buffer names. This is always done like 'magic' is |
7 | 2333 set and 'cpoptions' is empty. When there is more than one |
2334 match an empty string is returned. | |
2335 "" or "%" can be used for the current buffer, "#" for the | |
2336 alternate buffer. | |
2337 A full match is preferred, otherwise a match at the start, end | |
1156 | 2338 or middle of the buffer name is accepted. If you only want a |
2339 full match then put "^" at the start and "$" at the end of the | |
2340 pattern. | |
7 | 2341 Listed buffers are found first. If there is a single match |
2342 with a listed buffer, that one is returned. Next unlisted | |
2343 buffers are searched for. | |
2344 If the {expr} is a String, but you want to use it as a buffer | |
2345 number, force it to be a Number by adding zero to it: > | |
2346 :echo bufname("3" + 0) | |
2347 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2348 string is returned. > | |
2349 bufname("#") alternate buffer name | |
2350 bufname(3) name of buffer 3 | |
2351 bufname("%") name of current buffer | |
2352 bufname("file2") name of buffer where "file2" matches. | |
2353 < *buffer_name()* | |
2354 Obsolete name: buffer_name(). | |
2355 | |
2356 *bufnr()* | |
707 | 2357 bufnr({expr} [, {create}]) |
2358 The result is the number of a buffer, as it is displayed by | |
7 | 2359 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2360 above. |
2361 If the buffer doesn't exist, -1 is returned. Or, if the | |
2362 {create} argument is present and not zero, a new, unlisted, | |
2363 buffer is created and its number is returned. | |
7 | 2364 bufnr("$") is the last buffer: > |
2365 :let last_buffer = bufnr("$") | |
2366 < The result is a Number, which is the highest buffer number | |
2367 of existing buffers. Note that not all buffers with a smaller | |
2368 number necessarily exist, because ":bwipeout" may have removed | |
2369 them. Use bufexists() to test for the existence of a buffer. | |
2370 *buffer_number()* | |
2371 Obsolete name: buffer_number(). | |
2372 *last_buffer_nr()* | |
2373 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2374 | |
2375 bufwinnr({expr}) *bufwinnr()* | |
2376 The result is a Number, which is the number of the first | |
2377 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2378 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2379 there is no such window, -1 is returned. Example: > |
2380 | |
2381 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2382 | |
2383 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2384 |:wincmd|. | |
1156 | 2385 Only deals with the current tab page. |
7 | 2386 |
2387 | |
2388 byte2line({byte}) *byte2line()* | |
2389 Return the line number that contains the character at byte | |
2390 count {byte} in the current buffer. This includes the | |
2391 end-of-line character, depending on the 'fileformat' option | |
2392 for the current buffer. The first character has byte count | |
2393 one. | |
2394 Also see |line2byte()|, |go| and |:goto|. | |
2395 {not available when compiled without the |+byte_offset| | |
2396 feature} | |
2397 | |
18 | 2398 byteidx({expr}, {nr}) *byteidx()* |
2399 Return byte index of the {nr}'th character in the string | |
2400 {expr}. Use zero for the first character, it returns zero. | |
2401 This function is only useful when there are multibyte | |
2402 characters, otherwise the returned value is equal to {nr}. | |
5413 | 2403 Composing characters are not counted separately, their byte |
2404 length is added to the preceding base character. See | |
2405 |byteidxcomp()| below for counting composing characters | |
2406 separately. | |
18 | 2407 Example : > |
2408 echo matchstr(str, ".", byteidx(str, 3)) | |
2409 < will display the fourth character. Another way to do the | |
2410 same: > | |
2411 let s = strpart(str, byteidx(str, 3)) | |
2412 echo strpart(s, 0, byteidx(s, 1)) | |
2413 < If there are less than {nr} characters -1 is returned. | |
2414 If there are exactly {nr} characters the length of the string | |
5413 | 2415 in bytes is returned. |
2416 | |
2417 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
2418 Like byteidx(), except that a composing character is counted | |
2419 as a separate character. Example: > | |
2420 let s = 'e' . nr2char(0x301) | |
2421 echo byteidx(s, 1) | |
2422 echo byteidxcomp(s, 1) | |
2423 echo byteidxcomp(s, 2) | |
2424 < The first and third echo result in 3 ('e' plus composing | |
2425 character is 3 bytes), the second echo results in 1 ('e' is | |
2426 one byte). | |
2427 Only works different from byteidx() when 'encoding' is set to | |
2428 a Unicode encoding. | |
18 | 2429 |
102 | 2430 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2431 Call function {func} with the items in |List| {arglist} as |
79 | 2432 arguments. |
685 | 2433 {func} can either be a |Funcref| or the name of a function. |
79 | 2434 a:firstline and a:lastline are set to the cursor line. |
2435 Returns the return value of the called function. | |
102 | 2436 {dict} is for functions with the "dict" attribute. It will be |
2437 used to set the local variable "self". |Dictionary-function| | |
79 | 2438 |
1621 | 2439 ceil({expr}) *ceil()* |
2440 Return the smallest integral value greater than or equal to | |
2441 {expr} as a |Float| (round up). | |
2442 {expr} must evaluate to a |Float| or a |Number|. | |
2443 Examples: > | |
2444 echo ceil(1.456) | |
2445 < 2.0 > | |
2446 echo ceil(-5.456) | |
2447 < -5.0 > | |
2448 echo ceil(4.0) | |
2449 < 4.0 | |
2450 {only available when compiled with the |+float| feature} | |
2451 | |
777 | 2452 changenr() *changenr()* |
2453 Return the number of the most recent change. This is the same | |
2454 number as what is displayed with |:undolist| and can be used | |
2455 with the |:undo| command. | |
2456 When a change was made it is the number of that change. After | |
2457 redo it is the number of the redone change. After undo it is | |
2458 one less than the number of the undone change. | |
2459 | |
4051 | 2460 char2nr({expr}[, {utf8}]) *char2nr()* |
7 | 2461 Return number value of the first char in {expr}. Examples: > |
2462 char2nr(" ") returns 32 | |
2463 char2nr("ABC") returns 65 | |
4051 | 2464 < When {utf8} is omitted or zero, the current 'encoding' is used. |
2465 Example for "utf-8": > | |
1156 | 2466 char2nr("á") returns 225 |
2467 char2nr("á"[0]) returns 195 | |
4051 | 2468 < With {utf8} set to 1, always treat as utf-8 characters. |
2469 A combining character is a separate character. | |
2965 | 2470 |nr2char()| does the opposite. |
7 | 2471 |
2472 cindent({lnum}) *cindent()* | |
2473 Get the amount of indent for line {lnum} according the C | |
2474 indenting rules, as with 'cindent'. | |
2475 The indent is counted in spaces, the value of 'tabstop' is | |
2476 relevant. {lnum} is used just like in |getline()|. | |
2477 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2478 feature, -1 is returned. | |
548 | 2479 See |C-indenting|. |
7 | 2480 |
1326 | 2481 clearmatches() *clearmatches()* |
2482 Clears all matches previously defined by |matchadd()| and the | |
2483 |:match| commands. | |
2484 | |
7 | 2485 *col()* |
24 | 2486 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2487 position given with {expr}. The accepted positions are: |
2488 . the cursor position | |
2489 $ the end of the cursor line (the result is the | |
3513 | 2490 number of bytes in the cursor line plus one) |
7 | 2491 'x position of mark x (if the mark is not set, 0 is |
2492 returned) | |
6447 | 2493 v In Visual mode: the start of the Visual area (the |
2494 cursor is the end). When not in Visual mode | |
2495 returns the cursor position. Differs from |'<| in | |
2496 that it's updated right away. | |
1317 | 2497 Additionally {expr} can be [lnum, col]: a |List| with the line |
2498 and column number. Most useful when the column is "$", to get | |
1621 | 2499 the last column of a specific line. When "lnum" or "col" is |
1317 | 2500 out of range then col() returns zero. |
1156 | 2501 To get the line number use |line()|. To get both use |
703 | 2502 |getpos()|. |
7 | 2503 For the screen column position use |virtcol()|. |
2504 Note that only marks in the current file can be used. | |
2505 Examples: > | |
2506 col(".") column of cursor | |
2507 col("$") length of cursor line plus one | |
2508 col("'t") column of mark t | |
2509 col("'" . markname) column of mark markname | |
1621 | 2510 < The first column is 1. 0 is returned for an error. |
1156 | 2511 For an uppercase mark the column may actually be in another |
2512 buffer. | |
7 | 2513 For the cursor position, when 'virtualedit' is active, the |
2514 column is one higher if the cursor is after the end of the | |
2515 line. This can be used to obtain the column in Insert mode: > | |
2516 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2517 \<C-O>:set ve=all<CR> | |
2518 \<C-O>:echo col(".") . "\n" <Bar> | |
2519 \let &ve = save_ve<CR> | |
2520 < | |
464 | 2521 |
724 | 2522 complete({startcol}, {matches}) *complete()* *E785* |
2523 Set the matches for Insert mode completion. | |
2524 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2525 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2526 with an expression mapping. | |
724 | 2527 {startcol} is the byte offset in the line where the completed |
2528 text start. The text up to the cursor is the original text | |
2529 that will be replaced by the matches. Use col('.') for an | |
2530 empty string. "col('.') - 1" will replace one character by a | |
2531 match. | |
2532 {matches} must be a |List|. Each |List| item is one match. | |
2533 See |complete-items| for the kind of items that are possible. | |
2534 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
|
2535 inserting anything that would cause completion to stop. |
724 | 2536 The match can be selected with CTRL-N and CTRL-P as usual with |
2537 Insert mode completion. The popup menu will appear if | |
2538 specified, see |ins-completion-menu|. | |
2539 Example: > | |
1156 | 2540 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2541 |
2542 func! ListMonths() | |
2543 call complete(col('.'), ['January', 'February', 'March', | |
2544 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2545 \ 'October', 'November', 'December']) | |
2546 return '' | |
2547 endfunc | |
2548 < This isn't very useful, but it shows how it works. Note that | |
2549 an empty string is returned to avoid a zero being inserted. | |
2550 | |
464 | 2551 complete_add({expr}) *complete_add()* |
2552 Add {expr} to the list of matches. Only to be used by the | |
2553 function specified with the 'completefunc' option. | |
2554 Returns 0 for failure (empty string or out of memory), | |
2555 1 when the match was added, 2 when the match was already in | |
2556 the list. | |
1621 | 2557 See |complete-functions| for an explanation of {expr}. It is |
786 | 2558 the same as one item in the list that 'omnifunc' would return. |
464 | 2559 |
2560 complete_check() *complete_check()* | |
2561 Check for a key typed while looking for completion matches. | |
2562 This is to be used when looking for matches takes some time. | |
2563 Returns non-zero when searching for matches is to be aborted, | |
2564 zero otherwise. | |
2565 Only to be used by the function specified with the | |
2566 'completefunc' option. | |
2567 | |
7 | 2568 *confirm()* |
2569 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2570 Confirm() offers the user a dialog, from which a choice can be | |
2571 made. It returns the number of the choice. For the first | |
2572 choice this is 1. | |
2573 Note: confirm() is only supported when compiled with dialog | |
2574 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
|
2575 |
7 | 2576 {msg} is displayed in a |dialog| with {choices} as the |
2577 alternatives. When {choices} is missing or empty, "&OK" is | |
2578 used (and translated). | |
2579 {msg} is a String, use '\n' to include a newline. Only on | |
2580 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
|
2581 |
7 | 2582 {choices} is a String, with the individual choices separated |
2583 by '\n', e.g. > | |
2584 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2585 < The letter after the '&' is the shortcut key for that choice. | |
2586 Thus you can type 'c' to select "Cancel". The shortcut does | |
2587 not need to be the first letter: > | |
2588 confirm("file has been modified", "&Save\nSave &All") | |
2589 < For the console, the first letter of each choice is used as | |
2590 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
|
2591 |
7 | 2592 The optional {default} argument is the number of the choice |
2593 that is made if the user hits <CR>. Use 1 to make the first | |
2594 choice the default one. Use 0 to not set a default. If | |
2595 {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
|
2596 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2597 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
|
2598 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
|
2599 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
|
2600 "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
|
2601 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
|
2602 |
7 | 2603 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2604 or another valid interrupt key, confirm() returns 0. | |
2605 | |
2606 An example: > | |
2607 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2608 :if choice == 0 | |
2609 : echo "make up your mind!" | |
2610 :elseif choice == 3 | |
2611 : echo "tasteful" | |
2612 :else | |
2613 : echo "I prefer bananas myself." | |
2614 :endif | |
2615 < In a GUI dialog, buttons are used. The layout of the buttons | |
2616 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2617 the buttons are always put vertically. Otherwise, confirm() |
7 | 2618 tries to put the buttons in one horizontal line. If they |
2619 don't fit, a vertical layout is used anyway. For some systems | |
2620 the horizontal layout is always used. | |
2621 | |
55 | 2622 *copy()* |
1621 | 2623 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2624 different from using {expr} directly. |
685 | 2625 When {expr} is a |List| a shallow copy is created. This means |
2626 that the original |List| can be changed without changing the | |
1621 | 2627 copy, and vice versa. But the items are identical, thus |
2628 changing an item changes the contents of both |Lists|. Also | |
685 | 2629 see |deepcopy()|. |
55 | 2630 |
1621 | 2631 cos({expr}) *cos()* |
2632 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2633 {expr} must evaluate to a |Float| or a |Number|. | |
2634 Examples: > | |
2635 :echo cos(100) | |
2636 < 0.862319 > | |
2637 :echo cos(-4.01) | |
2638 < -0.646043 | |
2639 {only available when compiled with the |+float| feature} | |
2640 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2641 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2642 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2643 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
|
2644 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2645 {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
|
2646 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2647 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2648 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2649 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2650 < -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
|
2651 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2652 |
1621 | 2653 |
102 | 2654 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2655 Return the number of times an item with value {expr} appears |
685 | 2656 in |List| or |Dictionary| {comp}. |
102 | 2657 If {start} is given then start with the item with this index. |
685 | 2658 {start} can only be used with a |List|. |
79 | 2659 When {ic} is given and it's non-zero then case is ignored. |
2660 | |
2661 | |
7 | 2662 *cscope_connection()* |
2663 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2664 Checks for the existence of a |cscope| connection. If no | |
2665 parameters are specified, then the function returns: | |
2666 0, if cscope was not available (not compiled in), or | |
2667 if there are no cscope connections; | |
2668 1, if there is at least one cscope connection. | |
2669 | |
2670 If parameters are specified, then the value of {num} | |
2671 determines how existence of a cscope connection is checked: | |
2672 | |
2673 {num} Description of existence check | |
2674 ----- ------------------------------ | |
2675 0 Same as no parameters (e.g., "cscope_connection()"). | |
2676 1 Ignore {prepend}, and use partial string matches for | |
2677 {dbpath}. | |
2678 2 Ignore {prepend}, and use exact string matches for | |
2679 {dbpath}. | |
2680 3 Use {prepend}, use partial string matches for both | |
2681 {dbpath} and {prepend}. | |
2682 4 Use {prepend}, use exact string matches for both | |
2683 {dbpath} and {prepend}. | |
2684 | |
2685 Note: All string comparisons are case sensitive! | |
2686 | |
2687 Examples. Suppose we had the following (from ":cs show"): > | |
2688 | |
2689 # pid database name prepend path | |
2690 0 27664 cscope.out /usr/local | |
2691 < | |
2692 Invocation Return Val ~ | |
2693 ---------- ---------- > | |
2694 cscope_connection() 1 | |
2695 cscope_connection(1, "out") 1 | |
2696 cscope_connection(2, "out") 0 | |
2697 cscope_connection(3, "out") 0 | |
2698 cscope_connection(3, "out", "local") 1 | |
2699 cscope_connection(4, "out") 0 | |
2700 cscope_connection(4, "out", "local") 0 | |
2701 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2702 < | |
703 | 2703 cursor({lnum}, {col} [, {off}]) *cursor()* |
2704 cursor({list}) | |
1156 | 2705 Positions the cursor at the column (byte count) {col} in the |
2706 line {lnum}. The first column is one. | |
5938 | 2707 |
703 | 2708 When there is one argument {list} this is used as a |List| |
5938 | 2709 with two, three or four item: |
2710 [{lnum}, {col}, {off}] | |
2711 [{lnum}, {col}, {off}, {curswant}] | |
6009 | 2712 This is like the return value of |getpos()| or |getcurpos()|, |
5944 | 2713 but without the first item. |
5938 | 2714 |
7 | 2715 Does not change the jumplist. |
2716 If {lnum} is greater than the number of lines in the buffer, | |
2717 the cursor will be positioned at the last line in the buffer. | |
2718 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 2719 If {col} is greater than the number of bytes in the line, |
7 | 2720 the cursor will be positioned at the last character in the |
2721 line. | |
2722 If {col} is zero, the cursor will stay in the current column. | |
5944 | 2723 If {curswant} is given it is used to set the preferred column |
6180 | 2724 for vertical movement. Otherwise {col} is used. |
6385 | 2725 |
703 | 2726 When 'virtualedit' is used {off} specifies the offset in |
2727 screen columns from the start of the character. E.g., a | |
1266 | 2728 position within a <Tab> or after the last character. |
1851 | 2729 Returns 0 when the position could be set, -1 otherwise. |
7 | 2730 |
55 | 2731 |
164 | 2732 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 2733 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2734 different from using {expr} directly. |
685 | 2735 When {expr} is a |List| a full copy is created. This means |
2736 that the original |List| can be changed without changing the | |
1621 | 2737 copy, and vice versa. When an item is a |List|, a copy for it |
55 | 2738 is made, recursively. Thus changing an item in the copy does |
685 | 2739 not change the contents of the original |List|. |
2740 When {noref} is omitted or zero a contained |List| or | |
2741 |Dictionary| is only copied once. All references point to | |
2742 this single copy. With {noref} set to 1 every occurrence of a | |
2743 |List| or |Dictionary| results in a new copy. This also means | |
2744 that a cyclic reference causes deepcopy() to fail. | |
114 | 2745 *E724* |
2746 Nesting is possible up to 100 levels. When there is an item | |
164 | 2747 that refers back to a higher level making a deep copy with |
2748 {noref} set to 1 will fail. | |
55 | 2749 Also see |copy()|. |
2750 | |
2751 delete({fname}) *delete()* | |
2752 Deletes the file by the name {fname}. The result is a Number, | |
7 | 2753 which is 0 if the file was deleted successfully, and non-zero |
2754 when the deletion failed. | |
685 | 2755 Use |remove()| to delete an item from a |List|. |
4229 | 2756 To delete a line from the buffer use |:delete|. Use |:exe| |
2757 when the line number is in a variable. | |
7 | 2758 |
2759 *did_filetype()* | |
2760 did_filetype() Returns non-zero when autocommands are being executed and the | |
2761 FileType event has been triggered at least once. Can be used | |
2762 to avoid triggering the FileType event again in the scripts | |
2763 that detect the file type. |FileType| | |
2764 When editing another file, the counter is reset, thus this | |
2765 really checks if the FileType event has been triggered for the | |
2766 current buffer. This allows an autocommand that starts | |
2767 editing another buffer to set 'filetype' and load a syntax | |
2768 file. | |
2769 | |
32 | 2770 diff_filler({lnum}) *diff_filler()* |
2771 Returns the number of filler lines above line {lnum}. | |
2772 These are the lines that were inserted at this point in | |
2773 another diff'ed window. These filler lines are shown in the | |
2774 display but don't exist in the buffer. | |
2775 {lnum} is used like with |getline()|. Thus "." is the current | |
2776 line, "'m" mark m, etc. | |
2777 Returns 0 if the current window is not in diff mode. | |
2778 | |
2779 diff_hlID({lnum}, {col}) *diff_hlID()* | |
2780 Returns the highlight ID for diff mode at line {lnum} column | |
2781 {col} (byte index). When the current line does not have a | |
2782 diff change zero is returned. | |
2783 {lnum} is used like with |getline()|. Thus "." is the current | |
2784 line, "'m" mark m, etc. | |
2785 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
2786 line. | |
2787 The highlight ID can be used with |synIDattr()| to obtain | |
2788 syntax information about the highlighting. | |
2789 | |
85 | 2790 empty({expr}) *empty()* |
2791 Return the Number 1 if {expr} is empty, zero otherwise. | |
685 | 2792 A |List| or |Dictionary| is empty when it does not have any |
1621 | 2793 items. A Number is empty when its value is zero. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2794 For a long |List| this is much faster than comparing the |
685 | 2795 length with zero. |
85 | 2796 |
7 | 2797 escape({string}, {chars}) *escape()* |
2798 Escape the characters in {chars} that occur in {string} with a | |
2799 backslash. Example: > | |
2800 :echo escape('c:\program files\vim', ' \') | |
2801 < results in: > | |
2802 c:\\program\ files\\vim | |
1621 | 2803 < Also see |shellescape()|. |
2804 | |
2805 *eval()* | |
95 | 2806 eval({string}) Evaluate {string} and return the result. Especially useful to |
2807 turn the result of |string()| back into the original value. | |
1621 | 2808 This works for Numbers, Floats, Strings and composites of |
2809 them. Also works for |Funcref|s that refer to existing | |
2810 functions. | |
95 | 2811 |
7 | 2812 eventhandler() *eventhandler()* |
2813 Returns 1 when inside an event handler. That is that Vim got | |
2814 interrupted while waiting for the user to type a character, | |
2815 e.g., when dropping a file on Vim. This means interactive | |
2816 commands cannot be used. Otherwise zero is returned. | |
2817 | |
2818 executable({expr}) *executable()* | |
2819 This function checks if an executable with the name {expr} | |
2820 exists. {expr} must be the name of the program without any | |
10 | 2821 arguments. |
2822 executable() uses the value of $PATH and/or the normal | |
2823 searchpath for programs. *PATHEXT* | |
2824 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
2825 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 2826 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
2827 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 2828 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 2829 the name without an extension. When 'shell' looks like a |
10 | 2830 Unix shell, then the name is also tried without adding an |
2831 extension. | |
2832 On MS-DOS and MS-Windows it only checks if the file exists and | |
2833 is not a directory, not if it's really executable. | |
819 | 2834 On MS-Windows an executable in the same directory as Vim is |
2835 always found. Since this directory is added to $PATH it | |
2836 should also work to execute it |win32-PATH|. | |
7 | 2837 The result is a Number: |
2838 1 exists | |
2839 0 does not exist | |
2840 -1 not implemented on this system | |
2841 | |
5782 | 2842 exepath({expr}) *exepath()* |
2843 If {expr} is an executable and is either an absolute path, a | |
2844 relative path or found in $PATH, return the full path. | |
2845 Note that the current directory is used when {expr} starts | |
2846 with "./", which may be a problem for Vim: > | |
2847 echo exepath(v:progpath) | |
5814 | 2848 < If {expr} cannot be found in $PATH or is not executable then |
5782 | 2849 an empty string is returned. |
2850 | |
7 | 2851 *exists()* |
2852 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
2853 defined, zero otherwise. The {expr} argument is a string, | |
2854 which contains one of these: | |
2855 &option-name Vim option (only checks if it exists, | |
2856 not if it really works) | |
2857 +option-name Vim option that works. | |
2858 $ENVNAME environment variable (could also be | |
2859 done by comparing with an empty | |
2860 string) | |
2861 *funcname built-in function (see |functions|) | |
2862 or user defined function (see | |
5862 | 2863 |user-functions|). Also works for a |
2864 variable that is a Funcref. | |
7 | 2865 varname internal variable (see |
1621 | 2866 |internal-variables|). Also works |
685 | 2867 for |curly-braces-names|, |Dictionary| |
2868 entries, |List| items, etc. Beware | |
1668 | 2869 that evaluating an index may cause an |
2870 error message for an invalid | |
2871 expression. E.g.: > | |
2872 :let l = [1, 2, 3] | |
2873 :echo exists("l[5]") | |
2874 < 0 > | |
2875 :echo exists("l[xx]") | |
2876 < E121: Undefined variable: xx | |
2877 0 | |
7 | 2878 :cmdname Ex command: built-in command, user |
2879 command or command modifier |:command|. | |
2880 Returns: | |
2881 1 for match with start of a command | |
2882 2 full match with a command | |
2883 3 matches several user commands | |
2884 To check for a supported command | |
2885 always check the return value to be 2. | |
864 | 2886 :2match The |:2match| command. |
2887 :3match The |:3match| command. | |
7 | 2888 #event autocommand defined for this event |
2889 #event#pattern autocommand defined for this event and | |
2890 pattern (the pattern is taken | |
2891 literally and compared to the | |
2892 autocommand patterns character by | |
2893 character) | |
613 | 2894 #group autocommand group exists |
2895 #group#event autocommand defined for this group and | |
2896 event. | |
2897 #group#event#pattern | |
856 | 2898 autocommand defined for this group, |
613 | 2899 event and pattern. |
615 | 2900 ##event autocommand for this event is |
2901 supported. | |
7 | 2902 For checking for a supported feature use |has()|. |
2903 | |
2904 Examples: > | |
2905 exists("&shortname") | |
2906 exists("$HOSTNAME") | |
2907 exists("*strftime") | |
2908 exists("*s:MyFunc") | |
2909 exists("bufcount") | |
2910 exists(":Make") | |
613 | 2911 exists("#CursorHold") |
7 | 2912 exists("#BufReadPre#*.gz") |
613 | 2913 exists("#filetypeindent") |
2914 exists("#filetypeindent#FileType") | |
2915 exists("#filetypeindent#FileType#*") | |
615 | 2916 exists("##ColorScheme") |
7 | 2917 < There must be no space between the symbol (&/$/*/#) and the |
2918 name. | |
867 | 2919 There must be no extra characters after the name, although in |
2920 a few cases this is ignored. That may become more strict in | |
2921 the future, thus don't count on it! | |
2922 Working example: > | |
2923 exists(":make") | |
2924 < NOT working example: > | |
2925 exists(":make install") | |
859 | 2926 |
2927 < Note that the argument must be a string, not the name of the | |
2928 variable itself. For example: > | |
7 | 2929 exists(bufcount) |
2930 < This doesn't check for existence of the "bufcount" variable, | |
853 | 2931 but gets the value of "bufcount", and checks if that exists. |
7 | 2932 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2933 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2934 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
|
2935 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2936 {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
|
2937 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2938 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2939 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2940 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2941 < 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
|
2942 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2943 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2944 |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2945 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
7 | 2946 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
|
2947 'wildignorecase' applies. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2948 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2949 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
|
2950 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
|
2951 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
|
2952 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
|
2953 file name contains a space] |
7 | 2954 |
1621 | 2955 If the expansion fails, the result is an empty string. A name |
4869 | 2956 for a non-existing file is not included, unless {expr} does |
2957 not start with '%', '#' or '<', see below. | |
7 | 2958 |
2959 When {expr} starts with '%', '#' or '<', the expansion is done | |
2960 like for the |cmdline-special| variables with their associated | |
2961 modifiers. Here is a short overview: | |
2962 | |
2963 % current file name | |
2964 # alternate file name | |
2965 #n alternate file name n | |
2966 <cfile> file name under the cursor | |
2967 <afile> autocmd file name | |
2968 <abuf> autocmd buffer number (as a String!) | |
2969 <amatch> autocmd matched name | |
5734 | 2970 <sfile> sourced script file or function name |
2662 | 2971 <slnum> sourced script file line number |
7 | 2972 <cword> word under the cursor |
2973 <cWORD> WORD under the cursor | |
2974 <client> the {clientid} of the last received | |
2975 message |server2client()| | |
2976 Modifiers: | |
2977 :p expand to full path | |
2978 :h head (last path component removed) | |
2979 :t tail (last path component only) | |
2980 :r root (one extension removed) | |
2981 :e extension only | |
2982 | |
2983 Example: > | |
2984 :let &tags = expand("%:p:h") . "/tags" | |
2985 < Note that when expanding a string that starts with '%', '#' or | |
2986 '<', any following text is ignored. This does NOT work: > | |
2987 :let doesntwork = expand("%:h.bak") | |
2988 < Use this: > | |
2989 :let doeswork = expand("%:h") . ".bak" | |
2990 < Also note that expanding "<cfile>" and others only returns the | |
2991 referenced file name without further expansion. If "<cfile>" | |
2992 is "~/.cshrc", you need to do another expand() to have the | |
2993 "~/" expanded into the path of the home directory: > | |
2994 :echo expand(expand("<cfile>")) | |
2995 < | |
2996 There cannot be white space between the variables and the | |
2997 following modifier. The |fnamemodify()| function can be used | |
2998 to modify normal file names. | |
2999 | |
3000 When using '%' or '#', and the current or alternate file name | |
3001 is not defined, an empty string is used. Using "%:p" in a | |
3002 buffer with no name, results in the current directory, with a | |
3003 '/' added. | |
3004 | |
3005 When {expr} does not start with '%', '#' or '<', it is | |
3006 expanded like a file name is expanded on the command line. | |
3007 'suffixes' and 'wildignore' are used, unless the optional | |
3398 | 3008 {nosuf} argument is given and it is non-zero. |
3009 Names for non-existing files are included. The "**" item can | |
3010 be used to search in a directory tree. For example, to find | |
3011 all "README" files in the current directory and below: > | |
444 | 3012 :echo expand("**/README") |
3013 < | |
7 | 3014 Expand() can also be used to expand variables and environment |
3015 variables that are only known in a shell. But this can be | |
6180 | 3016 slow, because a shell may be used to do the expansion. See |
3017 |expr-env-expand|. | |
7 | 3018 The expanded variable is still handled like a list of file |
1621 | 3019 names. When an environment variable cannot be expanded, it is |
7 | 3020 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
3021 "$FOOBAR". | |
3022 | |
3023 See |glob()| for finding existing files. See |system()| for | |
3024 getting the raw output of an external command. | |
3025 | |
102 | 3026 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 3027 {expr1} and {expr2} must be both |Lists| or both |
3028 |Dictionaries|. | |
3029 | |
3030 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 3031 If {expr3} is given insert the items of {expr2} before item |
3032 {expr3} in {expr1}. When {expr3} is zero insert before the | |
3033 first item. When {expr3} is equal to len({expr1}) then | |
3034 {expr2} is appended. | |
79 | 3035 Examples: > |
3036 :echo sort(extend(mylist, [7, 5])) | |
3037 :call extend(mylist, [2, 3], 1) | |
1699 | 3038 < When {expr1} is the same List as {expr2} then the number of |
3039 items copied is equal to the original length of the List. | |
3040 E.g., when {expr3} is 1 you get N new copies of the first item | |
3041 (where N is the original length of the List). | |
3042 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 3043 two lists into a new list use the + operator: > |
79 | 3044 :let newlist = [1, 2, 3] + [4, 5] |
102 | 3045 < |
692 | 3046 If they are |Dictionaries|: |
102 | 3047 Add all entries from {expr2} to {expr1}. |
3048 If a key exists in both {expr1} and {expr2} then {expr3} is | |
3049 used to decide what to do: | |
3050 {expr3} = "keep": keep the value of {expr1} | |
3051 {expr3} = "force": use the value of {expr2} | |
856 | 3052 {expr3} = "error": give an error message *E737* |
102 | 3053 When {expr3} is omitted then "force" is assumed. |
3054 | |
3055 {expr1} is changed when {expr2} is not empty. If necessary | |
3056 make a copy of {expr1} first. | |
3057 {expr2} remains unchanged. | |
6823 | 3058 When {expr1} is locked and {expr2} is not empty the operation |
3059 fails. | |
102 | 3060 Returns {expr1}. |
3061 | |
79 | 3062 |
842 | 3063 feedkeys({string} [, {mode}]) *feedkeys()* |
3064 Characters in {string} are queued for processing as if they | |
6549 | 3065 come from a mapping or were typed by the user. |
3066 By default the string is added to the end of the typeahead | |
3067 buffer, thus if a mapping is still being executed the | |
3068 characters come after them. Use the 'i' flag to insert before | |
3069 other characters, they will be executed next, before any | |
3070 characters from a mapping. | |
842 | 3071 The function does not wait for processing of keys contained in |
3072 {string}. | |
3073 To include special keys into {string}, use double-quotes | |
3074 and "\..." notation |expr-quote|. For example, | |
1215 | 3075 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 3076 feedkeys('\<CR>') pushes 5 characters. |
3077 If {mode} is absent, keys are remapped. | |
3078 {mode} is a String, which can contain these character flags: | |
843 | 3079 'm' Remap keys. This is default. |
3080 'n' Do not remap keys. | |
3081 't' Handle keys as if typed; otherwise they are handled as | |
3082 if coming from a mapping. This matters for undo, | |
3083 opening folds, etc. | |
6549 | 3084 'i' Insert the string instead of appending (see above). |
842 | 3085 Return value is always 0. |
3086 | |
7 | 3087 filereadable({file}) *filereadable()* |
3088 The result is a Number, which is TRUE when a file with the | |
3089 name {file} exists, and can be read. If {file} doesn't exist, | |
3090 or is a directory, the result is FALSE. {file} is any | |
3091 expression, which is used as a String. | |
1156 | 3092 If you don't care about the file being readable you can use |
3093 |glob()|. | |
7 | 3094 *file_readable()* |
3095 Obsolete name: file_readable(). | |
3096 | |
95 | 3097 |
1156 | 3098 filewritable({file}) *filewritable()* |
3099 The result is a Number, which is 1 when a file with the | |
3100 name {file} exists, and can be written. If {file} doesn't | |
1621 | 3101 exist, or is not writable, the result is 0. If {file} is a |
1156 | 3102 directory, and we can write to it, the result is 2. |
3103 | |
3104 | |
102 | 3105 filter({expr}, {string}) *filter()* |
685 | 3106 {expr} must be a |List| or a |Dictionary|. |
102 | 3107 For each item in {expr} evaluate {string} and when the result |
685 | 3108 is zero remove the item from the |List| or |Dictionary|. |
102 | 3109 Inside {string} |v:val| has the value of the current item. |
685 | 3110 For a |Dictionary| |v:key| has the key of the current item. |
102 | 3111 Examples: > |
3112 :call filter(mylist, 'v:val !~ "OLD"') | |
3113 < Removes the items where "OLD" appears. > | |
3114 :call filter(mydict, 'v:key >= 8') | |
3115 < Removes the items with a key below 8. > | |
3116 :call filter(var, 0) | |
685 | 3117 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 3118 |
102 | 3119 Note that {string} is the result of expression and is then |
3120 used as an expression again. Often it is good to use a | |
3121 |literal-string| to avoid having to double backslashes. | |
3122 | |
685 | 3123 The operation is done in-place. If you want a |List| or |
3124 |Dictionary| to remain unmodified make a copy first: > | |
650 | 3125 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 3126 |
685 | 3127 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3128 When an error is encountered while evaluating {string} no |
3129 further items in {expr} are processed. | |
95 | 3130 |
3131 | |
19 | 3132 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 3133 Find directory {name} in {path}. Supports both downwards and |
3134 upwards recursive directory searches. See |file-searching| | |
3135 for the syntax of {path}. | |
3136 Returns the path of the first found match. When the found | |
3137 directory is below the current directory a relative path is | |
3138 returned. Otherwise a full path is returned. | |
19 | 3139 If {path} is omitted or empty then 'path' is used. |
3140 If the optional {count} is given, find {count}'s occurrence of | |
794 | 3141 {name} in {path} instead of the first one. |
809 | 3142 When {count} is negative return all the matches in a |List|. |
19 | 3143 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
|
3144 {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
|
3145 feature} |
794 | 3146 |
3147 findfile({name}[, {path}[, {count}]]) *findfile()* | |
3148 Just like |finddir()|, but find a file instead of a directory. | |
3149 Uses 'suffixesadd'. | |
19 | 3150 Example: > |
3151 :echo findfile("tags.vim", ".;") | |
1156 | 3152 < Searches from the directory of the current file upwards until |
3153 it finds the file "tags.vim". | |
7 | 3154 |
1621 | 3155 float2nr({expr}) *float2nr()* |
3156 Convert {expr} to a Number by omitting the part after the | |
3157 decimal point. | |
3158 {expr} must evaluate to a |Float| or a Number. | |
3159 When the value of {expr} is out of range for a |Number| the | |
3160 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
3161 in -0x80000000. | |
3162 Examples: > | |
3163 echo float2nr(3.95) | |
3164 < 3 > | |
3165 echo float2nr(-23.45) | |
3166 < -23 > | |
3167 echo float2nr(1.0e100) | |
3168 < 2147483647 > | |
3169 echo float2nr(-1.0e150) | |
3170 < -2147483647 > | |
3171 echo float2nr(1.0e-100) | |
3172 < 0 | |
3173 {only available when compiled with the |+float| feature} | |
3174 | |
3175 | |
3176 floor({expr}) *floor()* | |
3177 Return the largest integral value less than or equal to | |
3178 {expr} as a |Float| (round down). | |
3179 {expr} must evaluate to a |Float| or a |Number|. | |
3180 Examples: > | |
3181 echo floor(1.856) | |
3182 < 1.0 > | |
3183 echo floor(-5.456) | |
3184 < -6.0 > | |
3185 echo floor(4.0) | |
3186 < 4.0 | |
3187 {only available when compiled with the |+float| feature} | |
3188 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3189 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3190 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3191 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3192 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3193 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
|
3194 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
|
3195 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
|
3196 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
|
3197 {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
|
3198 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3199 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3200 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3201 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3202 < -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
|
3203 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3204 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3205 |
1586 | 3206 fnameescape({string}) *fnameescape()* |
1621 | 3207 Escape {string} for use as file name command argument. All |
1586 | 3208 characters that have a special meaning, such as '%' and '|' |
3209 are escaped with a backslash. | |
1621 | 3210 For most systems the characters escaped are |
3211 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3212 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3213 A leading '+' and '>' is also escaped (special after |:edit| |
3214 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3215 Example: > |
1700 | 3216 :let fname = '+some str%nge|name' |
1586 | 3217 :exe "edit " . fnameescape(fname) |
3218 < results in executing: > | |
1700 | 3219 edit \+some\ str\%nge\|name |
1586 | 3220 |
7 | 3221 fnamemodify({fname}, {mods}) *fnamemodify()* |
3222 Modify file name {fname} according to {mods}. {mods} is a | |
3223 string of characters like it is used for file names on the | |
3224 command line. See |filename-modifiers|. | |
3225 Example: > | |
3226 :echo fnamemodify("main.c", ":p:h") | |
3227 < results in: > | |
3228 /home/mool/vim/vim/src | |
1621 | 3229 < Note: Environment variables don't work in {fname}, use |
7 | 3230 |expand()| first then. |
3231 | |
3232 foldclosed({lnum}) *foldclosed()* | |
3233 The result is a Number. If the line {lnum} is in a closed | |
3234 fold, the result is the number of the first line in that fold. | |
3235 If the line {lnum} is not in a closed fold, -1 is returned. | |
3236 | |
3237 foldclosedend({lnum}) *foldclosedend()* | |
3238 The result is a Number. If the line {lnum} is in a closed | |
3239 fold, the result is the number of the last line in that fold. | |
3240 If the line {lnum} is not in a closed fold, -1 is returned. | |
3241 | |
3242 foldlevel({lnum}) *foldlevel()* | |
3243 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3244 in the current buffer. For nested folds the deepest level is |
7 | 3245 returned. If there is no fold at line {lnum}, zero is |
3246 returned. It doesn't matter if the folds are open or closed. | |
3247 When used while updating folds (from 'foldexpr') -1 is | |
3248 returned for lines where folds are still to be updated and the | |
3249 foldlevel is unknown. As a special case the level of the | |
3250 previous line is usually available. | |
3251 | |
3252 *foldtext()* | |
3253 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3254 the default function used for the 'foldtext' option and should | |
3255 only be called from evaluating 'foldtext'. It uses the | |
3256 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3257 The returned string looks like this: > | |
3258 +-- 45 lines: abcdef | |
1621 | 3259 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3260 the number of lines in the fold. "abcdef" is the text in the |
3261 first non-blank line of the fold. Leading white space, "//" | |
3262 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3263 options is removed. | |
3264 {not available when compiled without the |+folding| feature} | |
3265 | |
29 | 3266 foldtextresult({lnum}) *foldtextresult()* |
3267 Returns the text that is displayed for the closed fold at line | |
3268 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3269 When there is no closed fold at {lnum} an empty string is | |
3270 returned. | |
3271 {lnum} is used like with |getline()|. Thus "." is the current | |
3272 line, "'m" mark m, etc. | |
3273 Useful when exporting folded text, e.g., to HTML. | |
3274 {not available when compiled without the |+folding| feature} | |
3275 | |
7 | 3276 *foreground()* |
1621 | 3277 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3278 a client to a Vim server. |remote_send()| |
3279 On Win32 systems this might not work, the OS does not always | |
3280 allow a window to bring itself to the foreground. Use | |
3281 |remote_foreground()| instead. | |
3282 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3283 Win32 console version} | |
3284 | |
82 | 3285 |
85 | 3286 function({name}) *function()* *E700* |
685 | 3287 Return a |Funcref| variable that refers to function {name}. |
55 | 3288 {name} can be a user defined function or an internal function. |
3289 | |
82 | 3290 |
3224 | 3291 garbagecollect([{atexit}]) *garbagecollect()* |
692 | 3292 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 3293 references. There is hardly ever a need to invoke this |
3294 function, as it is automatically done when Vim runs out of | |
3295 memory or is waiting for the user to press a key after | |
3296 'updatetime'. Items without circular references are always | |
3297 freed when they become unused. | |
685 | 3298 This is useful if you have deleted a very big |List| and/or |
3299 |Dictionary| with circular references in a script that runs | |
3300 for a long time. | |
3224 | 3301 When the optional {atexit} argument is one, garbage |
1405 | 3302 collection will also be done when exiting Vim, if it wasn't |
3303 done before. This is useful when checking for memory leaks. | |
370 | 3304 |
140 | 3305 get({list}, {idx} [, {default}]) *get()* |
685 | 3306 Get item {idx} from |List| {list}. When this item is not |
82 | 3307 available return {default}. Return zero when {default} is |
3308 omitted. | |
102 | 3309 get({dict}, {key} [, {default}]) |
685 | 3310 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3311 item is not available return {default}. Return zero when |
3312 {default} is omitted. | |
3313 | |
435 | 3314 *getbufline()* |
3315 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3316 Return a |List| with the lines starting from {lnum} to {end} |
3317 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3318 |List| with only the line {lnum} is returned. | |
435 | 3319 |
3320 For the use of {expr}, see |bufname()| above. | |
3321 | |
448 | 3322 For {lnum} and {end} "$" can be used for the last line of the |
3323 buffer. Otherwise a number must be used. | |
435 | 3324 |
3325 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3326 lines in the buffer, an empty |List| is returned. |
435 | 3327 |
3328 When {end} is greater than the number of lines in the buffer, | |
3329 it is treated as {end} is set to the number of lines in the | |
685 | 3330 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3331 returned. |
3332 | |
448 | 3333 This function works only for loaded buffers. For unloaded and |
685 | 3334 non-existing buffers, an empty |List| is returned. |
435 | 3335 |
3336 Example: > | |
3337 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3338 |
4157 | 3339 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
82 | 3340 The result is the value of option or local buffer variable |
3341 {varname} in buffer {expr}. Note that the name without "b:" | |
3342 must be used. | |
1668 | 3343 When {varname} is empty returns a dictionary with all the |
3344 buffer-local variables. | |
216 | 3345 This also works for a global or buffer-local option, but it |
3346 doesn't work for a global variable, window-local variable or | |
3347 window-local option. | |
82 | 3348 For the use of {expr}, see |bufname()| above. |
4157 | 3349 When the buffer or variable doesn't exist {def} or an empty |
3350 string is returned, there is no error message. | |
82 | 3351 Examples: > |
3352 :let bufmodified = getbufvar(1, "&mod") | |
3353 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3354 < | |
7 | 3355 getchar([expr]) *getchar()* |
867 | 3356 Get a single character from the user or input stream. |
7 | 3357 If [expr] is omitted, wait until a character is available. |
3358 If [expr] is 0, only get a character when one is available. | |
867 | 3359 Return zero otherwise. |
7 | 3360 If [expr] is 1, only check if a character is available, it is |
867 | 3361 not consumed. Return zero if no character available. |
3362 | |
5555 | 3363 Without [expr] and when [expr] is 0 a whole character or |
867 | 3364 special key is returned. If it is an 8-bit character, the |
3365 result is a number. Use nr2char() to convert it to a String. | |
3366 Otherwise a String is returned with the encoded character. | |
3367 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3368 (decimal: 128). This is the same value as the string |
3369 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3370 String when a modifier (shift, control, alt) was used that is | |
3371 not included in the character. | |
867 | 3372 |
5968 | 3373 When [expr] is 0 and Esc is typed, there will be a short delay |
3374 while Vim waits to see if this is the start of an escape | |
3375 sequence. | |
3376 | |
5555 | 3377 When [expr] is 1 only the first byte is returned. For a |
872 | 3378 one-byte character it is the character itself as a number. |
3379 Use nr2char() to convert it to a String. | |
867 | 3380 |
3224 | 3381 Use getcharmod() to obtain any additional modifiers. |
3382 | |
1029 | 3383 When the user clicks a mouse button, the mouse event will be |
3384 returned. The position can then be found in |v:mouse_col|, | |
3385 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3386 mouse as it would normally happen: > | |
3387 let c = getchar() | |
1621 | 3388 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3389 exe v:mouse_win . "wincmd w" |
3390 exe v:mouse_lnum | |
3391 exe "normal " . v:mouse_col . "|" | |
3392 endif | |
3393 < | |
7 | 3394 There is no prompt, you will somehow have to make clear to the |
3395 user that a character has to be typed. | |
3396 There is no mapping for the character. | |
3397 Key codes are replaced, thus when the user presses the <Del> | |
3398 key you get the code for the <Del> key, not the raw character | |
3399 sequence. Examples: > | |
3400 getchar() == "\<Del>" | |
3401 getchar() == "\<S-Left>" | |
3402 < This example redefines "f" to ignore case: > | |
3403 :nmap f :call FindChar()<CR> | |
3404 :function FindChar() | |
3405 : let c = nr2char(getchar()) | |
3406 : while col('.') < col('$') - 1 | |
3407 : normal l | |
3408 : if getline('.')[col('.') - 1] ==? c | |
3409 : break | |
3410 : endif | |
3411 : endwhile | |
3412 :endfunction | |
6421 | 3413 < |
6647 | 3414 You may also receive synthetic characters, such as |
6421 | 3415 |<CursorHold>|. Often you will want to ignore this and get |
3416 another character: > | |
3417 :function GetKey() | |
3418 : let c = getchar() | |
3419 : while c == "\<CursorHold>" | |
3420 : let c = getchar() | |
3421 : endwhile | |
3422 : return c | |
3423 :endfunction | |
7 | 3424 |
3425 getcharmod() *getcharmod()* | |
3426 The result is a Number which is the state of the modifiers for | |
3427 the last obtained character with getchar() or in another way. | |
3428 These values are added together: | |
3429 2 shift | |
3430 4 control | |
3431 8 alt (meta) | |
3224 | 3432 16 meta (when it's different from ALT) |
3433 32 mouse double click | |
3434 64 mouse triple click | |
3435 96 mouse quadruple click (== 32 + 64) | |
3436 128 command (Macintosh only) | |
7 | 3437 Only the modifiers that have not been included in the |
1621 | 3438 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3439 without a modifier. |
7 | 3440 |
6991 | 3441 getcharsearch() *getcharsearch()* |
3442 Return the current character search information as a {dict} | |
3443 with the following entries: | |
3444 | |
3445 char character previously used for a character | |
3446 search (|t|, |f|, |T|, or |F|); empty string | |
3447 if no character search has been performed | |
3448 forward direction of character search; 1 for forward, | |
3449 0 for backward | |
3450 until type of character search; 1 for a |t| or |T| | |
3451 character search, 0 for an |f| or |F| | |
3452 character search | |
3453 | |
3454 This can be useful to always have |;| and |,| search | |
3455 forward/backward regardless of the direction of the previous | |
3456 character search: > | |
3457 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
3458 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
3459 < Also see |setcharsearch()|. | |
3460 | |
7 | 3461 getcmdline() *getcmdline()* |
3462 Return the current command-line. Only works when the command | |
3463 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3464 |c_CTRL-R_=|. | |
3465 Example: > | |
3466 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3467 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3468 |
95 | 3469 getcmdpos() *getcmdpos()* |
7 | 3470 Return the position of the cursor in the command line as a |
3471 byte count. The first column is 1. | |
3472 Only works when editing the command line, thus requires use of | |
3456 | 3473 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3474 Returns 0 otherwise. | |
531 | 3475 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3476 | |
3477 getcmdtype() *getcmdtype()* | |
3478 Return the current command-line type. Possible return values | |
3479 are: | |
532 | 3480 : normal Ex command |
3481 > debug mode command |debug-mode| | |
3482 / forward search command | |
3483 ? backward search command | |
3484 @ |input()| command | |
3485 - |:insert| or |:append| command | |
6213 | 3486 = |i_CTRL-R_=| |
531 | 3487 Only works when editing the command line, thus requires use of |
3456 | 3488 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3489 Returns an empty string otherwise. | |
531 | 3490 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
7 | 3491 |
6153 | 3492 getcmdwintype() *getcmdwintype()* |
3493 Return the current |command-line-window| type. Possible return | |
3494 values are the same as |getcmdtype()|. Returns an empty string | |
3495 when not in the command-line window. | |
3496 | |
5944 | 3497 *getcurpos()* |
3498 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
3499 includes an extra item in the list: | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7593
diff
changeset
|
3500 [bufnum, lnum, col, off, curswant] ~ |
5944 | 3501 The "curswant" number is the preferred column when moving the |
3502 cursor vertically. | |
3503 This can be used to save and restore the cursor position: > | |
3504 let save_cursor = getcurpos() | |
3505 MoveTheCursorAround | |
3506 call setpos('.', save_cursor) | |
6153 | 3507 < |
7 | 3508 *getcwd()* |
3509 getcwd() The result is a String, which is the name of the current | |
3510 working directory. | |
3511 | |
3512 getfsize({fname}) *getfsize()* | |
3513 The result is a Number, which is the size in bytes of the | |
3514 given file {fname}. | |
3515 If {fname} is a directory, 0 is returned. | |
3516 If the file {fname} can't be found, -1 is returned. | |
1293 | 3517 If the size of {fname} is too big to fit in a Number then -2 |
3518 is returned. | |
7 | 3519 |
37 | 3520 getfontname([{name}]) *getfontname()* |
3521 Without an argument returns the name of the normal font being | |
3522 used. Like what is used for the Normal highlight group | |
3523 |hl-Normal|. | |
3524 With an argument a check is done whether {name} is a valid | |
3525 font name. If not then an empty string is returned. | |
3526 Otherwise the actual font name is returned, or {name} if the | |
3527 GUI does not support obtaining the real name. | |
824 | 3528 Only works when the GUI is running, thus not in your vimrc or |
819 | 3529 gvimrc file. Use the |GUIEnter| autocommand to use this |
3530 function just after the GUI has started. | |
37 | 3531 Note that the GTK 2 GUI accepts any font name, thus checking |
3532 for a valid name does not work. | |
3533 | |
20 | 3534 getfperm({fname}) *getfperm()* |
3535 The result is a String, which is the read, write, and execute | |
3536 permissions of the given file {fname}. | |
3537 If {fname} does not exist or its directory cannot be read, an | |
3538 empty string is returned. | |
3539 The result is of the form "rwxrwxrwx", where each group of | |
3540 "rwx" flags represent, in turn, the permissions of the owner | |
3541 of the file, the group the file belongs to, and other users. | |
3542 If a user does not have a given permission the flag for this | |
3750 | 3543 is replaced with the string "-". Examples: > |
20 | 3544 :echo getfperm("/etc/passwd") |
3750 | 3545 :echo getfperm(expand("~/.vimrc")) |
20 | 3546 < This will hopefully (from a security point of view) display |
3547 the string "rw-r--r--" or even "rw-------". | |
205 | 3548 |
7 | 3549 getftime({fname}) *getftime()* |
3550 The result is a Number, which is the last modification time of | |
3551 the given file {fname}. The value is measured as seconds | |
3552 since 1st Jan 1970, and may be passed to strftime(). See also | |
3553 |localtime()| and |strftime()|. | |
3554 If the file {fname} can't be found -1 is returned. | |
3555 | |
20 | 3556 getftype({fname}) *getftype()* |
3557 The result is a String, which is a description of the kind of | |
3558 file of the given file {fname}. | |
3559 If {fname} does not exist an empty string is returned. | |
3560 Here is a table over different kinds of files and their | |
3561 results: | |
3562 Normal file "file" | |
3563 Directory "dir" | |
3564 Symbolic link "link" | |
3565 Block device "bdev" | |
3566 Character device "cdev" | |
3567 Socket "socket" | |
3568 FIFO "fifo" | |
3569 All other "other" | |
3570 Example: > | |
3571 getftype("/home") | |
3572 < Note that a type such as "link" will only be returned on | |
3573 systems that support it. On some systems only "dir" and | |
3574 "file" are returned. | |
3575 | |
7 | 3576 *getline()* |
82 | 3577 getline({lnum} [, {end}]) |
3578 Without {end} the result is a String, which is line {lnum} | |
3579 from the current buffer. Example: > | |
7 | 3580 getline(1) |
3581 < When {lnum} is a String that doesn't start with a | |
3582 digit, line() is called to translate the String into a Number. | |
3583 To get the line under the cursor: > | |
3584 getline(".") | |
3585 < When {lnum} is smaller than 1 or bigger than the number of | |
3586 lines in the buffer, an empty string is returned. | |
3587 | |
685 | 3588 When {end} is given the result is a |List| where each item is |
3589 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3590 including line {end}. |
3591 {end} is used in the same way as {lnum}. | |
3592 Non-existing lines are silently omitted. | |
685 | 3593 When {end} is before {lnum} an empty |List| is returned. |
82 | 3594 Example: > |
3595 :let start = line('.') | |
3596 :let end = search("^$") - 1 | |
3597 :let lines = getline(start, end) | |
3598 | |
1156 | 3599 < To get lines from another buffer see |getbufline()| |
3600 | |
647 | 3601 getloclist({nr}) *getloclist()* |
3602 Returns a list with all the entries in the location list for | |
3603 window {nr}. When {nr} is zero the current window is used. | |
3604 For a location list window, the displayed location list is | |
648 | 3605 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
|
3606 returned. Otherwise, same as |getqflist()|. |
82 | 3607 |
1326 | 3608 getmatches() *getmatches()* |
3609 Returns a |List| with all matches previously defined by | |
3610 |matchadd()| and the |:match| commands. |getmatches()| is | |
3611 useful in combination with |setmatches()|, as |setmatches()| | |
3612 can restore a list of matches saved by |getmatches()|. | |
3613 Example: > | |
3614 :echo getmatches() | |
3615 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3616 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3617 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3618 :let m = getmatches() | |
3619 :call clearmatches() | |
3620 :echo getmatches() | |
3621 < [] > | |
3622 :call setmatches(m) | |
3623 :echo getmatches() | |
3624 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3625 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3626 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3627 :unlet m | |
3628 < | |
5968 | 3629 *getpid()* |
3630 getpid() Return a Number which is the process ID of the Vim process. | |
3631 On Unix and MS-Windows this is a unique number, until Vim | |
3632 exits. On MS-DOS it's always zero. | |
3633 | |
3634 *getpos()* | |
3635 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
3636 see |line()|. For getting the cursor position see | |
3637 |getcurpos()|. | |
3638 The result is a |List| with four numbers: | |
3639 [bufnum, lnum, col, off] | |
3640 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
3641 is the buffer number of the mark. | |
3642 "lnum" and "col" are the position in the buffer. The first | |
3643 column is 1. | |
3644 The "off" number is zero, unless 'virtualedit' is used. Then | |
3645 it is the offset in screen columns from the start of the | |
3646 character. E.g., a position within a <Tab> or after the last | |
3647 character. | |
3648 Note that for '< and '> Visual mode matters: when it is "V" | |
3649 (visual line mode) the column of '< is zero and the column of | |
3650 '> is a large number. | |
3651 This can be used to save and restore the position of a mark: > | |
3652 let save_a_mark = getpos("'a") | |
3653 ... | |
6421 | 3654 call setpos("'a", save_a_mark) |
5968 | 3655 < Also see |getcurpos()| and |setpos()|. |
3656 | |
1326 | 3657 |
230 | 3658 getqflist() *getqflist()* |
3659 Returns a list with all the current quickfix errors. Each | |
3660 list item is a dictionary with these entries: | |
3661 bufnr number of buffer that has the file name, use | |
3662 bufname() to get the name | |
3663 lnum line number in the buffer (first line is 1) | |
3664 col column number (first column is 1) | |
233 | 3665 vcol non-zero: "col" is visual column |
3666 zero: "col" is byte index | |
230 | 3667 nr error number |
1065 | 3668 pattern search pattern used to locate the error |
230 | 3669 text description of the error |
3670 type type of the error, 'E', '1', etc. | |
3671 valid non-zero: recognized error message | |
3672 | |
515 | 3673 When there is no error list or it's empty an empty list is |
1065 | 3674 returned. Quickfix list entries with non-existing buffer |
3675 number are returned with "bufnr" set to zero. | |
515 | 3676 |
230 | 3677 Useful application: Find pattern matches in multiple files and |
3678 do something with them: > | |
3679 :vimgrep /theword/jg *.c | |
3680 :for d in getqflist() | |
3681 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
3682 :endfor | |
3683 | |
3684 | |
5796 | 3685 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
7 | 3686 The result is a String, which is the contents of register |
236 | 3687 {regname}. Example: > |
7 | 3688 :let cliptext = getreg('*') |
3689 < getreg('=') returns the last evaluated value of the expression | |
236 | 3690 register. (For use in maps.) |
282 | 3691 getreg('=', 1) returns the expression itself, so that it can |
3692 be restored with |setreg()|. For other registers the extra | |
3693 argument is ignored, thus you can always give it. | |
5796 | 3694 If {list} is present and non-zero result type is changed to |
3695 |List|. Each list item is one text line. Use it if you care | |
3696 about zero bytes possibly present inside register: without | |
3697 third argument both NLs and zero bytes are represented as NLs | |
3698 (see |NL-used-for-Nul|). | |
7 | 3699 If {regname} is not specified, |v:register| is used. |
3700 | |
82 | 3701 |
7 | 3702 getregtype([{regname}]) *getregtype()* |
3703 The result is a String, which is type of register {regname}. | |
3704 The value will be one of: | |
3705 "v" for |characterwise| text | |
3706 "V" for |linewise| text | |
3707 "<CTRL-V>{width}" for |blockwise-visual| text | |
5596 | 3708 "" for an empty or unknown register |
7 | 3709 <CTRL-V> is one character with value 0x16. |
3710 If {regname} is not specified, |v:register| is used. | |
3711 | |
4157 | 3712 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3713 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
|
3714 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3715 Tabs are numbered starting with one. |
6197 | 3716 When {varname} is empty a dictionary with all tab-local |
3717 variables is returned. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3718 Note that the name without "t:" must be used. |
4157 | 3719 When the tab or variable doesn't exist {def} or an empty |
3720 string is returned, there is no error message. | |
3721 | |
3722 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
1156 | 3723 Get the value of window-local variable {varname} in window |
3724 {winnr} in tab page {tabnr}. | |
3725 When {varname} starts with "&" get the value of a window-local | |
3726 option. | |
4157 | 3727 When {varname} is empty a dictionary with all window-local |
3728 variables is returned. | |
3729 Note that {varname} must be the name without "w:". | |
831 | 3730 Tabs are numbered starting with one. For the current tabpage |
3731 use |getwinvar()|. | |
3732 When {winnr} is zero the current window is used. | |
3733 This also works for a global option, buffer-local option and | |
3734 window-local option, but it doesn't work for a global variable | |
3735 or buffer-local variable. | |
4157 | 3736 When the tab, window or variable doesn't exist {def} or an |
3737 empty string is returned, there is no error message. | |
831 | 3738 Examples: > |
3739 :let list_is_on = gettabwinvar(1, 2, '&list') | |
3740 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 3741 < |
7 | 3742 *getwinposx()* |
3743 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
3744 the left hand side of the GUI Vim window. The result will be | |
3745 -1 if the information is not available. | |
3746 | |
3747 *getwinposy()* | |
3748 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 3749 the top of the GUI Vim window. The result will be -1 if the |
7 | 3750 information is not available. |
3751 | |
4157 | 3752 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
831 | 3753 Like |gettabwinvar()| for the current tabpage. |
7 | 3754 Examples: > |
3755 :let list_is_on = getwinvar(2, '&list') | |
3756 :echo "myvar = " . getwinvar(1, 'myvar') | |
3757 < | |
6663 | 3758 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
1754 | 3759 Expand the file wildcards in {expr}. See |wildcards| for the |
1156 | 3760 use of special characters. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3761 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3762 Unless the optional {nosuf} argument is given and is non-zero, |
1754 | 3763 the 'suffixes' and 'wildignore' options apply: Names matching |
3764 one of the patterns in 'wildignore' will be skipped and | |
3765 'suffixes' affect the ordering of matches. | |
2662 | 3766 'wildignorecase' always applies. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3767 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3768 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
|
3769 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
|
3770 you also get filenames containing newlines correctly. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3771 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
|
3772 matches, they are separated by <NL> characters. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3773 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3774 If the expansion fails, the result is an empty String or List. |
6663 | 3775 |
3445 | 3776 A name for a non-existing file is not included. A symbolic |
3777 link is only included if it points to an existing file. | |
6663 | 3778 However, when the {alllinks} argument is present and it is |
3779 non-zero then all symbolic links are included. | |
7 | 3780 |
3781 For most systems backticks can be used to get files names from | |
3782 any external command. Example: > | |
3783 :let tagfiles = glob("`find . -name tags -print`") | |
3784 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
3785 < The result of the program inside the backticks should be one | |
1621 | 3786 item per line. Spaces inside an item are allowed. |
7 | 3787 |
3788 See |expand()| for expanding special Vim variables. See | |
3789 |system()| for getting the raw output of an external command. | |
3790 | |
6697 | 3791 glob2regpat({expr}) *glob2regpat()* |
3792 Convert a file pattern, as used by glob(), into a search | |
3793 pattern. The result can be used to match with a string that | |
3794 is a file name. E.g. > | |
3795 if filename =~ glob2regpat('Make*.mak') | |
3796 < This is equivalent to: > | |
3797 if filename =~ '^Make.*\.mak$' | |
3798 < | |
6663 | 3799 *globpath()* |
3800 globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) | |
7 | 3801 Perform glob() on all directories in {path} and concatenate |
3802 the results. Example: > | |
3803 :echo globpath(&rtp, "syntax/c.vim") | |
5873 | 3804 < |
3805 {path} is a comma-separated list of directory names. Each | |
7 | 3806 directory name is prepended to {expr} and expanded like with |
1754 | 3807 |glob()|. A path separator is inserted when needed. |
7 | 3808 To add a comma inside a directory name escape it with a |
3809 backslash. Note that on MS-Windows a directory may have a | |
3810 trailing backslash, remove it if you put a comma after it. | |
3811 If the expansion fails for one of the directories, there is no | |
3812 error message. | |
5873 | 3813 |
3814 Unless the optional {nosuf} argument is given and is non-zero, | |
1754 | 3815 the 'suffixes' and 'wildignore' options apply: Names matching |
3816 one of the patterns in 'wildignore' will be skipped and | |
3817 'suffixes' affect the ordering of matches. | |
7 | 3818 |
5873 | 3819 When {list} is present and it is non-zero the result is a List |
3820 with all matching files. The advantage of using a List is, you | |
3821 also get filenames containing newlines correctly. Otherwise | |
3822 the result is a String and when there are several matches, | |
3823 they are separated by <NL> characters. Example: > | |
3824 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
3825 < | |
6663 | 3826 {allinks} is used as with |glob()|. |
3827 | |
444 | 3828 The "**" item can be used to search in a directory tree. |
3829 For example, to find all "README.txt" files in the directories | |
3830 in 'runtimepath' and below: > | |
3831 :echo globpath(&rtp, "**/README.txt") | |
1668 | 3832 < Upwards search and limiting the depth of "**" is not |
3833 supported, thus using 'path' will not always work properly. | |
3834 | |
7 | 3835 *has()* |
3836 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
3837 supported, zero otherwise. The {feature} argument is a | |
3838 string. See |feature-list| below. | |
3839 Also see |exists()|. | |
3840 | |
102 | 3841 |
3842 has_key({dict}, {key}) *has_key()* | |
685 | 3843 The result is a Number, which is 1 if |Dictionary| {dict} has |
3844 an entry with key {key}. Zero otherwise. | |
102 | 3845 |
1104 | 3846 haslocaldir() *haslocaldir()* |
3847 The result is a Number, which is 1 when the current | |
1621 | 3848 window has set a local path via |:lcd|, and 0 otherwise. |
102 | 3849 |
782 | 3850 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 3851 The result is a Number, which is 1 if there is a mapping that |
3852 contains {what} in somewhere in the rhs (what it is mapped to) | |
3853 and this mapping exists in one of the modes indicated by | |
3854 {mode}. | |
782 | 3855 When {abbr} is there and it is non-zero use abbreviations |
786 | 3856 instead of mappings. Don't forget to specify Insert and/or |
3857 Command-line mode. | |
7 | 3858 Both the global mappings and the mappings local to the current |
3859 buffer are checked for a match. | |
3860 If no matching mapping is found 0 is returned. | |
3861 The following characters are recognized in {mode}: | |
3862 n Normal mode | |
3863 v Visual mode | |
3864 o Operator-pending mode | |
3865 i Insert mode | |
3866 l Language-Argument ("r", "f", "t", etc.) | |
3867 c Command-line mode | |
3868 When {mode} is omitted, "nvo" is used. | |
3869 | |
3870 This function is useful to check if a mapping already exists | |
1621 | 3871 to a function in a Vim script. Example: > |
7 | 3872 :if !hasmapto('\ABCdoit') |
3873 : map <Leader>d \ABCdoit | |
3874 :endif | |
3875 < This installs the mapping to "\ABCdoit" only if there isn't | |
3876 already a mapping to "\ABCdoit". | |
3877 | |
3878 histadd({history}, {item}) *histadd()* | |
3879 Add the String {item} to the history {history} which can be | |
3880 one of: *hist-names* | |
3881 "cmd" or ":" command line history | |
3882 "search" or "/" search pattern history | |
1621 | 3883 "expr" or "=" typed expression history |
7 | 3884 "input" or "@" input line history |
3682 | 3885 "debug" or ">" debug command history |
3886 The {history} string does not need to be the whole name, one | |
3887 character is sufficient. | |
7 | 3888 If {item} does already exist in the history, it will be |
3889 shifted to become the newest entry. | |
3890 The result is a Number: 1 if the operation was successful, | |
3891 otherwise 0 is returned. | |
3892 | |
3893 Example: > | |
3894 :call histadd("input", strftime("%Y %b %d")) | |
3895 :let date=input("Enter date: ") | |
3896 < This function is not available in the |sandbox|. | |
3897 | |
3898 histdel({history} [, {item}]) *histdel()* | |
236 | 3899 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 3900 for the possible values of {history}. |
3901 | |
1668 | 3902 If the parameter {item} evaluates to a String, it is used as a |
3903 regular expression. All entries matching that expression will | |
3904 be removed from the history (if there are any). | |
7 | 3905 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 3906 If {item} evaluates to a Number, it will be interpreted as |
3907 an index, see |:history-indexing|. The respective entry will | |
3908 be removed if it exists. | |
7 | 3909 |
3910 The result is a Number: 1 for a successful operation, | |
3911 otherwise 0 is returned. | |
3912 | |
3913 Examples: | |
3914 Clear expression register history: > | |
3915 :call histdel("expr") | |
3916 < | |
3917 Remove all entries starting with "*" from the search history: > | |
3918 :call histdel("/", '^\*') | |
3919 < | |
3920 The following three are equivalent: > | |
3921 :call histdel("search", histnr("search")) | |
3922 :call histdel("search", -1) | |
3923 :call histdel("search", '^'.histget("search", -1).'$') | |
3924 < | |
3925 To delete the last search pattern and use the last-but-one for | |
3926 the "n" command and 'hlsearch': > | |
3927 :call histdel("search", -1) | |
3928 :let @/ = histget("search", -1) | |
3929 | |
3930 histget({history} [, {index}]) *histget()* | |
3931 The result is a String, the entry with Number {index} from | |
3932 {history}. See |hist-names| for the possible values of | |
3933 {history}, and |:history-indexing| for {index}. If there is | |
3934 no such entry, an empty String is returned. When {index} is | |
3935 omitted, the most recent item from the history is used. | |
3936 | |
3937 Examples: | |
3938 Redo the second last search from history. > | |
3939 :execute '/' . histget("search", -2) | |
3940 | |
3941 < Define an Ex command ":H {num}" that supports re-execution of | |
3942 the {num}th entry from the output of |:history|. > | |
3943 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
3944 < | |
3945 histnr({history}) *histnr()* | |
3946 The result is the Number of the current entry in {history}. | |
3947 See |hist-names| for the possible values of {history}. | |
3948 If an error occurred, -1 is returned. | |
3949 | |
3950 Example: > | |
3951 :let inp_index = histnr("expr") | |
3952 < | |
3953 hlexists({name}) *hlexists()* | |
3954 The result is a Number, which is non-zero if a highlight group | |
3955 called {name} exists. This is when the group has been | |
3956 defined in some way. Not necessarily when highlighting has | |
3957 been defined for it, it may also have been used for a syntax | |
3958 item. | |
3959 *highlight_exists()* | |
3960 Obsolete name: highlight_exists(). | |
3961 | |
3962 *hlID()* | |
3963 hlID({name}) The result is a Number, which is the ID of the highlight group | |
3964 with name {name}. When the highlight group doesn't exist, | |
3965 zero is returned. | |
3966 This can be used to retrieve information about the highlight | |
1621 | 3967 group. For example, to get the background color of the |
7 | 3968 "Comment" group: > |
3969 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
3970 < *highlightID()* | |
3971 Obsolete name: highlightID(). | |
3972 | |
3973 hostname() *hostname()* | |
3974 The result is a String, which is the name of the machine on | |
236 | 3975 which Vim is currently running. Machine names greater than |
7 | 3976 256 characters long are truncated. |
3977 | |
3978 iconv({expr}, {from}, {to}) *iconv()* | |
3979 The result is a String, which is the text {expr} converted | |
3980 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3981 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3982 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3983 are replaced with "?". |
7 | 3984 The encoding names are whatever the iconv() library function |
3985 can accept, see ":!man 3 iconv". | |
3986 Most conversions require Vim to be compiled with the |+iconv| | |
3987 feature. Otherwise only UTF-8 to latin1 conversion and back | |
3988 can be done. | |
3989 This can be used to display messages with special characters, | |
3990 no matter what 'encoding' is set to. Write the message in | |
3991 UTF-8 and use: > | |
3992 echo iconv(utf8_str, "utf-8", &enc) | |
3993 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
3994 from/to UCS-2 is automatically changed to use UTF-8. You | |
3995 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
|
3996 {only available when compiled with the |+multi_byte| feature} |
7 | 3997 |
3998 *indent()* | |
3999 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
4000 current buffer. The indent is counted in spaces, the value | |
4001 of 'tabstop' is relevant. {lnum} is used just like in | |
4002 |getline()|. | |
4003 When {lnum} is invalid -1 is returned. | |
4004 | |
79 | 4005 |
95 | 4006 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 4007 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
|
4008 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4009 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
|
4010 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
|
4011 is not used here, case always matters. |
153 | 4012 If {start} is given then start looking at the item with index |
4013 {start} (may be negative for an item relative to the end). | |
79 | 4014 When {ic} is given and it is non-zero, ignore case. Otherwise |
4015 case must match. | |
4016 -1 is returned when {expr} is not found in {list}. | |
4017 Example: > | |
4018 :let idx = index(words, "the") | |
87 | 4019 :if index(numbers, 123) >= 0 |
79 | 4020 |
4021 | |
531 | 4022 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 4023 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
|
4024 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4025 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
|
4026 in the prompt to start a new line. |
531 | 4027 The highlighting set with |:echohl| is used for the prompt. |
4028 The input is entered just like a command-line, with the same | |
1621 | 4029 editing commands and mappings. There is a separate history |
531 | 4030 for lines typed for input(). |
4031 Example: > | |
4032 :if input("Coffee or beer? ") == "beer" | |
4033 : echo "Cheers!" | |
4034 :endif | |
4035 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4036 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4037 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
|
4038 Example: > |
531 | 4039 :let color = input("Color? ", "white") |
4040 | |
4041 < The optional {completion} argument specifies the type of | |
4042 completion supported for the input. Without it completion is | |
1621 | 4043 not performed. The supported completion types are the same as |
531 | 4044 that can be supplied to a user-defined command using the |
1621 | 4045 "-complete=" argument. Refer to |:command-completion| for |
531 | 4046 more information. Example: > |
4047 let fname = input("File: ", "", "file") | |
4048 < | |
4049 NOTE: This function must not be used in a startup file, for | |
4050 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 4051 Note: When input() is called from within a mapping it will |
4052 consume remaining characters from that mapping, because a | |
4053 mapping is handled like the characters were typed. | |
4054 Use |inputsave()| before input() and |inputrestore()| | |
4055 after input() to avoid that. Another solution is to avoid | |
4056 that further characters follow in the mapping, e.g., by using | |
4057 |:execute| or |:normal|. | |
4058 | |
531 | 4059 Example with a mapping: > |
7 | 4060 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
4061 :function GetFoo() | |
4062 : call inputsave() | |
4063 : let g:Foo = input("enter search pattern: ") | |
4064 : call inputrestore() | |
4065 :endfunction | |
4066 | |
4067 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4068 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4069 are supported, a dialog window pops up to input the text. |
7 | 4070 Example: > |
3875 | 4071 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
4072 :if n != "" | |
4073 : let &sw = n | |
4074 :endif | |
7 | 4075 < When the dialog is cancelled {cancelreturn} is returned. When |
4076 omitted an empty string is returned. | |
4077 Hitting <Enter> works like pressing the OK button. Hitting | |
4078 <Esc> works like pressing the Cancel button. | |
531 | 4079 NOTE: Command-line completion is not supported. |
7 | 4080 |
519 | 4081 inputlist({textlist}) *inputlist()* |
819 | 4082 {textlist} must be a |List| of strings. This |List| is |
4083 displayed, one string per line. The user will be prompted to | |
4084 enter a number, which is returned. | |
519 | 4085 The user can also select an item by clicking on it with the |
1621 | 4086 mouse. For the first string 0 is returned. When clicking |
519 | 4087 above the first item a negative number is returned. When |
4088 clicking on the prompt one more than the length of {textlist} | |
4089 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4090 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 4091 it won't work. It's a good idea to put the entry number at |
1156 | 4092 the start of the string. And put a prompt in the first item. |
4093 Example: > | |
519 | 4094 let color = inputlist(['Select color:', '1. red', |
4095 \ '2. green', '3. blue']) | |
4096 | |
7 | 4097 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4098 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 4099 Should be called the same number of times inputsave() is |
4100 called. Calling it more often is harmless though. | |
4101 Returns 1 when there is nothing to restore, 0 otherwise. | |
4102 | |
4103 inputsave() *inputsave()* | |
4104 Preserve typeahead (also from mappings) and clear it, so that | |
4105 a following prompt gets input from the user. Should be | |
4106 followed by a matching inputrestore() after the prompt. Can | |
4107 be used several times, in which case there must be just as | |
4108 many inputrestore() calls. | |
4109 Returns 1 when out of memory, 0 otherwise. | |
4110 | |
4111 inputsecret({prompt} [, {text}]) *inputsecret()* | |
4112 This function acts much like the |input()| function with but | |
4113 two exceptions: | |
4114 a) the user's response will be displayed as a sequence of | |
4115 asterisks ("*") thereby keeping the entry secret, and | |
4116 b) the user's response will not be recorded on the input | |
4117 |history| stack. | |
4118 The result is a String, which is whatever the user actually | |
4119 typed on the command-line in response to the issued prompt. | |
531 | 4120 NOTE: Command-line completion is not supported. |
7 | 4121 |
55 | 4122 insert({list}, {item} [, {idx}]) *insert()* |
685 | 4123 Insert {item} at the start of |List| {list}. |
55 | 4124 If {idx} is specified insert {item} before the item with index |
1621 | 4125 {idx}. If {idx} is zero it goes before the first item, just |
55 | 4126 like omitting {idx}. A negative {idx} is also possible, see |
4127 |list-index|. -1 inserts just before the last item. | |
685 | 4128 Returns the resulting |List|. Examples: > |
55 | 4129 :let mylist = insert([2, 3, 5], 1) |
4130 :call insert(mylist, 4, -1) | |
4131 :call insert(mylist, 6, len(mylist)) | |
82 | 4132 < The last example can be done simpler with |add()|. |
685 | 4133 Note that when {item} is a |List| it is inserted as a single |
692 | 4134 item. Use |extend()| to concatenate |Lists|. |
55 | 4135 |
3214 | 4136 invert({expr}) *invert()* |
4137 Bitwise invert. The argument is converted to a number. A | |
4138 List, Dict or Float argument causes an error. Example: > | |
4139 :let bits = invert(bits) | |
4140 | |
7 | 4141 isdirectory({directory}) *isdirectory()* |
4142 The result is a Number, which is non-zero when a directory | |
4143 with the name {directory} exists. If {directory} doesn't | |
4144 exist, or isn't a directory, the result is FALSE. {directory} | |
4145 is any expression, which is used as a String. | |
4146 | |
819 | 4147 islocked({expr}) *islocked()* *E786* |
148 | 4148 The result is a Number, which is non-zero when {expr} is the |
4149 name of a locked variable. | |
685 | 4150 {expr} must be the name of a variable, |List| item or |
4151 |Dictionary| entry, not the variable itself! Example: > | |
148 | 4152 :let alist = [0, ['a', 'b'], 2, 3] |
4153 :lockvar 1 alist | |
4154 :echo islocked('alist') " 1 | |
4155 :echo islocked('alist[1]') " 0 | |
4156 | |
4157 < When {expr} is a variable that does not exist you get an error | |
843 | 4158 message. Use |exists()| to check for existence. |
148 | 4159 |
140 | 4160 items({dict}) *items()* |
685 | 4161 Return a |List| with all the key-value pairs of {dict}. Each |
4162 |List| item is a list with two items: the key of a {dict} | |
4163 entry and the value of this entry. The |List| is in arbitrary | |
4164 order. | |
140 | 4165 |
95 | 4166 |
4167 join({list} [, {sep}]) *join()* | |
4168 Join the items in {list} together into one String. | |
4169 When {sep} is specified it is put in between the items. If | |
4170 {sep} is omitted a single space is used. | |
4171 Note that {sep} is not added at the end. You might want to | |
4172 add it there too: > | |
4173 let lines = join(mylist, "\n") . "\n" | |
692 | 4174 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 4175 converted into a string like with |string()|. |
4176 The opposite function is |split()|. | |
4177 | |
99 | 4178 keys({dict}) *keys()* |
685 | 4179 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 4180 arbitrary order. |
4181 | |
85 | 4182 *len()* *E701* |
55 | 4183 len({expr}) The result is a Number, which is the length of the argument. |
4184 When {expr} is a String or a Number the length in bytes is | |
4185 used, as with |strlen()|. | |
685 | 4186 When {expr} is a |List| the number of items in the |List| is |
55 | 4187 returned. |
685 | 4188 When {expr} is a |Dictionary| the number of entries in the |
4189 |Dictionary| is returned. | |
55 | 4190 Otherwise an error is given. |
4191 | |
7 | 4192 *libcall()* *E364* *E368* |
4193 libcall({libname}, {funcname}, {argument}) | |
4194 Call function {funcname} in the run-time library {libname} | |
4195 with single argument {argument}. | |
4196 This is useful to call functions in a library that you | |
4197 especially made to be used with Vim. Since only one argument | |
4198 is possible, calling standard library functions is rather | |
4199 limited. | |
4200 The result is the String returned by the function. If the | |
4201 function returns NULL, this will appear as an empty string "" | |
4202 to Vim. | |
4203 If the function returns a number, use libcallnr()! | |
4204 If {argument} is a number, it is passed to the function as an | |
4205 int; if {argument} is a string, it is passed as a | |
4206 null-terminated string. | |
4207 This function will fail in |restricted-mode|. | |
4208 | |
4209 libcall() allows you to write your own 'plug-in' extensions to | |
4210 Vim without having to recompile the program. It is NOT a | |
4211 means to call system functions! If you try to do so Vim will | |
4212 very probably crash. | |
4213 | |
4214 For Win32, the functions you write must be placed in a DLL | |
4215 and use the normal C calling convention (NOT Pascal which is | |
4216 used in Windows System DLLs). The function must take exactly | |
4217 one parameter, either a character pointer or a long integer, | |
4218 and must return a character pointer or NULL. The character | |
4219 pointer returned must point to memory that will remain valid | |
4220 after the function has returned (e.g. in static data in the | |
4221 DLL). If it points to allocated memory, that memory will | |
4222 leak away. Using a static buffer in the function should work, | |
4223 it's then freed when the DLL is unloaded. | |
4224 | |
4225 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 4226 crash! This also happens if the function returns a number, |
7 | 4227 because Vim thinks it's a pointer. |
4228 For Win32 systems, {libname} should be the filename of the DLL | |
4229 without the ".DLL" suffix. A full path is only required if | |
4230 the DLL is not in the usual places. | |
4231 For Unix: When compiling your own plugins, remember that the | |
4232 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4233 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 4234 feature is present} |
4235 Examples: > | |
4236 :echo libcall("libc.so", "getenv", "HOME") | |
4237 < | |
4238 *libcallnr()* | |
4239 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4240 Just like |libcall()|, but used for a function that returns an |
7 | 4241 int instead of a string. |
4242 {only in Win32 on some Unix versions, when the |+libcall| | |
4243 feature is present} | |
1621 | 4244 Examples: > |
4245 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 4246 :call libcallnr("libc.so", "printf", "Hello World!\n") |
4247 :call libcallnr("libc.so", "sleep", 10) | |
4248 < | |
4249 *line()* | |
4250 line({expr}) The result is a Number, which is the line number of the file | |
4251 position given with {expr}. The accepted positions are: | |
4252 . the cursor position | |
4253 $ the last line in the current buffer | |
4254 'x position of mark x (if the mark is not set, 0 is | |
4255 returned) | |
665 | 4256 w0 first line visible in current window |
4257 w$ last line visible in current window | |
1609 | 4258 v In Visual mode: the start of the Visual area (the |
4259 cursor is the end). When not in Visual mode | |
4260 returns the cursor position. Differs from |'<| in | |
4261 that it's updated right away. | |
1156 | 4262 Note that a mark in another file can be used. The line number |
4263 then applies to another buffer. | |
703 | 4264 To get the column number use |col()|. To get both use |
4265 |getpos()|. | |
7 | 4266 Examples: > |
4267 line(".") line number of the cursor | |
4268 line("'t") line number of mark t | |
4269 line("'" . marker) line number of mark marker | |
4270 < *last-position-jump* | |
4271 This autocommand jumps to the last known position in a file | |
4272 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4273 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 4274 |
7 | 4275 line2byte({lnum}) *line2byte()* |
4276 Return the byte count from the start of the buffer for line | |
4277 {lnum}. This includes the end-of-line character, depending on | |
4278 the 'fileformat' option for the current buffer. The first | |
3237 | 4279 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 4280 This can also be used to get the byte count for the line just |
4281 below the last line: > | |
4282 line2byte(line("$") + 1) | |
3237 | 4283 < This is the buffer size plus one. If 'fileencoding' is empty |
4284 it is the file size plus one. | |
7 | 4285 When {lnum} is invalid, or the |+byte_offset| feature has been |
4286 disabled at compile time, -1 is returned. | |
4287 Also see |byte2line()|, |go| and |:goto|. | |
4288 | |
4289 lispindent({lnum}) *lispindent()* | |
4290 Get the amount of indent for line {lnum} according the lisp | |
4291 indenting rules, as with 'lisp'. | |
4292 The indent is counted in spaces, the value of 'tabstop' is | |
4293 relevant. {lnum} is used just like in |getline()|. | |
4294 When {lnum} is invalid or Vim was not compiled the | |
4295 |+lispindent| feature, -1 is returned. | |
4296 | |
4297 localtime() *localtime()* | |
4298 Return the current time, measured as seconds since 1st Jan | |
4299 1970. See also |strftime()| and |getftime()|. | |
4300 | |
95 | 4301 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4302 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4303 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
|
4304 {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
|
4305 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4306 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4307 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4308 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4309 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4310 < 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
|
4311 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4312 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4313 |
1621 | 4314 log10({expr}) *log10()* |
4315 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
4316 {expr} must evaluate to a |Float| or a |Number|. | |
4317 Examples: > | |
4318 :echo log10(1000) | |
4319 < 3.0 > | |
4320 :echo log10(0.01) | |
4321 < -2.0 | |
4322 {only available when compiled with the |+float| feature} | |
4323 | |
3492 | 4324 luaeval({expr}[, {expr}]) *luaeval()* |
4325 Evaluate Lua expression {expr} and return its result converted | |
4326 to Vim data structures. Second {expr} may hold additional | |
4327 argument accessible as _A inside first {expr}. | |
4328 Strings are returned as they are. | |
4329 Boolean objects are converted to numbers. | |
4330 Numbers are converted to |Float| values if vim was compiled | |
4331 with |+float| and to numbers otherwise. | |
4332 Dictionaries and lists obtained by vim.eval() are returned | |
4333 as-is. | |
4334 Other objects are returned as zero without any errors. | |
4335 See |lua-luaeval| for more details. | |
4336 {only available when compiled with the |+lua| feature} | |
4337 | |
102 | 4338 map({expr}, {string}) *map()* |
685 | 4339 {expr} must be a |List| or a |Dictionary|. |
102 | 4340 Replace each item in {expr} with the result of evaluating |
4341 {string}. | |
4342 Inside {string} |v:val| has the value of the current item. | |
1998 | 4343 For a |Dictionary| |v:key| has the key of the current item |
4344 and for a |List| |v:key| has the index of the current item. | |
102 | 4345 Example: > |
4346 :call map(mylist, '"> " . v:val . " <"') | |
95 | 4347 < This puts "> " before and " <" after each item in "mylist". |
102 | 4348 |
158 | 4349 Note that {string} is the result of an expression and is then |
102 | 4350 used as an expression again. Often it is good to use a |
158 | 4351 |literal-string| to avoid having to double backslashes. You |
4352 still have to double ' quotes | |
102 | 4353 |
685 | 4354 The operation is done in-place. If you want a |List| or |
4355 |Dictionary| to remain unmodified make a copy first: > | |
3682 | 4356 :let tlist = map(copy(mylist), ' v:val . "\t"') |
102 | 4357 |
685 | 4358 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4359 When an error is encountered while evaluating {string} no |
4360 further items in {expr} are processed. | |
95 | 4361 |
4362 | |
2610 | 4363 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4364 When {dict} is omitted or zero: Return the rhs of mapping | |
4365 {name} in mode {mode}. The returned String has special | |
4366 characters translated like in the output of the ":map" command | |
4367 listing. | |
4368 | |
4369 When there is no mapping for {name}, an empty String is | |
4370 returned. | |
4371 | |
4372 The {name} can have special key names, like in the ":map" | |
4373 command. | |
4374 | |
644 | 4375 {mode} can be one of these strings: |
7 | 4376 "n" Normal |
2610 | 4377 "v" Visual (including Select) |
7 | 4378 "o" Operator-pending |
4379 "i" Insert | |
4380 "c" Cmd-line | |
2610 | 4381 "s" Select |
4382 "x" Visual | |
7 | 4383 "l" langmap |language-mapping| |
4384 "" Normal, Visual and Operator-pending | |
644 | 4385 When {mode} is omitted, the modes for "" are used. |
2610 | 4386 |
782 | 4387 When {abbr} is there and it is non-zero use abbreviations |
4388 instead of mappings. | |
2610 | 4389 |
4390 When {dict} is there and it is non-zero return a dictionary | |
4391 containing all the information of the mapping with the | |
4392 following items: | |
4393 "lhs" The {lhs} of the mapping. | |
4394 "rhs" The {rhs} of the mapping as typed. | |
4395 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 4396 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 4397 "expr" 1 for an expression mapping (|:map-<expr>|). |
4398 "buffer" 1 for a buffer local mapping (|:map-local|). | |
4399 "mode" Modes for which the mapping is defined. In | |
4400 addition to the modes mentioned above, these | |
4401 characters will be used: | |
4402 " " Normal, Visual and Operator-pending | |
4403 "!" Insert and Commandline mode | |
2642 | 4404 (|mapmode-ic|) |
2625 | 4405 "sid" The script local ID, used for <sid> mappings |
4406 (|<SID>|). | |
5555 | 4407 "nowait" Do not wait for other, longer mappings. |
4408 (|:map-<nowait>|). | |
2610 | 4409 |
7 | 4410 The mappings local to the current buffer are checked first, |
4411 then the global mappings. | |
626 | 4412 This function can be used to map a key even when it's already |
4413 mapped, and have it do the original mapping too. Sketch: > | |
4414 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
4415 | |
7 | 4416 |
782 | 4417 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 4418 Check if there is a mapping that matches with {name} in mode |
4419 {mode}. See |maparg()| for {mode} and special names in | |
4420 {name}. | |
782 | 4421 When {abbr} is there and it is non-zero use abbreviations |
4422 instead of mappings. | |
7 | 4423 A match happens with a mapping that starts with {name} and |
4424 with a mapping which is equal to the start of {name}. | |
4425 | |
1621 | 4426 matches mapping "a" "ab" "abc" ~ |
7 | 4427 mapcheck("a") yes yes yes |
4428 mapcheck("abc") yes yes yes | |
4429 mapcheck("ax") yes no no | |
4430 mapcheck("b") no no no | |
4431 | |
4432 The difference with maparg() is that mapcheck() finds a | |
4433 mapping that matches with {name}, while maparg() only finds a | |
4434 mapping for {name} exactly. | |
4435 When there is no mapping that starts with {name}, an empty | |
4436 String is returned. If there is one, the rhs of that mapping | |
4437 is returned. If there are several mappings that start with | |
4438 {name}, the rhs of one of them is returned. | |
4439 The mappings local to the current buffer are checked first, | |
4440 then the global mappings. | |
4441 This function can be used to check if a mapping can be added | |
4442 without being ambiguous. Example: > | |
4443 :if mapcheck("_vv") == "" | |
4444 : map _vv :set guifont=7x13<CR> | |
4445 :endif | |
4446 < This avoids adding the "_vv" mapping when there already is a | |
4447 mapping for "_v" or for "_vvv". | |
4448 | |
19 | 4449 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 4450 When {expr} is a |List| then this returns the index of the |
4451 first item where {pat} matches. Each item is used as a | |
692 | 4452 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 4453 Otherwise, {expr} is used as a String. The result is a |
95 | 4454 Number, which gives the index (byte offset) in {expr} where |
4455 {pat} matches. | |
685 | 4456 A match at the first character or |List| item returns zero. |
19 | 4457 If there is no match -1 is returned. |
2833 | 4458 For getting submatches see |matchlist()|. |
19 | 4459 Example: > |
95 | 4460 :echo match("testing", "ing") " results in 4 |
714 | 4461 :echo match([1, 'x'], '\a') " results in 1 |
95 | 4462 < See |string-match| for how {pat} is used. |
170 | 4463 *strpbrk()* |
1621 | 4464 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 4465 :let sepidx = match(line, '[.,;: \t]') |
4466 < *strcasestr()* | |
4467 Vim doesn't have a strcasestr() function. But you can add | |
4468 "\c" to the pattern to ignore case: > | |
4469 :let idx = match(haystack, '\cneedle') | |
4470 < | |
95 | 4471 If {start} is given, the search starts from byte index |
685 | 4472 {start} in a String or item {start} in a |List|. |
7 | 4473 The result, however, is still the index counted from the |
236 | 4474 first character/item. Example: > |
7 | 4475 :echo match("testing", "ing", 2) |
4476 < result is again "4". > | |
4477 :echo match("testing", "ing", 4) | |
4478 < result is again "4". > | |
4479 :echo match("testing", "t", 2) | |
4480 < result is "3". | |
694 | 4481 For a String, if {start} > 0 then it is like the string starts |
703 | 4482 {start} bytes later, thus "^" will match at {start}. Except |
4483 when {count} is given, then it's like matches before the | |
4484 {start} byte are ignored (this is a bit complicated to keep it | |
4485 backwards compatible). | |
95 | 4486 For a String, if {start} < 0, it will be set to 0. For a list |
4487 the index is counted from the end. | |
697 | 4488 If {start} is out of range ({start} > strlen({expr}) for a |
4489 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 4490 |
694 | 4491 When {count} is given use the {count}'th match. When a match |
697 | 4492 is found in a String the search for the next one starts one |
694 | 4493 character further. Thus this example results in 1: > |
4494 echo match("testing", "..", 0, 2) | |
4495 < In a |List| the search continues in the next item. | |
703 | 4496 Note that when {count} is added the way {start} works changes, |
4497 see above. | |
694 | 4498 |
7 | 4499 See |pattern| for the patterns that are accepted. |
4500 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 4501 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 4502 done like 'magic' is set and 'cpoptions' is empty. |
4503 | |
1326 | 4504 *matchadd()* *E798* *E799* *E801* |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4505 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
1326 | 4506 Defines a pattern to be highlighted in the current window (a |
4507 "match"). It will be highlighted with {group}. Returns an | |
4508 identification number (ID), which can be used to delete the | |
4509 match using |matchdelete()|. | |
5466 | 4510 Matching is case sensitive and magic, unless case sensitivity |
4511 or magicness are explicitly overridden in {pattern}. The | |
4512 'magic', 'smartcase' and 'ignorecase' options are not used. | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4513 The "Conceal" value is special, it causes the match to be |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4514 concealed. |
1326 | 4515 |
4516 The optional {priority} argument assigns a priority to the | |
1621 | 4517 match. A match with a high priority will have its |
1326 | 4518 highlighting overrule that of a match with a lower priority. |
4519 A priority is specified as an integer (negative numbers are no | |
4520 exception). If the {priority} argument is not specified, the | |
4521 default priority is 10. The priority of 'hlsearch' is zero, | |
4522 hence all matches with a priority greater than zero will | |
4523 overrule it. Syntax highlighting (see 'syntax') is a separate | |
4524 mechanism, and regardless of the chosen priority a match will | |
4525 always overrule syntax highlighting. | |
4526 | |
4527 The optional {id} argument allows the request for a specific | |
4528 match ID. If a specified ID is already taken, an error | |
4529 message will appear and the match will not be added. An ID | |
4530 is specified as a positive integer (zero excluded). IDs 1, 2 | |
4531 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
6947 | 4532 respectively. If the {id} argument is not specified or -1, |
1326 | 4533 |matchadd()| automatically chooses a free ID. |
4534 | |
6947 | 4535 The optional {dict} argmument allows for further custom |
4536 values. Currently this is used to specify a match specifc | |
4537 conceal character that will be shown for |hl-Conceal| | |
4538 highlighted matches. The dict can have the following members: | |
4539 | |
4540 conceal Special character to show instead of the | |
4541 match (only for |hl-Conceal| highlighed | |
4542 matches, see |:syn-cchar|) | |
4543 | |
1326 | 4544 The number of matches is not limited, as it is the case with |
4545 the |:match| commands. | |
4546 | |
4547 Example: > | |
4548 :highlight MyGroup ctermbg=green guibg=green | |
4549 :let m = matchadd("MyGroup", "TODO") | |
4550 < Deletion of the pattern: > | |
4551 :call matchdelete(m) | |
4552 | |
4553 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 4554 available from |getmatches()|. All matches can be deleted in |
1326 | 4555 one operation by |clearmatches()|. |
819 | 4556 |
6947 | 4557 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
5979 | 4558 Same as |matchadd()|, but requires a list of positions {pos} |
4559 instead of a pattern. This command is faster than |matchadd()| | |
4560 because it does not require to handle regular expressions and | |
4561 sets buffer line boundaries to redraw screen. It is supposed | |
4562 to be used when fast match additions and deletions are | |
4563 required, for example to highlight matching parentheses. | |
4564 | |
4565 The list {pos} can contain one of these items: | |
6007 | 4566 - A number. This whole line will be highlighted. The first |
5979 | 4567 line has number 1. |
4568 - A list with one number, e.g., [23]. The whole line with this | |
4569 number will be highlighted. | |
4570 - A list with two numbers, e.g., [23, 11]. The first number is | |
6007 | 4571 the line number, the second one is the column number (first |
4572 column is 1, the value must correspond to the byte index as | |
4573 |col()| would return). The character at this position will | |
4574 be highlighted. | |
5979 | 4575 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
6007 | 4576 the third number gives the length of the highlight in bytes. |
5979 | 4577 |
4578 The maximum number of positions is 8. | |
4579 | |
4580 Example: > | |
4581 :highlight MyGroup ctermbg=green guibg=green | |
4582 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
4583 < Deletion of the pattern: > | |
4584 :call matchdelete(m) | |
4585 | |
4586 < Matches added by |matchaddpos()| are returned by | |
4587 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
4588 value a list like the {pos} item. | |
4589 These matches cannot be set via |setmatches()|, however they | |
4590 can still be deleted by |clearmatches()|. | |
4591 | |
819 | 4592 matcharg({nr}) *matcharg()* |
856 | 4593 Selects the {nr} match item, as set with a |:match|, |
819 | 4594 |:2match| or |:3match| command. |
4595 Return a |List| with two elements: | |
4596 The name of the highlight group used | |
4597 The pattern used. | |
4598 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
4599 When there is no match item set returns ['', '']. | |
1326 | 4600 This is useful to save and restore a |:match|. |
4601 Highlighting matches using the |:match| commands are limited | |
4602 to three matches. |matchadd()| does not have this limitation. | |
4603 | |
4604 matchdelete({id}) *matchdelete()* *E802* *E803* | |
4605 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 4606 or one of the |:match| commands. Returns 0 if successful, |
1326 | 4607 otherwise -1. See example for |matchadd()|. All matches can |
4608 be deleted in one operation by |clearmatches()|. | |
819 | 4609 |
19 | 4610 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4611 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4612 after the match. Example: > |
7 | 4613 :echo matchend("testing", "ing") |
4614 < results in "7". | |
170 | 4615 *strspn()* *strcspn()* |
4616 Vim doesn't have a strspn() or strcspn() function, but you can | |
4617 do it with matchend(): > | |
4618 :let span = matchend(line, '[a-zA-Z]') | |
4619 :let span = matchend(line, '[^a-zA-Z]') | |
4620 < Except that -1 is returned when there are no matches. | |
4621 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4622 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4623 :echo matchend("testing", "ing", 2) |
4624 < results in "7". > | |
4625 :echo matchend("testing", "ing", 5) | |
4626 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4627 When {expr} is a |List| the result is equal to |match()|. |
7 | 4628 |
158 | 4629 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4630 Same as |match()|, but return a |List|. The first item in the |
158 | 4631 list is the matched string, same as what matchstr() would |
4632 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 4633 in |:substitute|. When an optional submatch didn't match an |
4634 empty string is used. Example: > | |
4635 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
4636 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 4637 When there is no match an empty list is returned. |
4638 | |
19 | 4639 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 4640 Same as |match()|, but return the matched string. Example: > |
7 | 4641 :echo matchstr("testing", "ing") |
4642 < results in "ing". | |
4643 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4644 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4645 :echo matchstr("testing", "ing", 2) |
4646 < results in "ing". > | |
4647 :echo matchstr("testing", "ing", 5) | |
4648 < result is "". | |
685 | 4649 When {expr} is a |List| then the matching item is returned. |
95 | 4650 The type isn't changed, it's not necessarily a String. |
7 | 4651 |
87 | 4652 *max()* |
4653 max({list}) Return the maximum value of all items in {list}. | |
4654 If {list} is not a list or one of the items in {list} cannot | |
4655 be used as a Number this results in an error. | |
685 | 4656 An empty |List| results in zero. |
87 | 4657 |
4658 *min()* | |
1215 | 4659 min({list}) Return the minimum value of all items in {list}. |
87 | 4660 If {list} is not a list or one of the items in {list} cannot |
4661 be used as a Number this results in an error. | |
685 | 4662 An empty |List| results in zero. |
87 | 4663 |
843 | 4664 *mkdir()* *E739* |
168 | 4665 mkdir({name} [, {path} [, {prot}]]) |
4666 Create directory {name}. | |
4667 If {path} is "p" then intermediate directories are created as | |
4668 necessary. Otherwise it must be "". | |
4669 If {prot} is given it is used to set the protection bits of | |
4670 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 4671 the user readable for others). Use 0700 to make it unreadable |
1702 | 4672 for others. This is only used for the last part of {name}. |
4673 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
4674 with 0755. | |
4675 Example: > | |
4676 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
4677 < This function is not available in the |sandbox|. | |
168 | 4678 Not available on all systems. To check use: > |
4679 :if exists("*mkdir") | |
4680 < | |
7 | 4681 *mode()* |
1621 | 4682 mode([expr]) Return a string that indicates the current mode. |
1661 | 4683 If [expr] is supplied and it evaluates to a non-zero Number or |
4684 a non-empty String (|non-zero-arg|), then the full mode is | |
4685 returned, otherwise only the first letter is returned. Note | |
4686 that " " and "0" are also non-empty strings. | |
1621 | 4687 |
7 | 4688 n Normal |
1621 | 4689 no Operator-pending |
7 | 4690 v Visual by character |
4691 V Visual by line | |
4692 CTRL-V Visual blockwise | |
4693 s Select by character | |
4694 S Select by line | |
4695 CTRL-S Select blockwise | |
4696 i Insert | |
1621 | 4697 R Replace |R| |
4698 Rv Virtual Replace |gR| | |
7 | 4699 c Command-line |
1621 | 4700 cv Vim Ex mode |gQ| |
4701 ce Normal Ex mode |Q| | |
7 | 4702 r Hit-enter prompt |
1621 | 4703 rm The -- more -- prompt |
4704 r? A |:confirm| query of some sort | |
4705 ! Shell or external command is executing | |
4706 This is useful in the 'statusline' option or when used | |
4707 with |remote_expr()| In most other places it always returns | |
4708 "c" or "n". | |
4709 Also see |visualmode()|. | |
7 | 4710 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4711 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4712 Evaluate MzScheme expression {expr} and return its result |
3492 | 4713 converted to Vim data structures. |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4714 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4715 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
|
4716 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4717 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
|
4718 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4719 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
|
4720 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4721 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4722 :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
|
4723 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4724 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4725 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4726 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4727 |
7 | 4728 nextnonblank({lnum}) *nextnonblank()* |
4729 Return the line number of the first line at or below {lnum} | |
4730 that is not blank. Example: > | |
4731 if getline(nextnonblank(1)) =~ "Java" | |
4732 < When {lnum} is invalid or there is no non-blank line at or | |
4733 below it, zero is returned. | |
4734 See also |prevnonblank()|. | |
4735 | |
4051 | 4736 nr2char({expr}[, {utf8}]) *nr2char()* |
7 | 4737 Return a string with a single character, which has the number |
4738 value {expr}. Examples: > | |
4739 nr2char(64) returns "@" | |
4740 nr2char(32) returns " " | |
4051 | 4741 < When {utf8} is omitted or zero, the current 'encoding' is used. |
4742 Example for "utf-8": > | |
7 | 4743 nr2char(300) returns I with bow character |
4051 | 4744 < With {utf8} set to 1, always return utf-8 characters. |
4745 Note that a NUL character in the file is specified with | |
7 | 4746 nr2char(10), because NULs are represented with newline |
4747 characters. nr2char(0) is a real NUL and terminates the | |
119 | 4748 string, thus results in an empty string. |
7 | 4749 |
3214 | 4750 or({expr}, {expr}) *or()* |
4751 Bitwise OR on the two arguments. The arguments are converted | |
4752 to a number. A List, Dict or Float argument causes an error. | |
4753 Example: > | |
4754 :let bits = or(bits, 0x80) | |
4755 | |
4756 | |
819 | 4757 pathshorten({expr}) *pathshorten()* |
4758 Shorten directory names in the path {expr} and return the | |
4759 result. The tail, the file name, is kept as-is. The other | |
4760 components in the path are reduced to single letters. Leading | |
4761 '~' and '.' characters are kept. Example: > | |
4762 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
4763 < ~/.v/a/myfile.vim ~ | |
4764 It doesn't matter if the path exists or not. | |
4765 | |
1621 | 4766 pow({x}, {y}) *pow()* |
4767 Return the power of {x} to the exponent {y} as a |Float|. | |
4768 {x} and {y} must evaluate to a |Float| or a |Number|. | |
4769 Examples: > | |
4770 :echo pow(3, 3) | |
4771 < 27.0 > | |
4772 :echo pow(2, 16) | |
4773 < 65536.0 > | |
4774 :echo pow(32, 0.20) | |
4775 < 2.0 | |
4776 {only available when compiled with the |+float| feature} | |
4777 | |
667 | 4778 prevnonblank({lnum}) *prevnonblank()* |
4779 Return the line number of the first line at or above {lnum} | |
4780 that is not blank. Example: > | |
4781 let ind = indent(prevnonblank(v:lnum - 1)) | |
4782 < When {lnum} is invalid or there is no non-blank line at or | |
4783 above it, zero is returned. | |
4784 Also see |nextnonblank()|. | |
4785 | |
4786 | |
449 | 4787 printf({fmt}, {expr1} ...) *printf()* |
4788 Return a String with {fmt}, where "%" items are replaced by | |
4789 the formatted form of their respective arguments. Example: > | |
452 | 4790 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 4791 < May result in: |
452 | 4792 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 4793 |
4794 Often used items are: | |
856 | 4795 %s string |
3914 | 4796 %6S string right-aligned in 6 display cells |
653 | 4797 %6s string right-aligned in 6 bytes |
1621 | 4798 %.9s string truncated to 9 bytes |
4799 %c single byte | |
4800 %d decimal number | |
4801 %5d decimal number padded with spaces to 5 characters | |
4802 %x hex number | |
4803 %04x hex number padded with zeros to at least 4 characters | |
4804 %X hex number using upper case letters | |
4805 %o octal number | |
4806 %f floating point number in the form 123.456 | |
4807 %e floating point number in the form 1.234e3 | |
4808 %E floating point number in the form 1.234E3 | |
4809 %g floating point number, as %f or %e depending on value | |
4810 %G floating point number, as %f or %E depending on value | |
4811 %% the % character itself | |
449 | 4812 |
4813 Conversion specifications start with '%' and end with the | |
4814 conversion type. All other characters are copied unchanged to | |
4815 the result. | |
4816 | |
4817 The "%" starts a conversion specification. The following | |
452 | 4818 arguments appear in sequence: |
4819 | |
4820 % [flags] [field-width] [.precision] type | |
4821 | |
856 | 4822 flags |
452 | 4823 Zero or more of the following flags: |
4824 | |
449 | 4825 # The value should be converted to an "alternate |
4826 form". For c, d, and s conversions, this option | |
4827 has no effect. For o conversions, the precision | |
4828 of the number is increased to force the first | |
4829 character of the output string to a zero (except | |
4830 if a zero value is printed with an explicit | |
4831 precision of zero). | |
4832 For x and X conversions, a non-zero result has | |
4833 the string "0x" (or "0X" for X conversions) | |
4834 prepended to it. | |
452 | 4835 |
449 | 4836 0 (zero) Zero padding. For all conversions the converted |
4837 value is padded on the left with zeros rather | |
4838 than blanks. If a precision is given with a | |
4839 numeric conversion (d, o, x, and X), the 0 flag | |
4840 is ignored. | |
452 | 4841 |
449 | 4842 - A negative field width flag; the converted value |
4843 is to be left adjusted on the field boundary. | |
4844 The converted value is padded on the right with | |
4845 blanks, rather than on the left with blanks or | |
4846 zeros. A - overrides a 0 if both are given. | |
452 | 4847 |
449 | 4848 ' ' (space) A blank should be left before a positive |
4849 number produced by a signed conversion (d). | |
452 | 4850 |
449 | 4851 + A sign must always be placed before a number |
1621 | 4852 produced by a signed conversion. A + overrides |
449 | 4853 a space if both are used. |
452 | 4854 |
4855 field-width | |
4856 An optional decimal digit string specifying a minimum | |
653 | 4857 field width. If the converted value has fewer bytes |
4858 than the field width, it will be padded with spaces on | |
4859 the left (or right, if the left-adjustment flag has | |
4860 been given) to fill out the field width. | |
452 | 4861 |
4862 .precision | |
4863 An optional precision, in the form of a period '.' | |
4864 followed by an optional digit string. If the digit | |
4865 string is omitted, the precision is taken as zero. | |
4866 This gives the minimum number of digits to appear for | |
4867 d, o, x, and X conversions, or the maximum number of | |
653 | 4868 bytes to be printed from a string for s conversions. |
1621 | 4869 For floating point it is the number of digits after |
4870 the decimal point. | |
452 | 4871 |
4872 type | |
4873 A character that specifies the type of conversion to | |
4874 be applied, see below. | |
4875 | |
449 | 4876 A field width or precision, or both, may be indicated by an |
4877 asterisk '*' instead of a digit string. In this case, a | |
1621 | 4878 Number argument supplies the field width or precision. A |
449 | 4879 negative field width is treated as a left adjustment flag |
4880 followed by a positive field width; a negative precision is | |
4881 treated as though it were missing. Example: > | |
452 | 4882 :echo printf("%d: %.*s", nr, width, line) |
449 | 4883 < This limits the length of the text used from "line" to |
452 | 4884 "width" bytes. |
449 | 4885 |
856 | 4886 The conversion specifiers and their meanings are: |
452 | 4887 |
1621 | 4888 *printf-d* *printf-o* *printf-x* *printf-X* |
4889 doxX The Number argument is converted to signed decimal | |
449 | 4890 (d), unsigned octal (o), or unsigned hexadecimal (x |
4891 and X) notation. The letters "abcdef" are used for | |
4892 x conversions; the letters "ABCDEF" are used for X | |
452 | 4893 conversions. |
4894 The precision, if any, gives the minimum number of | |
4895 digits that must appear; if the converted value | |
4896 requires fewer digits, it is padded on the left with | |
4897 zeros. | |
4898 In no case does a non-existent or small field width | |
4899 cause truncation of a numeric field; if the result of | |
4900 a conversion is wider than the field width, the field | |
4901 is expanded to contain the conversion result. | |
4902 | |
1621 | 4903 *printf-c* |
452 | 4904 c The Number argument is converted to a byte, and the |
4905 resulting character is written. | |
4906 | |
1621 | 4907 *printf-s* |
452 | 4908 s The text of the String argument is used. If a |
4909 precision is specified, no more bytes than the number | |
4910 specified are used. | |
6583 | 4911 *printf-S* |
3914 | 4912 S The text of the String argument is used. If a |
4913 precision is specified, no more display cells than the | |
4914 number specified are used. Without the |+multi_byte| | |
4915 feature works just like 's'. | |
452 | 4916 |
1621 | 4917 *printf-f* *E807* |
4918 f The Float argument is converted into a string of the | |
4919 form 123.456. The precision specifies the number of | |
4920 digits after the decimal point. When the precision is | |
4921 zero the decimal point is omitted. When the precision | |
4922 is not specified 6 is used. A really big number | |
4923 (out of range or dividing by zero) results in "inf". | |
4924 "0.0 / 0.0" results in "nan". | |
4925 Example: > | |
4926 echo printf("%.2f", 12.115) | |
4927 < 12.12 | |
4928 Note that roundoff depends on the system libraries. | |
4929 Use |round()| when in doubt. | |
4930 | |
4931 *printf-e* *printf-E* | |
4932 e E The Float argument is converted into a string of the | |
4933 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
4934 precision specifies the number of digits after the | |
4935 decimal point, like with 'f'. | |
4936 | |
4937 *printf-g* *printf-G* | |
4938 g G The Float argument is converted like with 'f' if the | |
4939 value is between 0.001 (inclusive) and 10000000.0 | |
4940 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
4941 for 'G'. When no precision is specified superfluous | |
4942 zeroes and '+' signs are removed, except for the zero | |
4943 immediately after the decimal point. Thus 10000000.0 | |
4944 results in 1.0e7. | |
4945 | |
4946 *printf-%* | |
449 | 4947 % A '%' is written. No argument is converted. The |
4948 complete conversion specification is "%%". | |
452 | 4949 |
1668 | 4950 When a Number argument is expected a String argument is also |
4951 accepted and automatically converted. | |
4952 When a Float or String argument is expected a Number argument | |
4953 is also accepted and automatically converted. | |
4954 Any other argument type results in an error message. | |
449 | 4955 |
459 | 4956 *E766* *E767* |
449 | 4957 The number of {exprN} arguments must exactly match the number |
4958 of "%" items. If there are not sufficient or too many | |
452 | 4959 arguments an error is given. Up to 18 arguments can be used. |
449 | 4960 |
4961 | |
667 | 4962 pumvisible() *pumvisible()* |
4963 Returns non-zero when the popup menu is visible, zero | |
4964 otherwise. See |ins-completion-menu|. | |
712 | 4965 This can be used to avoid some things that would remove the |
4966 popup menu. | |
7 | 4967 |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
4968 *E860* |
3682 | 4969 py3eval({expr}) *py3eval()* |
4970 Evaluate Python expression {expr} and return its result | |
4971 converted to Vim data structures. | |
4972 Numbers and strings are returned as they are (strings are | |
6647 | 4973 copied though, Unicode strings are additionally converted to |
3682 | 4974 'encoding'). |
4975 Lists are represented as Vim |List| type. | |
4976 Dictionaries are represented as Vim |Dictionary| type with | |
4977 keys converted to strings. | |
4978 {only available when compiled with the |+python3| feature} | |
4979 | |
4980 *E858* *E859* | |
4981 pyeval({expr}) *pyeval()* | |
4982 Evaluate Python expression {expr} and return its result | |
4983 converted to Vim data structures. | |
4984 Numbers and strings are returned as they are (strings are | |
4985 copied though). | |
4986 Lists are represented as Vim |List| type. | |
3830 | 4987 Dictionaries are represented as Vim |Dictionary| type, |
4988 non-string keys result in error. | |
3682 | 4989 {only available when compiled with the |+python| feature} |
4990 | |
114 | 4991 *E726* *E727* |
99 | 4992 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 4993 Returns a |List| with Numbers: |
99 | 4994 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
4995 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
4996 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
4997 {max}] (increasing {expr} with {stride} each time, not | |
4998 producing a value past {max}). | |
336 | 4999 When the maximum is one before the start the result is an |
5000 empty list. When the maximum is more than one before the | |
5001 start this is an error. | |
99 | 5002 Examples: > |
856 | 5003 range(4) " [0, 1, 2, 3] |
99 | 5004 range(2, 4) " [2, 3, 4] |
5005 range(2, 9, 3) " [2, 5, 8] | |
856 | 5006 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 5007 range(0) " [] |
5008 range(2, 0) " error! | |
99 | 5009 < |
158 | 5010 *readfile()* |
168 | 5011 readfile({fname} [, {binary} [, {max}]]) |
685 | 5012 Read file {fname} and return a |List|, each line of the file |
5013 as an item. Lines broken at NL characters. Macintosh files | |
158 | 5014 separated with CR will result in a single long line (unless a |
5015 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
|
5016 All NUL characters are replaced with a NL character. |
6918 | 5017 When {binary} contains "b" binary mode is used: |
158 | 5018 - When the last line ends in a NL an extra empty list item is |
5019 added. | |
5020 - No CR characters are removed. | |
5021 Otherwise: | |
5022 - CR characters that appear before a NL are removed. | |
5023 - 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
|
5024 - 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
|
5025 removed from the text. |
168 | 5026 When {max} is given this specifies the maximum number of lines |
5027 to be read. Useful if you only want to check the first ten | |
5028 lines of a file: > | |
5029 :for line in readfile(fname, '', 10) | |
5030 : if line =~ 'Date' | echo line | endif | |
5031 :endfor | |
233 | 5032 < When {max} is negative -{max} lines from the end of the file |
5033 are returned, or as many as there are. | |
5034 When {max} is zero the result is an empty list. | |
168 | 5035 Note that without {max} the whole file is read into memory. |
5036 Also note that there is no recognition of encoding. Read a | |
5037 file into a buffer if you need to. | |
158 | 5038 When the file can't be opened an error message is given and |
5039 the result is an empty list. | |
5040 Also see |writefile()|. | |
5041 | |
794 | 5042 reltime([{start} [, {end}]]) *reltime()* |
5043 Return an item that represents a time value. The format of | |
5044 the item depends on the system. It can be passed to | |
5045 |reltimestr()| to convert it to a string. | |
5046 Without an argument it returns the current time. | |
5047 With one argument is returns the time passed since the time | |
5048 specified in the argument. | |
843 | 5049 With two arguments it returns the time passed between {start} |
794 | 5050 and {end}. |
5051 The {start} and {end} arguments must be values returned by | |
5052 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5053 {only available when compiled with the |+reltime| feature} |
794 | 5054 |
5055 reltimestr({time}) *reltimestr()* | |
5056 Return a String that represents the time value of {time}. | |
5057 This is the number of seconds, a dot and the number of | |
5058 microseconds. Example: > | |
5059 let start = reltime() | |
5060 call MyFunction() | |
5061 echo reltimestr(reltime(start)) | |
5062 < Note that overhead for the commands will be added to the time. | |
5063 The accuracy depends on the system. | |
1156 | 5064 Leading spaces are used to make the string align nicely. You |
5065 can use split() to remove it. > | |
5066 echo split(reltimestr(reltime(start)))[0] | |
5067 < 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
|
5068 {only available when compiled with the |+reltime| feature} |
794 | 5069 |
7 | 5070 *remote_expr()* *E449* |
5071 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 5072 Send the {string} to {server}. The string is sent as an |
7 | 5073 expression and the result is returned after evaluation. |
714 | 5074 The result must be a String or a |List|. A |List| is turned |
5075 into a String by joining the items with a line break in | |
5076 between (not at the end), like with join(expr, "\n"). | |
7 | 5077 If {idvar} is present, it is taken as the name of a |
5078 variable and a {serverid} for later use with | |
5079 remote_read() is stored there. | |
5080 See also |clientserver| |RemoteReply|. | |
5081 This function is not available in the |sandbox|. | |
5082 {only available when compiled with the |+clientserver| feature} | |
5083 Note: Any errors will cause a local error message to be issued | |
5084 and the result will be the empty string. | |
5085 Examples: > | |
5086 :echo remote_expr("gvim", "2+2") | |
5087 :echo remote_expr("gvim1", "b:current_syntax") | |
5088 < | |
5089 | |
5090 remote_foreground({server}) *remote_foreground()* | |
5091 Move the Vim server with the name {server} to the foreground. | |
5092 This works like: > | |
5093 remote_expr({server}, "foreground()") | |
5094 < Except that on Win32 systems the client does the work, to work | |
5095 around the problem that the OS doesn't always allow the server | |
5096 to bring itself to the foreground. | |
574 | 5097 Note: This does not restore the window if it was minimized, |
5098 like foreground() does. | |
7 | 5099 This function is not available in the |sandbox|. |
5100 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
5101 Win32 console version} | |
5102 | |
5103 | |
5104 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
5105 Returns a positive number if there are available strings | |
5106 from {serverid}. Copies any reply string into the variable | |
1621 | 5107 {retvar} if specified. {retvar} must be a string with the |
7 | 5108 name of a variable. |
5109 Returns zero if none are available. | |
5110 Returns -1 if something is wrong. | |
5111 See also |clientserver|. | |
5112 This function is not available in the |sandbox|. | |
5113 {only available when compiled with the |+clientserver| feature} | |
5114 Examples: > | |
5115 :let repl = "" | |
5116 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
5117 | |
5118 remote_read({serverid}) *remote_read()* | |
5119 Return the oldest available reply from {serverid} and consume | |
5120 it. It blocks until a reply is available. | |
5121 See also |clientserver|. | |
5122 This function is not available in the |sandbox|. | |
5123 {only available when compiled with the |+clientserver| feature} | |
5124 Example: > | |
5125 :echo remote_read(id) | |
5126 < | |
5127 *remote_send()* *E241* | |
5128 remote_send({server}, {string} [, {idvar}]) | |
1621 | 5129 Send the {string} to {server}. The string is sent as input |
22 | 5130 keys and the function returns immediately. At the Vim server |
5131 the keys are not mapped |:map|. | |
667 | 5132 If {idvar} is present, it is taken as the name of a variable |
5133 and a {serverid} for later use with remote_read() is stored | |
5134 there. | |
7 | 5135 See also |clientserver| |RemoteReply|. |
5136 This function is not available in the |sandbox|. | |
5137 {only available when compiled with the |+clientserver| feature} | |
5138 Note: Any errors will be reported in the server and may mess | |
5139 up the display. | |
5140 Examples: > | |
5141 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
5142 \ remote_read(serverid) | |
5143 | |
5144 :autocmd NONE RemoteReply * | |
5145 \ echo remote_read(expand("<amatch>")) | |
5146 :echo remote_send("gvim", ":sleep 10 | echo ". | |
5147 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 5148 < |
79 | 5149 remove({list}, {idx} [, {end}]) *remove()* |
685 | 5150 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
|
5151 return the item. |
79 | 5152 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5153 return a List with these items. When {idx} points to the same |
79 | 5154 item as {end} a list with one item is returned. When {end} |
5155 points to an item before {idx} this is an error. | |
5156 See |list-index| for possible values of {idx} and {end}. | |
55 | 5157 Example: > |
5158 :echo "last item: " . remove(mylist, -1) | |
79 | 5159 :call remove(mylist, 0, 9) |
99 | 5160 remove({dict}, {key}) |
5161 Remove the entry from {dict} with key {key}. Example: > | |
5162 :echo "removed " . remove(dict, "one") | |
5163 < If there is no {key} in {dict} this is an error. | |
5164 | |
5165 Use |delete()| to remove a file. | |
55 | 5166 |
7 | 5167 rename({from}, {to}) *rename()* |
5168 Rename the file by the name {from} to the name {to}. This | |
5169 should also work to move files across file systems. The | |
5170 result is a Number, which is 0 if the file was renamed | |
5171 successfully, and non-zero when the renaming failed. | |
1851 | 5172 NOTE: If {to} exists it is overwritten without warning. |
7 | 5173 This function is not available in the |sandbox|. |
5174 | |
18 | 5175 repeat({expr}, {count}) *repeat()* |
5176 Repeat {expr} {count} times and return the concatenated | |
5177 result. Example: > | |
843 | 5178 :let separator = repeat('-', 80) |
18 | 5179 < When {count} is zero or negative the result is empty. |
685 | 5180 When {expr} is a |List| the result is {expr} concatenated |
1621 | 5181 {count} times. Example: > |
79 | 5182 :let longlist = repeat(['a', 'b'], 3) |
5183 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 5184 |
82 | 5185 |
7 | 5186 resolve({filename}) *resolve()* *E655* |
5187 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
5188 returns the path the shortcut points to in a simplified form. | |
5189 On Unix, repeat resolving symbolic links in all path | |
5190 components of {filename} and return the simplified result. | |
5191 To cope with link cycles, resolving of symbolic links is | |
5192 stopped after 100 iterations. | |
5193 On other systems, return the simplified {filename}. | |
5194 The simplification step is done as by |simplify()|. | |
5195 resolve() keeps a leading path component specifying the | |
5196 current directory (provided the result is still a relative | |
5197 path name) and also keeps a trailing path separator. | |
5198 | |
82 | 5199 *reverse()* |
1621 | 5200 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 5201 {list}. |
5202 If you want a list to remain unmodified make a copy first: > | |
5203 :let revlist = reverse(copy(mylist)) | |
5204 | |
1621 | 5205 round({expr}) *round()* |
1668 | 5206 Round off {expr} to the nearest integral value and return it |
1621 | 5207 as a |Float|. If {expr} lies halfway between two integral |
5208 values, then use the larger one (away from zero). | |
5209 {expr} must evaluate to a |Float| or a |Number|. | |
5210 Examples: > | |
5211 echo round(0.456) | |
5212 < 0.0 > | |
5213 echo round(4.5) | |
5214 < 5.0 > | |
5215 echo round(-4.5) | |
5216 < -5.0 | |
5217 {only available when compiled with the |+float| feature} | |
3996 | 5218 |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5219 screenattr(row, col) *screenattr()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5220 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
|
5221 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
|
5222 attribute at other positions. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5223 |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5224 screenchar(row, col) *screenchar()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5225 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
|
5226 [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
|
5227 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
|
5228 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
|
5229 The character excludes composing characters. For double-byte |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5230 encodings it may only be the first byte. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5231 This is mainly to be used for testing. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5232 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
|
5233 |
3996 | 5234 screencol() *screencol()* |
5235 The result is a Number, which is the current screen column of | |
5236 the cursor. The leftmost column has number 1. | |
5237 This function is mainly used for testing. | |
5238 | |
5239 Note: Always returns the current screen column, thus if used | |
5240 in a command (e.g. ":echo screencol()") it will return the | |
5241 column inside the command line, which is 1 when the command is | |
5242 executed. To get the cursor position in the file use one of | |
5243 the following mappings: > | |
5244 nnoremap <expr> GG ":echom ".screencol()."\n" | |
5245 nnoremap <silent> GG :echom screencol()<CR> | |
5246 < | |
5247 screenrow() *screenrow()* | |
5248 The result is a Number, which is the current screen row of the | |
5249 cursor. The top line has number one. | |
5250 This function is mainly used for testing. | |
5251 | |
5252 Note: Same restrictions as with |screencol()|. | |
5253 | |
1496 | 5254 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 5255 Search for regexp pattern {pattern}. The search starts at the |
119 | 5256 cursor position (you can use |cursor()| to set it). |
707 | 5257 |
3967 | 5258 When a match has been found its line number is returned. |
3312 | 5259 If there is no match a 0 is returned and the cursor doesn't |
5260 move. No error message is given. | |
5261 | |
7 | 5262 {flags} is a String, which can contain these character flags: |
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5263 'b' search Backward instead of forward |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5264 'c' accept a match at the Cursor position |
712 | 5265 'e' move to the End of the match |
20 | 5266 'n' do Not move the cursor |
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5267 'p' return number of matching sub-Pattern (see below) |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5268 's' Set the ' mark at the previous location of the cursor |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5269 'w' Wrap around the end of the file |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5270 'W' don't Wrap around the end of the file |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5271 'z' start searching at the cursor column instead of zero |
7 | 5272 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
5273 | |
444 | 5274 If the 's' flag is supplied, the ' mark is set, only if the |
5275 cursor is moved. The 's' flag cannot be combined with the 'n' | |
5276 flag. | |
5277 | |
1156 | 5278 'ignorecase', 'smartcase' and 'magic' are used. |
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5279 |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5280 When the 'z' flag is not given seaching always starts in |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5281 column zero and then matches before the cursor are skipped. |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5282 When the 'c' flag is present in 'cpo' the next search starts |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5283 after the match. Without the 'c' flag the next search starts |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5284 one column further. |
1156 | 5285 |
692 | 5286 When the {stopline} argument is given then the search stops |
5287 after searching this line. This is useful to restrict the | |
5288 search to a range of lines. Examples: > | |
5289 let match = search('(', 'b', line("w0")) | |
5290 let end = search('END', '', line("w$")) | |
5291 < When {stopline} is used and it is not zero this also implies | |
5292 that the search does not wrap around the end of the file. | |
1496 | 5293 A zero value is equal to not giving the argument. |
5294 | |
5295 When the {timeout} argument is given the search stops when | |
3513 | 5296 more than this many milliseconds have passed. Thus when |
1496 | 5297 {timeout} is 500 the search stops after half a second. |
5298 The value must not be negative. A zero value is like not | |
5299 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
|
5300 {only available when compiled with the |+reltime| feature} |
692 | 5301 |
714 | 5302 *search()-sub-match* |
5303 With the 'p' flag the returned value is one more than the | |
5304 first sub-match in \(\). One if none of them matched but the | |
5305 whole pattern did match. | |
712 | 5306 To get the column number too use |searchpos()|. |
5307 | |
20 | 5308 The cursor will be positioned at the match, unless the 'n' |
707 | 5309 flag is used. |
7 | 5310 |
5311 Example (goes over all files in the argument list): > | |
5312 :let n = 1 | |
5313 :while n <= argc() " loop over all files in arglist | |
5314 : exe "argument " . n | |
5315 : " start at the last char in the file and wrap for the | |
5316 : " first search to find match at start of file | |
5317 : normal G$ | |
5318 : let flags = "w" | |
5319 : while search("foo", flags) > 0 | |
1621 | 5320 : s/foo/bar/g |
7 | 5321 : let flags = "W" |
5322 : endwhile | |
5323 : update " write the file if modified | |
5324 : let n = n + 1 | |
5325 :endwhile | |
5326 < | |
712 | 5327 Example for using some flags: > |
5328 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
5329 < This will search for the keywords "if", "else", and "endif" | |
5330 under or after the cursor. Because of the 'p' flag, it | |
5331 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
5332 if the search fails. With the cursor on the first word of the | |
5333 line: | |
5334 if (foo == 0) | let foo = foo + 1 | endif ~ | |
5335 the function returns 1. Without the 'c' flag, the function | |
5336 finds the "endif" and returns 3. The same thing happens | |
5337 without the 'e' flag if the cursor is on the "f" of "if". | |
5338 The 'n' flag tells the function not to move the cursor. | |
5339 | |
504 | 5340 |
523 | 5341 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
5342 Search for the declaration of {name}. | |
856 | 5343 |
523 | 5344 With a non-zero {global} argument it works like |gD|, find |
5345 first match in the file. Otherwise it works like |gd|, find | |
5346 first match in the function. | |
5347 | |
5348 With a non-zero {thisblock} argument matches in a {} block | |
5349 that ends before the cursor position are ignored. Avoids | |
5350 finding variable declarations only valid in another scope. | |
5351 | |
504 | 5352 Moves the cursor to the found match. |
5353 Returns zero for success, non-zero for failure. | |
5354 Example: > | |
5355 if searchdecl('myvar') == 0 | |
5356 echo getline('.') | |
5357 endif | |
5358 < | |
7 | 5359 *searchpair()* |
1496 | 5360 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
5361 [, {stopline} [, {timeout}]]]]) | |
7 | 5362 Search for the match of a nested start-end pair. This can be |
5363 used to find the "endif" that matches an "if", while other | |
5364 if/endif pairs in between are ignored. | |
677 | 5365 The search starts at the cursor. The default is to search |
5366 forward, include 'b' in {flags} to search backward. | |
5367 If a match is found, the cursor is positioned at it and the | |
5368 line number is returned. If no match is found 0 or -1 is | |
5369 returned and the cursor doesn't move. No error message is | |
5370 given. | |
7 | 5371 |
5372 {start}, {middle} and {end} are patterns, see |pattern|. They | |
5373 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
5374 {middle} is not empty, it is found when searching from either | |
5375 direction, but only when not in a nested start-end pair. A | |
5376 typical use is: > | |
5377 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
5378 < By leaving {middle} empty the "else" is skipped. | |
5379 | |
712 | 5380 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
5381 |search()|. Additionally: | |
7 | 5382 'r' Repeat until no more matches found; will find the |
1621 | 5383 outer pair. Implies the 'W' flag. |
5384 'm' Return number of matches instead of line number with | |
712 | 5385 the match; will be > 1 when 'r' is used. |
1621 | 5386 Note: it's nearly always a good idea to use the 'W' flag, to |
5387 avoid wrapping around the end of the file. | |
7 | 5388 |
5389 When a match for {start}, {middle} or {end} is found, the | |
5390 {skip} expression is evaluated with the cursor positioned on | |
5391 the start of the match. It should return non-zero if this | |
5392 match is to be skipped. E.g., because it is inside a comment | |
5393 or a string. | |
5394 When {skip} is omitted or empty, every match is accepted. | |
5395 When evaluating {skip} causes an error the search is aborted | |
5396 and -1 returned. | |
5397 | |
1496 | 5398 For {stopline} and {timeout} see |search()|. |
692 | 5399 |
7 | 5400 The value of 'ignorecase' is used. 'magic' is ignored, the |
5401 patterns are used like it's on. | |
5402 | |
5403 The search starts exactly at the cursor. A match with | |
5404 {start}, {middle} or {end} at the next character, in the | |
5405 direction of searching, is the first one found. Example: > | |
5406 if 1 | |
5407 if 2 | |
5408 endif 2 | |
5409 endif 1 | |
5410 < When starting at the "if 2", with the cursor on the "i", and | |
5411 searching forwards, the "endif 2" is found. When starting on | |
5412 the character just before the "if 2", the "endif 1" will be | |
1621 | 5413 found. That's because the "if 2" will be found first, and |
7 | 5414 then this is considered to be a nested if/endif from "if 2" to |
5415 "endif 2". | |
5416 When searching backwards and {end} is more than one character, | |
5417 it may be useful to put "\zs" at the end of the pattern, so | |
5418 that when the cursor is inside a match with the end it finds | |
5419 the matching start. | |
5420 | |
5421 Example, to find the "endif" command in a Vim script: > | |
5422 | |
5423 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
5424 \ 'getline(".") =~ "^\\s*\""') | |
5425 | |
5426 < The cursor must be at or after the "if" for which a match is | |
5427 to be found. Note that single-quote strings are used to avoid | |
5428 having to double the backslashes. The skip expression only | |
5429 catches comments at the start of a line, not after a command. | |
5430 Also, a word "en" or "if" halfway a line is considered a | |
5431 match. | |
5432 Another example, to search for the matching "{" of a "}": > | |
5433 | |
5434 :echo searchpair('{', '', '}', 'bW') | |
5435 | |
5436 < This works when the cursor is at or before the "}" for which a | |
5437 match is to be found. To reject matches that syntax | |
5438 highlighting recognized as strings: > | |
5439 | |
5440 :echo searchpair('{', '', '}', 'bW', | |
5441 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
5442 < | |
667 | 5443 *searchpairpos()* |
1496 | 5444 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
5445 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5446 Same as |searchpair()|, but returns a |List| with the line and |
685 | 5447 column position of the match. The first element of the |List| |
5448 is the line number and the second element is the byte index of | |
667 | 5449 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
|
5450 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5451 |
667 | 5452 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
5453 < | |
5454 See |match-parens| for a bigger and more useful example. | |
5455 | |
1496 | 5456 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 5457 Same as |search()|, but returns a |List| with the line and |
685 | 5458 column position of the match. The first element of the |List| |
5459 is the line number and the second element is the byte index of | |
5460 the column position of the match. If no match is found, | |
5461 returns [0, 0]. | |
714 | 5462 Example: > |
5463 :let [lnum, col] = searchpos('mypattern', 'n') | |
5464 | |
5465 < When the 'p' flag is given then there is an extra item with | |
5466 the sub-pattern match number |search()-sub-match|. Example: > | |
5467 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
5468 < In this example "submatch" is 2 when a lowercase letter is | |
5469 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
5470 | |
7 | 5471 server2client( {clientid}, {string}) *server2client()* |
5472 Send a reply string to {clientid}. The most recent {clientid} | |
5473 that sent a string can be retrieved with expand("<client>"). | |
5474 {only available when compiled with the |+clientserver| feature} | |
5475 Note: | |
5476 This id has to be stored before the next command can be | |
236 | 5477 received. I.e. before returning from the received command and |
7 | 5478 before calling any commands that waits for input. |
5479 See also |clientserver|. | |
5480 Example: > | |
5481 :echo server2client(expand("<client>"), "HELLO") | |
5482 < | |
5483 serverlist() *serverlist()* | |
5484 Return a list of available server names, one per line. | |
5485 When there are no servers or the information is not available | |
5486 an empty string is returned. See also |clientserver|. | |
5487 {only available when compiled with the |+clientserver| feature} | |
5488 Example: > | |
5489 :echo serverlist() | |
5490 < | |
5491 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
5492 Set option or local variable {varname} in buffer {expr} to | |
5493 {val}. | |
5494 This also works for a global or local window option, but it | |
5495 doesn't work for a global or local window variable. | |
5496 For a local window option the global value is unchanged. | |
5497 For the use of {expr}, see |bufname()| above. | |
5498 Note that the variable name without "b:" must be used. | |
5499 Examples: > | |
5500 :call setbufvar(1, "&mod", 1) | |
5501 :call setbufvar("todo", "myvar", "foobar") | |
5502 < This function is not available in the |sandbox|. | |
5503 | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
5504 setcharsearch({dict}) *setcharsearch()* |
6991 | 5505 Set the current character search information to {dict}, |
5506 which contains one or more of the following entries: | |
5507 | |
5508 char character which will be used for a subsequent | |
5509 |,| or |;| command; an empty string clears the | |
5510 character search | |
5511 forward direction of character search; 1 for forward, | |
5512 0 for backward | |
5513 until type of character search; 1 for a |t| or |T| | |
5514 character search, 0 for an |f| or |F| | |
5515 character search | |
5516 | |
5517 This can be useful to save/restore a user's character search | |
5518 from a script: > | |
5519 :let prevsearch = getcharsearch() | |
5520 :" Perform a command which clobbers user's search | |
5521 :call setcharsearch(prevsearch) | |
5522 < Also see |getcharsearch()|. | |
5523 | |
7 | 5524 setcmdpos({pos}) *setcmdpos()* |
5525 Set the cursor position in the command line to byte position | |
1621 | 5526 {pos}. The first position is 1. |
7 | 5527 Use |getcmdpos()| to obtain the current position. |
5528 Only works while editing the command line, thus you must use | |
99 | 5529 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
5530 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
5531 set after the command line is set to the expression. For | |
5532 |c_CTRL-R_=| it is set after evaluating the expression but | |
5533 before inserting the resulting text. | |
7 | 5534 When the number is too big the cursor is put at the end of the |
5535 line. A number smaller than one has undefined results. | |
5536 Returns 0 when successful, 1 when not editing the command | |
5537 line. | |
5538 | |
1621 | 5539 setline({lnum}, {text}) *setline()* |
3312 | 5540 Set line {lnum} of the current buffer to {text}. To insert |
5541 lines use |append()|. | |
236 | 5542 {lnum} is used like with |getline()|. |
1621 | 5543 When {lnum} is just below the last line the {text} will be |
282 | 5544 added as a new line. |
236 | 5545 If this succeeds, 0 is returned. If this fails (most likely |
5546 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 5547 :call setline(5, strftime("%c")) |
1621 | 5548 < When {text} is a |List| then line {lnum} and following lines |
282 | 5549 will be set to the items in the list. Example: > |
5550 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
5551 < This is equivalent to: > | |
3465 | 5552 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
282 | 5553 : call setline(n, l) |
5554 :endfor | |
7 | 5555 < Note: The '[ and '] marks are not set. |
5556 | |
647 | 5557 setloclist({nr}, {list} [, {action}]) *setloclist()* |
5558 Create or replace or add to the location list for window {nr}. | |
5559 When {nr} is zero the current window is used. For a location | |
648 | 5560 list window, the displayed location list is modified. For an |
5561 invalid window number {nr}, -1 is returned. | |
1326 | 5562 Otherwise, same as |setqflist()|. |
5563 Also see |location-list|. | |
5564 | |
5565 setmatches({list}) *setmatches()* | |
5566 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 5567 if successful, otherwise -1. All current matches are cleared |
1326 | 5568 before the list is restored. See example for |getmatches()|. |
230 | 5569 |
707 | 5570 *setpos()* |
5571 setpos({expr}, {list}) | |
5572 Set the position for {expr}. Possible values: | |
5573 . the cursor | |
5574 'x mark x | |
5575 | |
5938 | 5576 {list} must be a |List| with four or five numbers: |
707 | 5577 [bufnum, lnum, col, off] |
5938 | 5578 [bufnum, lnum, col, off, curswant] |
707 | 5579 |
1621 | 5580 "bufnum" is the buffer number. Zero can be used for the |
856 | 5581 current buffer. Setting the cursor is only possible for |
707 | 5582 the current buffer. To set a mark in another buffer you can |
5583 use the |bufnr()| function to turn a file name into a buffer | |
5584 number. | |
798 | 5585 Does not change the jumplist. |
707 | 5586 |
5587 "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
|
5588 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
|
5589 smaller than 1 then 1 is used. |
707 | 5590 |
5591 The "off" number is only used when 'virtualedit' is set. Then | |
5592 it is the offset in screen columns from the start of the | |
1266 | 5593 character. E.g., a position within a <Tab> or after the last |
707 | 5594 character. |
5595 | |
5938 | 5596 The "curswant" number is only used when setting the cursor |
5597 position. It sets the preferred column for when moving the | |
5598 cursor vertically. When the "curswant" number is missing the | |
5599 preferred column is not set. When it is present and setting a | |
5600 mark position it is not used. | |
5601 | |
5555 | 5602 Note that for '< and '> changing the line number may result in |
5603 the marks to be effectively be swapped, so that '< is always | |
5604 before '>. | |
5605 | |
1533 | 5606 Returns 0 when the position could be set, -1 otherwise. |
5607 An error message is given if {expr} is invalid. | |
5608 | |
5944 | 5609 Also see |getpos()| and |getcurpos()|. |
707 | 5610 |
1156 | 5611 This does not restore the preferred column for moving |
5938 | 5612 vertically; if you set the cursor position with this, |j| and |
5613 |k| motions will jump to previous columns! Use |cursor()| to | |
5614 also set the preferred column. Also see the "curswant" key in | |
5615 |winrestview()|. | |
1156 | 5616 |
707 | 5617 |
277 | 5618 setqflist({list} [, {action}]) *setqflist()* |
647 | 5619 Create or replace or add to the quickfix list using the items |
5620 in {list}. Each item in {list} is a dictionary. | |
5621 Non-dictionary items in {list} are ignored. Each dictionary | |
5622 item can contain the following entries: | |
230 | 5623 |
1065 | 5624 bufnr buffer number; must be the number of a valid |
1621 | 5625 buffer |
1065 | 5626 filename name of a file; only used when "bufnr" is not |
1621 | 5627 present or it is invalid. |
230 | 5628 lnum line number in the file |
233 | 5629 pattern search pattern used to locate the error |
230 | 5630 col column number |
233 | 5631 vcol when non-zero: "col" is visual column |
856 | 5632 when zero: "col" is byte index |
233 | 5633 nr error number |
230 | 5634 text description of the error |
233 | 5635 type single-character error type, 'E', 'W', etc. |
5636 | |
5637 The "col", "vcol", "nr", "type" and "text" entries are | |
5638 optional. Either "lnum" or "pattern" entry can be used to | |
5639 locate a matching error line. | |
1065 | 5640 If the "filename" and "bufnr" entries are not present or |
5641 neither the "lnum" or "pattern" entries are present, then the | |
5642 item will not be handled as an error line. | |
230 | 5643 If both "pattern" and "lnum" are present then "pattern" will |
5644 be used. | |
2152 | 5645 If you supply an empty {list}, the quickfix list will be |
5646 cleared. | |
1065 | 5647 Note that the list is not exactly the same as what |
5648 |getqflist()| returns. | |
230 | 5649 |
277 | 5650 If {action} is set to 'a', then the items from {list} are |
5651 added to the existing quickfix list. If there is no existing | |
5652 list, then a new list is created. If {action} is set to 'r', | |
5653 then the items from the current quickfix list are replaced | |
5654 with the items from {list}. If {action} is not present or is | |
5655 set to ' ', then a new list is created. | |
5656 | |
230 | 5657 Returns zero for success, -1 for failure. |
5658 | |
5659 This function can be used to create a quickfix list | |
5660 independent of the 'errorformat' setting. Use a command like | |
5661 ":cc 1" to jump to the first position. | |
5662 | |
5663 | |
7 | 5664 *setreg()* |
5665 setreg({regname}, {value} [,{options}]) | |
5666 Set the register {regname} to {value}. | |
5798 | 5667 {value} may be any value returned by |getreg()|, including |
5668 a |List|. | |
7 | 5669 If {options} contains "a" or {regname} is upper case, |
5670 then the value is appended. | |
2423 | 5671 {options} can also contain a register type specification: |
7 | 5672 "c" or "v" |characterwise| mode |
5673 "l" or "V" |linewise| mode | |
5674 "b" or "<CTRL-V>" |blockwise-visual| mode | |
5675 If a number immediately follows "b" or "<CTRL-V>" then this is | |
5676 used as the width of the selection - if it is not specified | |
5677 then the width of the block is set to the number of characters | |
1266 | 5678 in the longest line (counting a <Tab> as 1 character). |
7 | 5679 |
5680 If {options} contains no register settings, then the default | |
5798 | 5681 is to use character mode unless {value} ends in a <NL> for |
5682 string {value} and linewise mode for list {value}. Blockwise | |
5683 mode is never selected automatically. | |
5684 Returns zero for success, non-zero for failure. | |
5685 | |
5686 *E883* | |
6180 | 5687 Note: you may not use |List| containing more than one item to |
5798 | 5688 set search and expression registers. Lists containing no |
5689 items act like empty strings. | |
7 | 5690 |
5691 Examples: > | |
5692 :call setreg(v:register, @*) | |
5693 :call setreg('*', @%, 'ac') | |
5694 :call setreg('a', "1\n2\n3", 'b5') | |
5695 | |
5696 < This example shows using the functions to save and restore a | |
5798 | 5697 register (note: you may not reliably restore register value |
5698 without using the third argument to |getreg()| as without it | |
5699 newlines are represented as newlines AND Nul bytes are | |
5700 represented as newlines as well, see |NL-used-for-Nul|). > | |
5701 :let var_a = getreg('a', 1, 1) | |
7 | 5702 :let var_amode = getregtype('a') |
5703 .... | |
5704 :call setreg('a', var_a, var_amode) | |
5705 | |
5706 < You can also change the type of a register by appending | |
5707 nothing: > | |
5708 :call setreg('a', '', 'al') | |
5709 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5710 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5711 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
|
5712 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5713 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
|
5714 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5715 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5716 |
831 | 5717 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
5718 Set option or local variable {varname} in window {winnr} to | |
5719 {val}. | |
5720 Tabs are numbered starting with one. For the current tabpage | |
5721 use |setwinvar()|. | |
5722 When {winnr} is zero the current window is used. | |
7 | 5723 This also works for a global or local buffer option, but it |
5724 doesn't work for a global or local buffer variable. | |
5725 For a local buffer option the global value is unchanged. | |
5726 Note that the variable name without "w:" must be used. | |
831 | 5727 Examples: > |
5728 :call settabwinvar(1, 1, "&list", 0) | |
5729 :call settabwinvar(3, 2, "myvar", "foobar") | |
5730 < This function is not available in the |sandbox|. | |
5731 | |
5732 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
5733 Like |settabwinvar()| for the current tab page. | |
7 | 5734 Examples: > |
5735 :call setwinvar(1, "&list", 0) | |
5736 :call setwinvar(2, "myvar", "foobar") | |
5737 | |
4126 | 5738 sha256({string}) *sha256()* |
6647 | 5739 Returns a String with 64 hex characters, which is the SHA256 |
4126 | 5740 checksum of {string}. |
5741 {only available when compiled with the |+cryptv| feature} | |
5742 | |
1661 | 5743 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5744 Escape {string} for use as a shell command argument. |
985 | 5745 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 5746 will enclose {string} in double quotes and double all double |
985 | 5747 quotes within {string}. |
5748 For other systems, it will enclose {string} in single quotes | |
5749 and replace all "'" with "'\''". | |
1661 | 5750 When the {special} argument is present and it's a non-zero |
5751 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 5752 items such as "!", "%", "#" and "<cword>" will be preceded by |
5753 a backslash. This backslash will be removed again by the |:!| | |
1661 | 5754 command. |
1698 | 5755 The "!" character will be escaped (again with a |non-zero-arg| |
5756 {special}) when 'shell' contains "csh" in the tail. That is | |
5757 because for csh and tcsh "!" is used for history replacement | |
5758 even when inside single quotes. | |
5759 The <NL> character is also escaped. With a |non-zero-arg| | |
5760 {special} and 'shell' containing "csh" in the tail it's | |
5761 escaped a second time. | |
1661 | 5762 Example of use with a |:!| command: > |
5763 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
5764 < This results in a directory listing for the file under the | |
5765 cursor. Example of use with |system()|: > | |
5766 :call system("chmod +w -- " . shellescape(expand("%"))) | |
5690 | 5767 < See also |::S|. |
985 | 5768 |
5769 | |
3875 | 5770 shiftwidth() *shiftwidth()* |
5771 Returns the effective value of 'shiftwidth'. This is the | |
5772 'shiftwidth' value unless it is zero, in which case it is the | |
5773 'tabstop' value. To be backwards compatible in indent | |
5774 plugins, use this: > | |
5775 if exists('*shiftwidth') | |
5776 func s:sw() | |
5777 return shiftwidth() | |
5778 endfunc | |
5779 else | |
5780 func s:sw() | |
5781 return &sw | |
5782 endfunc | |
5783 endif | |
5784 < And then use s:sw() instead of &sw. | |
5785 | |
5786 | |
7 | 5787 simplify({filename}) *simplify()* |
5788 Simplify the file name as much as possible without changing | |
5789 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
5790 Unix) are not resolved. If the first path component in | |
5791 {filename} designates the current directory, this will be | |
5792 valid for the result as well. A trailing path separator is | |
5793 not removed either. | |
5794 Example: > | |
5795 simplify("./dir/.././/file/") == "./file/" | |
5796 < Note: The combination "dir/.." is only removed if "dir" is | |
5797 a searchable directory or does not exist. On Unix, it is also | |
5798 removed when "dir" is a symbolic link within the same | |
5799 directory. In order to resolve all the involved symbolic | |
5800 links before simplifying the path name, use |resolve()|. | |
5801 | |
82 | 5802 |
1621 | 5803 sin({expr}) *sin()* |
5804 Return the sine of {expr}, measured in radians, as a |Float|. | |
5805 {expr} must evaluate to a |Float| or a |Number|. | |
5806 Examples: > | |
5807 :echo sin(100) | |
5808 < -0.506366 > | |
5809 :echo sin(-4.01) | |
5810 < 0.763301 | |
5811 {only available when compiled with the |+float| feature} | |
5812 | |
5813 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5814 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5815 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
|
5816 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5817 {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
|
5818 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5819 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5820 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5821 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5822 < -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
|
5823 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5824 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5825 |
2902 | 5826 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
5747 | 5827 Sort the items in {list} in-place. Returns {list}. |
5828 | |
5829 If you want a list to remain unmodified make a copy first: > | |
82 | 5830 :let sortedlist = sort(copy(mylist)) |
5968 | 5831 |
6009 | 5832 < When {func} is omitted, is empty or zero, then sort() uses the |
5833 string representation of each item to sort on. Numbers sort | |
5834 after Strings, |Lists| after Numbers. For sorting text in the | |
5835 current buffer use |:sort|. | |
5836 | |
6180 | 5837 When {func} is given and it is '1' or 'i' then case is |
6009 | 5838 ignored. |
5839 | |
5840 When {func} is given and it is 'n' then all items will be | |
5841 sorted numerical (Implementation detail: This uses the | |
5842 strtod() function to parse numbers, Strings, Lists, Dicts and | |
5843 Funcrefs will be considered as being 0). | |
5844 | |
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5845 When {func} is given and it is 'N' then all items will be |
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5846 sorted numerical. This is like 'n' but a string containing |
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5847 digits will be used as the number they represent. |
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5848 |
685 | 5849 When {func} is a |Funcref| or a function name, this function |
5850 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
|
5851 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
|
5852 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
|
5853 smaller if the first one sorts before the second one. |
5747 | 5854 |
5855 {dict} is for functions with the "dict" attribute. It will be | |
5856 used to set the local variable "self". |Dictionary-function| | |
5857 | |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5858 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
|
5859 string) will keep their relative position. E.g., when sorting |
6051 | 5860 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
|
5861 same order as they were originally. |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5862 |
5747 | 5863 Also see |uniq()|. |
5864 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5865 Example: > |
82 | 5866 func MyCompare(i1, i2) |
5867 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
5868 endfunc | |
5869 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5870 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5871 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5872 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5873 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5874 endfunc |
344 | 5875 < |
374 | 5876 *soundfold()* |
5877 soundfold({word}) | |
5878 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 5879 language in 'spelllang' for the current window that supports |
375 | 5880 soundfolding. 'spell' must be set. When no sound folding is |
5881 possible the {word} is returned unmodified. | |
374 | 5882 This can be used for making spelling suggestions. Note that |
5883 the method can be quite slow. | |
5884 | |
344 | 5885 *spellbadword()* |
532 | 5886 spellbadword([{sentence}]) |
5887 Without argument: The result is the badly spelled word under | |
5888 or after the cursor. The cursor is moved to the start of the | |
5889 bad word. When no bad word is found in the cursor line the | |
5890 result is an empty string and the cursor doesn't move. | |
5891 | |
5892 With argument: The result is the first word in {sentence} that | |
5893 is badly spelled. If there are no spelling mistakes the | |
5894 result is an empty string. | |
5895 | |
5896 The return value is a list with two items: | |
5897 - The badly spelled word or an empty string. | |
5898 - The type of the spelling error: | |
856 | 5899 "bad" spelling mistake |
532 | 5900 "rare" rare word |
5901 "local" word only valid in another region | |
5902 "caps" word should start with Capital | |
5903 Example: > | |
5904 echo spellbadword("the quik brown fox") | |
5905 < ['quik', 'bad'] ~ | |
5906 | |
5907 The spelling information for the current window is used. The | |
5908 'spell' option must be set and the value of 'spelllang' is | |
5909 used. | |
344 | 5910 |
5911 *spellsuggest()* | |
537 | 5912 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 5913 Return a |List| with spelling suggestions to replace {word}. |
344 | 5914 When {max} is given up to this number of suggestions are |
5915 returned. Otherwise up to 25 suggestions are returned. | |
5916 | |
537 | 5917 When the {capital} argument is given and it's non-zero only |
5918 suggestions with a leading capital will be given. Use this | |
5919 after a match with 'spellcapcheck'. | |
5920 | |
344 | 5921 {word} can be a badly spelled word followed by other text. |
5922 This allows for joining two words that were split. The | |
359 | 5923 suggestions also include the following text, thus you can |
5924 replace a line. | |
5925 | |
5926 {word} may also be a good word. Similar words will then be | |
537 | 5927 returned. {word} itself is not included in the suggestions, |
5928 although it may appear capitalized. | |
344 | 5929 |
5930 The spelling information for the current window is used. The | |
375 | 5931 'spell' option must be set and the values of 'spelllang' and |
5932 'spellsuggest' are used. | |
344 | 5933 |
82 | 5934 |
282 | 5935 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 5936 Make a |List| out of {expr}. When {pattern} is omitted or |
5937 empty each white-separated sequence of characters becomes an | |
5938 item. | |
82 | 5939 Otherwise the string is split where {pattern} matches, |
3920 | 5940 removing the matched characters. 'ignorecase' is not used |
5941 here, add \c to ignore case. |/\c| | |
282 | 5942 When the first or last item is empty it is omitted, unless the |
5943 {keepempty} argument is given and it's non-zero. | |
293 | 5944 Other empty items are kept when {pattern} matches at least one |
5945 character or when {keepempty} is non-zero. | |
82 | 5946 Example: > |
95 | 5947 :let words = split(getline('.'), '\W\+') |
282 | 5948 < To split a string in individual characters: > |
236 | 5949 :for c in split(mystring, '\zs') |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
5950 < If you want to keep the separator you can also use '\zs' at |
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
5951 the end of the pattern: > |
258 | 5952 :echo split('abc:def:ghi', ':\zs') |
5953 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 5954 Splitting a table where the first element can be empty: > |
5955 :let items = split(line, ':', 1) | |
5956 < The opposite function is |join()|. | |
82 | 5957 |
5958 | |
1621 | 5959 sqrt({expr}) *sqrt()* |
5960 Return the non-negative square root of Float {expr} as a | |
5961 |Float|. | |
5962 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
5963 is negative the result is NaN (Not a Number). | |
5964 Examples: > | |
5965 :echo sqrt(100) | |
5966 < 10.0 > | |
5967 :echo sqrt(-4.01) | |
5968 < nan | |
1668 | 5969 "nan" may be different, it depends on system libraries. |
1621 | 5970 {only available when compiled with the |+float| feature} |
5971 | |
5972 | |
5973 str2float( {expr}) *str2float()* | |
5974 Convert String {expr} to a Float. This mostly works the same | |
5975 as when using a floating point number in an expression, see | |
5976 |floating-point-format|. But it's a bit more permissive. | |
5977 E.g., "1e40" is accepted, while in an expression you need to | |
5978 write "1.0e40". | |
5979 Text after the number is silently ignored. | |
5980 The decimal point is always '.', no matter what the locale is | |
5981 set to. A comma ends the number: "12,345.67" is converted to | |
5982 12.0. You can strip out thousands separators with | |
5983 |substitute()|: > | |
5984 let f = str2float(substitute(text, ',', '', 'g')) | |
5985 < {only available when compiled with the |+float| feature} | |
5986 | |
5987 | |
782 | 5988 str2nr( {expr} [, {base}]) *str2nr()* |
5989 Convert string {expr} to a number. | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
5990 {base} is the conversion base, it can be 2, 8, 10 or 16. |
782 | 5991 When {base} is omitted base 10 is used. This also means that |
5992 a leading zero doesn't cause octal conversion to be used, as | |
5993 with the default String to Number conversion. | |
5994 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
5995 different base the result will be zero. Similarly, when |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
5996 {base} is 8 a leading "0" is ignored, and when {base} is 2 a |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
5997 leading "0b" or "0B" is ignored. |
782 | 5998 Text after the number is silently ignored. |
856 | 5999 |
782 | 6000 |
6884 | 6001 strchars({expr} [, {skipcc}]) *strchars()* |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6002 The result is a Number, which is the number of characters |
6884 | 6003 in String {expr}. |
6004 When {skipcc} is omitted or zero, composing characters are | |
6005 counted separately. | |
6006 When {skipcc} set to 1, Composing characters are ignored. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6007 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6008 |
6918 | 6009 |
6010 {skipcc} is only available after 7.4.755. For backward | |
6011 compatibility, you can define a wrapper function: > | |
6012 if has("patch-7.4.755") | |
6013 function s:strchars(str, skipcc) | |
6014 return strchars(a:str, a:skipcc) | |
6015 endfunction | |
6016 else | |
6017 function s:strchars(str, skipcc) | |
6018 if a:skipcc | |
6019 return strlen(substitute(a:str, ".", "x", "g")) | |
6020 else | |
6021 return strchars(a:str) | |
6022 endif | |
6023 endfunction | |
6024 endif | |
6025 < | |
6026 | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6027 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6028 The result is a Number, which is the number of display cells |
6884 | 6029 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
|
6030 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6031 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6032 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6033 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
|
6034 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
|
6035 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6036 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6037 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6038 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6039 |
7 | 6040 strftime({format} [, {time}]) *strftime()* |
6041 The result is a String, which is a formatted date and time, as | |
6042 specified by the {format} string. The given {time} is used, | |
6043 or the current time if no time is given. The accepted | |
6044 {format} depends on your system, thus this is not portable! | |
6045 See the manual page of the C function strftime() for the | |
6046 format. The maximum length of the result is 80 characters. | |
6047 See also |localtime()| and |getftime()|. | |
6048 The language can be changed with the |:language| command. | |
6049 Examples: > | |
6050 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
6051 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
6052 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
6053 :echo strftime("%H:%M") 11:55 | |
6054 :echo strftime("%c", getftime("file.c")) | |
6055 Show mod time of file.c. | |
82 | 6056 < Not available on all systems. To check use: > |
6057 :if exists("*strftime") | |
6058 | |
133 | 6059 stridx({haystack}, {needle} [, {start}]) *stridx()* |
6060 The result is a Number, which gives the byte index in | |
6061 {haystack} of the first occurrence of the String {needle}. | |
140 | 6062 If {start} is specified, the search starts at index {start}. |
6063 This can be used to find a second match: > | |
2662 | 6064 :let colon1 = stridx(line, ":") |
6065 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 6066 < The search is done case-sensitive. |
205 | 6067 For pattern searches use |match()|. |
133 | 6068 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 6069 See also |strridx()|. |
6070 Examples: > | |
7 | 6071 :echo stridx("An Example", "Example") 3 |
6072 :echo stridx("Starting point", "Start") 0 | |
6073 :echo stridx("Starting point", "start") -1 | |
856 | 6074 < *strstr()* *strchr()* |
170 | 6075 stridx() works similar to the C function strstr(). When used |
6076 with a single character it works similar to strchr(). | |
6077 | |
55 | 6078 *string()* |
95 | 6079 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 6080 Float, String or a composition of them, then the result can be |
6081 parsed back with |eval()|. | |
55 | 6082 {expr} type result ~ |
99 | 6083 String 'string' |
95 | 6084 Number 123 |
1621 | 6085 Float 123.123456 or 1.123456e8 |
99 | 6086 Funcref function('name') |
95 | 6087 List [item, item] |
323 | 6088 Dictionary {key: value, key: value} |
99 | 6089 Note that in String values the ' character is doubled. |
1156 | 6090 Also see |strtrans()|. |
55 | 6091 |
7 | 6092 *strlen()* |
6093 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 6094 {expr} in bytes. |
55 | 6095 If the argument is a Number it is first converted to a String. |
6096 For other types an error is given. | |
6870 | 6097 If you want to count the number of multi-byte characters use |
6098 |strchars()|. | |
6099 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
7 | 6100 |
6101 strpart({src}, {start}[, {len}]) *strpart()* | |
6102 The result is a String, which is part of {src}, starting from | |
574 | 6103 byte {start}, with the byte length {len}. |
7 | 6104 When non-existing bytes are included, this doesn't result in |
6105 an error, the bytes are simply omitted. | |
6106 If {len} is missing, the copy continues from {start} till the | |
6107 end of the {src}. > | |
6108 strpart("abcdefg", 3, 2) == "de" | |
6109 strpart("abcdefg", -2, 4) == "ab" | |
6110 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 6111 strpart("abcdefg", 3) == "defg" |
7 | 6112 < Note: To get the first character, {start} must be 0. For |
6113 example, to get three bytes under and after the cursor: > | |
823 | 6114 strpart(getline("."), col(".") - 1, 3) |
7 | 6115 < |
140 | 6116 strridx({haystack}, {needle} [, {start}]) *strridx()* |
6117 The result is a Number, which gives the byte index in | |
6118 {haystack} of the last occurrence of the String {needle}. | |
6119 When {start} is specified, matches beyond this index are | |
6120 ignored. This can be used to find a match before a previous | |
6121 match: > | |
6122 :let lastcomma = strridx(line, ",") | |
6123 :let comma2 = strridx(line, ",", lastcomma - 1) | |
6124 < The search is done case-sensitive. | |
133 | 6125 For pattern searches use |match()|. |
6126 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 6127 If the {needle} is empty the length of {haystack} is returned. |
236 | 6128 See also |stridx()|. Examples: > |
7 | 6129 :echo strridx("an angry armadillo", "an") 3 |
856 | 6130 < *strrchr()* |
170 | 6131 When used with a single character it works similar to the C |
6132 function strrchr(). | |
6133 | |
7 | 6134 strtrans({expr}) *strtrans()* |
6135 The result is a String, which is {expr} with all unprintable | |
6136 characters translated into printable characters |'isprint'|. | |
6137 Like they are shown in a window. Example: > | |
6138 echo strtrans(@a) | |
6139 < This displays a newline in register a as "^@" instead of | |
6140 starting a new line. | |
6141 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6142 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6143 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
|
6144 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6145 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6146 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6147 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6148 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6149 |
5794 | 6150 submatch({nr}[, {list}]) *submatch()* |
2908 | 6151 Only for an expression in a |:substitute| command or |
6152 substitute() function. | |
6153 Returns the {nr}'th submatch of the matched text. When {nr} | |
6154 is 0 the whole matched text is returned. | |
5794 | 6155 Note that a NL in the string can stand for a line break of a |
6156 multi-line match or a NUL character in the text. | |
2908 | 6157 Also see |sub-replace-expression|. |
5794 | 6158 |
6159 If {list} is present and non-zero then submatch() returns | |
6160 a list of strings, similar to |getline()| with two arguments. | |
6161 NL characters in the text represent NUL characters in the | |
6162 text. | |
6163 Only returns more than one item for |:substitute|, inside | |
6164 |substitute()| this list will always contain one or zero | |
6165 items, since there are no real line breaks. | |
6166 | |
7 | 6167 Example: > |
6168 :s/\d\+/\=submatch(0) + 1/ | |
6169 < This finds the first number in the line and adds one to it. | |
6170 A line break is included as a newline character. | |
6171 | |
6172 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
6173 The result is a String, which is a copy of {expr}, in which | |
2908 | 6174 the first match of {pat} is replaced with {sub}. |
6175 When {flags} is "g", all matches of {pat} in {expr} are | |
6176 replaced. Otherwise {flags} should be "". | |
6177 | |
6178 This works like the ":substitute" command (without any flags). | |
6179 But the matching with {pat} is always done like the 'magic' | |
6180 option is set and 'cpoptions' is empty (to make scripts | |
3967 | 6181 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
6182 if you want to ignore or match case and ignore 'ignorecase'. | |
6183 'smartcase' is not used. See |string-match| for how {pat} is | |
6184 used. | |
2908 | 6185 |
6186 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 6187 Note that some codes in {sub} have a special meaning |
1621 | 6188 |sub-replace-special|. For example, to replace something with |
7 | 6189 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 6190 |
7 | 6191 When {pat} does not match in {expr}, {expr} is returned |
6192 unmodified. | |
2908 | 6193 |
7 | 6194 Example: > |
6195 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
6196 < This removes the last component of the 'path' option. > | |
6197 :echo substitute("testing", ".*", "\\U\\0", "") | |
6198 < results in "TESTING". | |
2908 | 6199 |
6200 When {sub} starts with "\=", the remainder is interpreted as | |
6201 an expression. See |sub-replace-expression|. Example: > | |
2833 | 6202 :echo substitute(s, '%\(\x\x\)', |
6203 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 6204 |
32 | 6205 synID({lnum}, {col}, {trans}) *synID()* |
7 | 6206 The result is a Number, which is the syntax ID at the position |
32 | 6207 {lnum} and {col} in the current window. |
7 | 6208 The syntax ID can be used with |synIDattr()| and |
6209 |synIDtrans()| to obtain syntax information about text. | |
419 | 6210 |
32 | 6211 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 6212 line. 'synmaxcol' applies, in a longer line zero is returned. |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6213 Note that when the position is after the last character, |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6214 that's where the cursor can be in Insert mode, synID() returns |
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6215 zero. |
419 | 6216 |
7 | 6217 When {trans} is non-zero, transparent items are reduced to the |
1621 | 6218 item that they reveal. This is useful when wanting to know |
7 | 6219 the effective color. When {trans} is zero, the transparent |
6220 item is returned. This is useful when wanting to know which | |
6221 syntax item is effective (e.g. inside parens). | |
6222 Warning: This function can be very slow. Best speed is | |
6223 obtained by going through the file in forward direction. | |
6224 | |
6225 Example (echoes the name of the syntax item under the cursor): > | |
6226 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
6227 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6228 |
7 | 6229 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
6230 The result is a String, which is the {what} attribute of | |
6231 syntax ID {synID}. This can be used to obtain information | |
6232 about a syntax item. | |
6233 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 6234 for that mode. When {mode} is omitted, or an invalid value is |
7 | 6235 used, the attributes for the currently active highlighting are |
6236 used (GUI, cterm or term). | |
6237 Use synIDtrans() to follow linked highlight groups. | |
6238 {what} result | |
6239 "name" the name of the syntax item | |
6240 "fg" foreground color (GUI: color name used to set | |
6241 the color, cterm: color number as a string, | |
6242 term: empty string) | |
1755 | 6243 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6244 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6245 |highlight-font| |
1755 | 6246 "sp" special color (as with "fg") |highlight-guisp| |
7 | 6247 "fg#" like "fg", but for the GUI and the GUI is |
6248 running the name in "#RRGGBB" form | |
6249 "bg#" like "fg#" for "bg" | |
1755 | 6250 "sp#" like "fg#" for "sp" |
7 | 6251 "bold" "1" if bold |
6252 "italic" "1" if italic | |
6253 "reverse" "1" if reverse | |
6254 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6255 "standout" "1" if standout |
7 | 6256 "underline" "1" if underlined |
205 | 6257 "undercurl" "1" if undercurled |
7 | 6258 |
6259 Example (echoes the color of the syntax item under the | |
6260 cursor): > | |
6261 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
6262 < | |
6263 synIDtrans({synID}) *synIDtrans()* | |
6264 The result is a Number, which is the translated syntax ID of | |
6265 {synID}. This is the syntax group ID of what is being used to | |
6266 highlight the character. Highlight links given with | |
6267 ":highlight link" are followed. | |
6268 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6269 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6270 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
|
6271 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
|
6272 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
|
6273 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
|
6274 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
|
6275 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6276 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
|
6277 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6278 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
|
6279 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6280 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6281 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6282 |
1500 | 6283 synstack({lnum}, {col}) *synstack()* |
6284 Return a |List|, which is the stack of syntax items at the | |
6285 position {lnum} and {col} in the current window. Each item in | |
6286 the List is an ID like what |synID()| returns. | |
6287 The first item in the List is the outer region, following are | |
6288 items contained in that one. The last one is what |synID()| | |
6289 returns, unless not the whole item is highlighted or it is a | |
6290 transparent item. | |
6291 This function is useful for debugging a syntax file. | |
6292 Example that shows the syntax stack under the cursor: > | |
6293 for id in synstack(line("."), col(".")) | |
6294 echo synIDattr(id, "name") | |
6295 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6296 < 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
|
6297 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6298 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
|
6299 valid positions. |
1500 | 6300 |
24 | 6301 system({expr} [, {input}]) *system()* *E677* |
5808 | 6302 Get the output of the shell command {expr} as a string. See |
6303 |systemlist()| to get the output as a List. | |
5806 | 6304 |
6305 When {input} is given and is a string this string is written | |
6306 to a file and passed as stdin to the command. The string is | |
6307 written as-is, you need to take care of using the correct line | |
6308 separators yourself. | |
6309 If {input} is given and is a |List| it is written to the file | |
6310 in a way |writefile()| does with {binary} set to "b" (i.e. | |
6311 with a newline between each list item with newlines inside | |
6312 list items converted to NULs). | |
6313 Pipes are not used. | |
6314 | |
6183 | 6315 When prepended by |:silent| the shell will not be set to |
6316 cooked mode. This is meant to be used for commands that do | |
6317 not need the user to type. It avoids stray characters showing | |
6318 up on the screen which require |CTRL-L| to remove. > | |
6319 :silent let f = system('ls *.vim') | |
6320 < | |
5690 | 6321 Note: Use |shellescape()| or |::S| with |expand()| or |
6322 |fnamemodify()| to escape special characters in a command | |
6323 argument. Newlines in {expr} may cause the command to fail. | |
6324 The characters in 'shellquote' and 'shellxquote' may also | |
6325 cause trouble. | |
7 | 6326 This is not to be used for interactive commands. |
1661 | 6327 |
7 | 6328 The result is a String. Example: > |
1661 | 6329 :let files = system("ls " . shellescape(expand('%:h'))) |
5690 | 6330 :let files = system('ls ' . expand('%:h:S')) |
7 | 6331 |
6332 < To make the result more system-independent, the shell output | |
6333 is filtered to replace <CR> with <NL> for Macintosh, and | |
6334 <CR><NL> with <NL> for DOS-like systems. | |
5277 | 6335 To avoid the string being truncated at a NUL, all NUL |
6336 characters are replaced with SOH (0x01). | |
6337 | |
7 | 6338 The command executed is constructed using several options: |
6339 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
6340 ({tmp} is an automatically generated file name). | |
6341 For Unix and OS/2 braces are put around {expr} to allow for | |
6342 concatenated commands. | |
6343 | |
794 | 6344 The command will be executed in "cooked" mode, so that a |
6345 CTRL-C will interrupt the command (on Unix at least). | |
6346 | |
7 | 6347 The resulting error code can be found in |v:shell_error|. |
6348 This function will fail in |restricted-mode|. | |
625 | 6349 |
6350 Note that any wrong value in the options mentioned above may | |
6351 make the function fail. It has also been reported to fail | |
6352 when using a security agent application. | |
7 | 6353 Unlike ":!cmd" there is no automatic check for changed files. |
6354 Use |:checktime| to force a check. | |
6355 | |
205 | 6356 |
5808 | 6357 systemlist({expr} [, {input}]) *systemlist()* |
6358 Same as |system()|, but returns a |List| with lines (parts of | |
6359 output separated by NL) with NULs transformed into NLs. Output | |
6360 is the same as |readfile()| will output with {binary} argument | |
6361 set to "b". | |
6362 | |
6363 Returns an empty string on error, so be careful not to run | |
6364 into |E706|. | |
6365 | |
6366 | |
677 | 6367 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 6368 The result is a |List|, where each item is the number of the |
677 | 6369 buffer associated with each window in the current tab page. |
6370 {arg} specifies the number of tab page to be used. When | |
6371 omitted the current tab page is used. | |
6372 When {arg} is invalid the number zero is returned. | |
6373 To get a list of all buffers in all tabs use this: > | |
3445 | 6374 let buflist = [] |
677 | 6375 for i in range(tabpagenr('$')) |
3445 | 6376 call extend(buflist, tabpagebuflist(i + 1)) |
677 | 6377 endfor |
6378 < Note that a buffer may appear in more than one window. | |
6379 | |
6380 | |
6381 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 6382 The result is a Number, which is the number of the current |
6383 tab page. The first tab page has number 1. | |
6384 When the optional argument is "$", the number of the last tab | |
6385 page is returned (the tab page count). | |
6386 The number can be used with the |:tab| command. | |
6387 | |
6388 | |
5763 | 6389 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6390 Like |winnr()| but for tab page {tabarg}. |
677 | 6391 {tabarg} specifies the number of tab page to be used. |
6392 {arg} is used like with |winnr()|: | |
6393 - When omitted the current window number is returned. This is | |
6394 the window which will be used when going to this tab page. | |
6395 - When "$" the number of windows is returned. | |
6396 - When "#" the previous window nr is returned. | |
6397 Useful examples: > | |
6398 tabpagewinnr(1) " current window of tab page 1 | |
6399 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
6400 < When {tabarg} is invalid zero is returned. | |
6401 | |
805 | 6402 *tagfiles()* |
6403 tagfiles() Returns a |List| with the file names used to search for tags | |
6404 for the current buffer. This is the 'tags' option expanded. | |
6405 | |
6406 | |
205 | 6407 taglist({expr}) *taglist()* |
6408 Returns a list of tags matching the regular expression {expr}. | |
438 | 6409 Each list item is a dictionary with at least the following |
6410 entries: | |
648 | 6411 name Name of the tag. |
6412 filename Name of the file where the tag is | |
1156 | 6413 defined. It is either relative to the |
6414 current directory or a full path. | |
205 | 6415 cmd Ex command used to locate the tag in |
6416 the file. | |
648 | 6417 kind Type of the tag. The value for this |
205 | 6418 entry depends on the language specific |
1156 | 6419 kind values. Only available when |
6420 using a tags file generated by | |
6421 Exuberant ctags or hdrtag. | |
648 | 6422 static A file specific tag. Refer to |
205 | 6423 |static-tag| for more information. |
1156 | 6424 More entries may be present, depending on the content of the |
6425 tags file: access, implementation, inherits and signature. | |
6426 Refer to the ctags documentation for information about these | |
6427 fields. For C code the fields "struct", "class" and "enum" | |
6428 may appear, they give the name of the entity the tag is | |
6429 contained in. | |
452 | 6430 |
216 | 6431 The ex-command 'cmd' can be either an ex search pattern, a |
6432 line number or a line number followed by a byte number. | |
205 | 6433 |
6434 If there are no matching tags, then an empty list is returned. | |
6435 | |
6436 To get an exact tag match, the anchors '^' and '$' should be | |
4073 | 6437 used in {expr}. This also make the function work faster. |
6438 Refer to |tag-regexp| for more information about the tag | |
6439 search regular expression pattern. | |
205 | 6440 |
6441 Refer to |'tags'| for information about how the tags file is | |
6442 located by Vim. Refer to |tags-file-format| for the format of | |
6443 the tags file generated by the different ctags tools. | |
6444 | |
7 | 6445 tempname() *tempname()* *temp-file-name* |
6446 The result is a String, which is the name of a file that | |
1621 | 6447 doesn't exist. It can be used for a temporary file. The name |
7 | 6448 is different for at least 26 consecutive calls. Example: > |
6449 :let tmpfile = tempname() | |
6450 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6451 < For Unix, the file will be in a private directory |tempfile|. |
7 | 6452 For MS-Windows forward slashes are used when the 'shellslash' |
6453 option is set or when 'shellcmdflag' starts with '-'. | |
6454 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6455 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6456 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6457 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
|
6458 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6459 {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
|
6460 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6461 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6462 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6463 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6464 < -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
|
6465 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6466 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6467 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6468 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6469 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
|
6470 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6471 {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
|
6472 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6473 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6474 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6475 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6476 < -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
|
6477 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6478 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6479 |
7 | 6480 tolower({expr}) *tolower()* |
6481 The result is a copy of the String given, with all uppercase | |
6482 characters turned into lowercase (just like applying |gu| to | |
6483 the string). | |
6484 | |
6485 toupper({expr}) *toupper()* | |
6486 The result is a copy of the String given, with all lowercase | |
6487 characters turned into uppercase (just like applying |gU| to | |
6488 the string). | |
6489 | |
15 | 6490 tr({src}, {fromstr}, {tostr}) *tr()* |
6491 The result is a copy of the {src} string with all characters | |
6492 which appear in {fromstr} replaced by the character in that | |
6493 position in the {tostr} string. Thus the first character in | |
6494 {fromstr} is translated into the first character in {tostr} | |
6495 and so on. Exactly like the unix "tr" command. | |
6496 This code also deals with multibyte characters properly. | |
6497 | |
6498 Examples: > | |
6499 echo tr("hello there", "ht", "HT") | |
6500 < returns "Hello THere" > | |
6501 echo tr("<blob>", "<>", "{}") | |
6502 < returns "{blob}" | |
6503 | |
1621 | 6504 trunc({expr}) *trunc()* |
1668 | 6505 Return the largest integral value with magnitude less than or |
1621 | 6506 equal to {expr} as a |Float| (truncate towards zero). |
6507 {expr} must evaluate to a |Float| or a |Number|. | |
6508 Examples: > | |
6509 echo trunc(1.456) | |
6510 < 1.0 > | |
6511 echo trunc(-5.456) | |
6512 < -5.0 > | |
6513 echo trunc(4.0) | |
6514 < 4.0 | |
6515 {only available when compiled with the |+float| feature} | |
6516 | |
87 | 6517 *type()* |
6518 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 6519 Number: 0 |
6520 String: 1 | |
6521 Funcref: 2 | |
6522 List: 3 | |
6523 Dictionary: 4 | |
1621 | 6524 Float: 5 |
153 | 6525 To avoid the magic numbers it should be used this way: > |
87 | 6526 :if type(myvar) == type(0) |
6527 :if type(myvar) == type("") | |
6528 :if type(myvar) == type(function("tr")) | |
6529 :if type(myvar) == type([]) | |
153 | 6530 :if type(myvar) == type({}) |
1621 | 6531 :if type(myvar) == type(0.0) |
7 | 6532 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6533 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6534 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
|
6535 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
|
6536 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
|
6537 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6538 {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
|
6539 is used internally. |
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6540 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
|
6541 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
|
6542 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6543 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
|
6544 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6545 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6546 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6547 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
|
6548 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6549 "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
|
6550 "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
|
6551 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
|
6552 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
|
6553 "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
|
6554 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
|
6555 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6556 "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
|
6557 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6558 "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
|
6559 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6560 "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
|
6561 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
|
6562 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6563 "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
|
6564 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6565 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6566 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
|
6567 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
|
6568 "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
|
6569 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6570 "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
|
6571 |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
|
6572 "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
|
6573 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
|
6574 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
|
6575 "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
|
6576 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
|
6577 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
|
6578 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
|
6579 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
|
6580 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6581 "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
|
6582 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
|
6583 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
|
6584 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6585 "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
|
6586 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
|
6587 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6588 |
5747 | 6589 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
6590 Remove second and succeeding copies of repeated adjacent | |
6591 {list} items in-place. Returns {list}. If you want a list | |
6592 to remain unmodified make a copy first: > | |
6593 :let newlist = uniq(copy(mylist)) | |
6594 < The default compare function uses the string representation of | |
6595 each item. For the use of {func} and {dict} see |sort()|. | |
6596 | |
140 | 6597 values({dict}) *values()* |
1621 | 6598 Return a |List| with all the values of {dict}. The |List| is |
685 | 6599 in arbitrary order. |
140 | 6600 |
6601 | |
7 | 6602 virtcol({expr}) *virtcol()* |
6603 The result is a Number, which is the screen column of the file | |
6604 position given with {expr}. That is, the last screen position | |
6605 occupied by the character at that position, when the screen | |
6606 would be of unlimited width. When there is a <Tab> at the | |
6607 position, the returned Number will be the column at the end of | |
6608 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
3445 | 6609 set to 8, it returns 8. |conceal| is ignored. |
1317 | 6610 For the byte position use |col()|. |
6611 For the use of {expr} see |col()|. | |
6612 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 6613 "off" is the offset in screen columns from the start of the |
1266 | 6614 character. E.g., a position within a <Tab> or after the last |
2965 | 6615 character. When "off" is omitted zero is used. |
7 | 6616 When Virtual editing is active in the current mode, a position |
6617 beyond the end of the line can be returned. |'virtualedit'| | |
6618 The accepted positions are: | |
6619 . the cursor position | |
6620 $ the end of the cursor line (the result is the | |
6621 number of displayed characters in the cursor line | |
6622 plus one) | |
6623 'x position of mark x (if the mark is not set, 0 is | |
6624 returned) | |
6447 | 6625 v In Visual mode: the start of the Visual area (the |
6626 cursor is the end). When not in Visual mode | |
6627 returns the cursor position. Differs from |'<| in | |
6628 that it's updated right away. | |
7 | 6629 Note that only marks in the current file can be used. |
6630 Examples: > | |
6631 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
6632 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 6633 virtcol("'t") with text " there", with 't at 'h', returns 6 |
6634 < The first column is 1. 0 is returned for an error. | |
1156 | 6635 A more advanced example that echoes the maximum length of |
6636 all lines: > | |
6637 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
6638 | |
7 | 6639 |
6640 visualmode([expr]) *visualmode()* | |
6641 The result is a String, which describes the last Visual mode | |
856 | 6642 used in the current buffer. Initially it returns an empty |
6643 string, but once Visual mode has been used, it returns "v", | |
6644 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
6645 character-wise, line-wise, or block-wise Visual mode | |
6646 respectively. | |
7 | 6647 Example: > |
6648 :exe "normal " . visualmode() | |
6649 < This enters the same Visual mode as before. It is also useful | |
6650 in scripts if you wish to act differently depending on the | |
6651 Visual mode that was used. | |
1621 | 6652 If Visual mode is active, use |mode()| to get the Visual mode |
6653 (e.g., in a |:vmap|). | |
1661 | 6654 *non-zero-arg* |
6655 If [expr] is supplied and it evaluates to a non-zero Number or | |
6656 a non-empty String, then the Visual mode will be cleared and | |
1621 | 6657 the old value is returned. Note that " " and "0" are also |
1661 | 6658 non-empty strings, thus cause the mode to be cleared. A List, |
6659 Dictionary or Float is not a Number or String, thus does not | |
6660 cause the mode to be cleared. | |
7 | 6661 |
4151 | 6662 wildmenumode() *wildmenumode()* |
6663 Returns non-zero when the wildmenu is active and zero | |
6664 otherwise. See 'wildmenu' and 'wildmode'. | |
6665 This can be used in mappings to handle the 'wildcharm' option | |
6666 gracefully. (Makes only sense with |mapmode-c| mappings). | |
6667 | |
6668 For example to make <c-j> work like <down> in wildmode, use: > | |
6669 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
6670 < | |
6671 (Note, this needs the 'wildcharm' option set appropriately). | |
6672 | |
6673 | |
7 | 6674 *winbufnr()* |
6675 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 6676 associated with window {nr}. When {nr} is zero, the number of |
7 | 6677 the buffer in the current window is returned. When window |
6678 {nr} doesn't exist, -1 is returned. | |
6679 Example: > | |
6680 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
6681 < | |
6682 *wincol()* | |
6683 wincol() The result is a Number, which is the virtual column of the | |
6684 cursor in the window. This is counting screen cells from the | |
6685 left side of the window. The leftmost column is one. | |
6686 | |
6687 winheight({nr}) *winheight()* | |
6688 The result is a Number, which is the height of window {nr}. | |
6689 When {nr} is zero, the height of the current window is | |
6690 returned. When window {nr} doesn't exist, -1 is returned. | |
6691 An existing window always has a height of zero or more. | |
6692 Examples: > | |
6693 :echo "The current window has " . winheight(0) . " lines." | |
6694 < | |
6695 *winline()* | |
6696 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 6697 in the window. This is counting screen lines from the top of |
7 | 6698 the window. The first line is one. |
531 | 6699 If the cursor was moved the view on the file will be updated |
6700 first, this may cause a scroll. | |
7 | 6701 |
6702 *winnr()* | |
20 | 6703 winnr([{arg}]) The result is a Number, which is the number of the current |
6704 window. The top window has number 1. | |
6705 When the optional argument is "$", the number of the | |
3967 | 6706 last window is returned (the window count). > |
6707 let window_count = winnr('$') | |
6708 < When the optional argument is "#", the number of the last | |
20 | 6709 accessed window is returned (where |CTRL-W_p| goes to). |
1156 | 6710 If there is no previous window or it is in another tab page 0 |
6711 is returned. | |
20 | 6712 The number can be used with |CTRL-W_w| and ":wincmd w" |
6713 |:wincmd|. | |
1156 | 6714 Also see |tabpagewinnr()|. |
7 | 6715 |
6716 *winrestcmd()* | |
6717 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
6718 the current window sizes. Only works properly when no windows | |
712 | 6719 are opened or closed and the current window and tab page is |
6720 unchanged. | |
7 | 6721 Example: > |
6722 :let cmd = winrestcmd() | |
6723 :call MessWithWindowSizes() | |
6724 :exe cmd | |
712 | 6725 < |
6726 *winrestview()* | |
6727 winrestview({dict}) | |
6728 Uses the |Dictionary| returned by |winsaveview()| to restore | |
6729 the view of the current window. | |
5940 | 6730 Note: The {dict} does not have to contain all values, that are |
6731 returned by |winsaveview()|. If values are missing, those | |
6732 settings won't be restored. So you can use: > | |
6733 :call winrestview({'curswant': 4}) | |
6734 < | |
6735 This will only set the curswant value (the column the cursor | |
6736 wants to move on vertical movements) of the cursor to column 5 | |
6737 (yes, that is 5), while all other settings will remain the | |
6738 same. This is useful, if you set the cursor position manually. | |
6739 | |
712 | 6740 If you have changed the values the result is unpredictable. |
6741 If the window size changed the result won't be the same. | |
6742 | |
6743 *winsaveview()* | |
6744 winsaveview() Returns a |Dictionary| that contains information to restore | |
6745 the view of the current window. Use |winrestview()| to | |
6746 restore the view. | |
6747 This is useful if you have a mapping that jumps around in the | |
6748 buffer and you want to go back to the original view. | |
6749 This does not save fold information. Use the 'foldenable' | |
798 | 6750 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
|
6751 not opened when moving around. This may have side effects. |
712 | 6752 The return value includes: |
6753 lnum cursor line number | |
5940 | 6754 col cursor column (Note: the first column |
6755 zero, as opposed to what getpos() | |
6756 returns) | |
712 | 6757 coladd cursor column offset for 'virtualedit' |
6758 curswant column for vertical movement | |
6759 topline first line in the window | |
6760 topfill filler lines, only in diff mode | |
6761 leftcol first column displayed | |
6762 skipcol columns skipped | |
6763 Note that no option values are saved. | |
6764 | |
7 | 6765 |
6766 winwidth({nr}) *winwidth()* | |
6767 The result is a Number, which is the width of window {nr}. | |
6768 When {nr} is zero, the width of the current window is | |
6769 returned. When window {nr} doesn't exist, -1 is returned. | |
6770 An existing window always has a width of zero or more. | |
6771 Examples: > | |
6772 :echo "The current window has " . winwidth(0) . " columns." | |
6773 :if winwidth(0) <= 50 | |
6774 : exe "normal 50\<C-W>|" | |
6775 :endif | |
6776 < | |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6777 wordcount() *wordcount()* |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6778 The result is a dictionary of byte/chars/word statistics for |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6779 the current buffer. This is the same info as provided by |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6780 |g_CTRL-G| |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6781 The return value includes: |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6782 bytes Number of bytes in the buffer |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6783 chars Number of chars in the buffer |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6784 words Number of words in the buffer |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6785 cursor_bytes Number of bytes before cursor position |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6786 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6787 cursor_chars Number of chars before cursor position |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6788 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6789 cursor_words Number of words before cursor position |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6790 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6791 visual_bytes Number of bytes visually selected |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6792 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6793 visual_chars Number of chars visually selected |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6794 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6795 visual_words Number of chars visually selected |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6796 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6797 |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6798 |
158 | 6799 *writefile()* |
6341 | 6800 writefile({list}, {fname} [, {flags}]) |
685 | 6801 Write |List| {list} to file {fname}. Each list item is |
158 | 6802 separated with a NL. Each list item must be a String or |
6803 Number. | |
6341 | 6804 When {flags} contains "b" then binary mode is used: There will |
158 | 6805 not be a NL after the last list item. An empty item at the |
6806 end does cause the last line in the file to end in a NL. | |
6341 | 6807 |
6808 When {flags} contains "a" then append mode is used, lines are | |
6809 append to the file: > | |
6810 :call writefile(["foo"], "event.log", "a") | |
6811 :call writefile(["bar"], "event.log", "a") | |
6812 > | |
6813 < All NL characters are replaced with a NUL character. | |
158 | 6814 Inserting CR characters needs to be done before passing {list} |
6815 to writefile(). | |
6816 An existing file is overwritten, if possible. | |
6817 When the write fails -1 is returned, otherwise 0. There is an | |
6818 error message if the file can't be created or when writing | |
6819 fails. | |
6820 Also see |readfile()|. | |
6821 To copy a file byte for byte: > | |
6822 :let fl = readfile("foo", "b") | |
6823 :call writefile(fl, "foocopy", "b") | |
3214 | 6824 |
6825 | |
6826 xor({expr}, {expr}) *xor()* | |
6827 Bitwise XOR on the two arguments. The arguments are converted | |
6828 to a number. A List, Dict or Float argument causes an error. | |
6829 Example: > | |
6830 :let bits = xor(bits, 0x80) | |
3256 | 6831 < |
3214 | 6832 |
7 | 6833 |
6834 *feature-list* | |
6009 | 6835 There are four types of features: |
7 | 6836 1. Features that are only supported when they have been enabled when Vim |
6837 was compiled |+feature-list|. Example: > | |
6838 :if has("cindent") | |
6839 2. Features that are only supported when certain conditions have been met. | |
6840 Example: > | |
6841 :if has("gui_running") | |
6842 < *has-patch* | |
5814 | 6843 3. Included patches. The "patch123" feature means that patch 123 has been |
6844 included. Note that this form does not check the version of Vim, you need | |
6845 to inspect |v:version| for that. | |
6846 Example (checking version 6.2.148 or later): > | |
7 | 6847 :if v:version > 602 || v:version == 602 && has("patch148") |
5814 | 6848 < Note that it's possible for patch 147 to be omitted even though 148 is |
6849 included. | |
6850 | |
6851 4. Beyond a certain version or at a certain version and including a specific | |
5862 | 6852 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
6853 later, or it is version 7.4 and patch 237 was included. | |
6854 Note that this only works for patch 7.4.237 and later, before that you | |
6855 need to use the example above that checks v:version. Example: > | |
6856 :if has("patch-7.4.248") | |
5814 | 6857 < Note that it's possible for patch 147 to be omitted even though 148 is |
1156 | 6858 included. |
7 | 6859 |
5340 | 6860 acl Compiled with |ACL| support. |
7 | 6861 all_builtin_terms Compiled with all builtin terminals enabled. |
6862 amiga Amiga version of Vim. | |
6863 arabic Compiled with Arabic support |Arabic|. | |
6864 arp Compiled with ARP support (Amiga). | |
613 | 6865 autocmd Compiled with autocommand support. |autocommand| |
7 | 6866 balloon_eval Compiled with |balloon-eval| support. |
435 | 6867 balloon_multiline GUI supports multiline balloons. |
7 | 6868 beos BeOS version of Vim. |
6869 browse Compiled with |:browse| support, and browse() will | |
6870 work. | |
3682 | 6871 browsefilter Compiled with support for |browsefilter|. |
7 | 6872 builtin_terms Compiled with some builtin terminals. |
6873 byte_offset Compiled with support for 'o' in 'statusline' | |
6874 cindent Compiled with 'cindent' support. | |
6875 clientserver Compiled with remote invocation support |clientserver|. | |
6876 clipboard Compiled with 'clipboard' support. | |
6877 cmdline_compl Compiled with |cmdline-completion| support. | |
6878 cmdline_hist Compiled with |cmdline-history| support. | |
6879 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
6880 comments Compiled with |'comments'| support. | |
2681 | 6881 compatible Compiled to be very Vi compatible. |
7 | 6882 cryptv Compiled with encryption support |encryption|. |
6883 cscope Compiled with |cscope| support. | |
6884 debug Compiled with "DEBUG" defined. | |
6885 dialog_con Compiled with console dialog support. | |
6886 dialog_gui Compiled with GUI dialog support. | |
6887 diff Compiled with |vimdiff| and 'diff' support. | |
6888 digraphs Compiled with support for digraphs. | |
6110 | 6889 directx Compiled with support for Direct-X and 'renderoptions'. |
7 | 6890 dnd Compiled with support for the "~ register |quote_~|. |
2681 | 6891 dos16 16 bits DOS version of Vim. |
7 | 6892 dos32 32 bits DOS (DJGPP) version of Vim. |
6893 ebcdic Compiled on a machine with ebcdic character set. | |
6894 emacs_tags Compiled with support for Emacs tags. | |
6895 eval Compiled with expression evaluation support. Always | |
6896 true, of course! | |
6897 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
6898 extra_search Compiled with support for |'incsearch'| and | |
6899 |'hlsearch'| | |
6900 farsi Compiled with Farsi support |farsi|. | |
6901 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 6902 filterpipe When 'shelltemp' is off pipes are used for shell |
6903 read/write/filter commands | |
7 | 6904 find_in_path Compiled with support for include file searches |
6905 |+find_in_path|. | |
1621 | 6906 float Compiled with support for |Float|. |
7 | 6907 fname_case Case in file names matters (for Amiga, MS-DOS, and |
6908 Windows this is not present). | |
6909 folding Compiled with |folding| support. | |
6910 footer Compiled with GUI footer support. |gui-footer| | |
6911 fork Compiled to use fork()/exec() instead of system(). | |
6912 gettext Compiled with message translation |multi-lang| | |
6913 gui Compiled with GUI enabled. | |
6914 gui_athena Compiled with Athena GUI. | |
2681 | 6915 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 6916 gui_gtk Compiled with GTK+ GUI (any version). |
6917 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
6918 gui_mac Compiled with Macintosh GUI. | |
6919 gui_motif Compiled with Motif GUI. | |
6920 gui_photon Compiled with Photon GUI. | |
2681 | 6921 gui_running Vim is running in the GUI, or it will start soon. |
7 | 6922 gui_win32 Compiled with MS Windows Win32 GUI. |
6923 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
6924 hangul_input Compiled with Hangul input support. |hangul| | |
6925 iconv Can use iconv() for conversion. | |
6926 insert_expand Compiled with support for CTRL-X expansion commands in | |
6927 Insert mode. | |
6928 jumplist Compiled with |jumplist| support. | |
6929 keymap Compiled with 'keymap' support. | |
6930 langmap Compiled with 'langmap' support. | |
6931 libcall Compiled with |libcall()| support. | |
5995 | 6932 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
6933 'breakindent' support. | |
7 | 6934 lispindent Compiled with support for lisp indenting. |
6935 listcmds Compiled with commands for the buffer list |:files| | |
6936 and the argument list |arglist|. | |
6937 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
|
6938 lua Compiled with Lua interface |Lua|. |
7 | 6939 mac Macintosh version of Vim. |
6940 macunix Macintosh version of Vim, using Unix files (OS-X). | |
6941 menu Compiled with support for |:menu|. | |
6942 mksession Compiled with support for |:mksession|. | |
6943 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
6944 mouse Compiled with support mouse. | |
6945 mouse_dec Compiled with support for Dec terminal mouse. | |
6946 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
6947 mouse_netterm Compiled with support for netterm mouse. | |
6948 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 6949 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3750 | 6950 mouse_sgr Compiled with support for sgr mouse. |
3224 | 6951 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 6952 mouse_xterm Compiled with support for xterm mouse. |
2681 | 6953 mouseshape Compiled with support for 'mouseshape'. |
1768 | 6954 multi_byte Compiled with support for 'encoding' |
6955 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 6956 multi_byte_ime Compiled with support for IME input method. |
6957 multi_lang Compiled with support for multiple languages. | |
14 | 6958 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 6959 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 6960 netbeans_intg Compiled with support for |netbeans|. |
6961 ole Compiled with OLE automation support for Win32. | |
6962 os2 OS/2 version of Vim. | |
6963 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
6964 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
|
6965 persistent_undo Compiled with support for persistent undo history. |
7 | 6966 postscript Compiled with PostScript file printing. |
6967 printer Compiled with |:hardcopy| support. | |
170 | 6968 profile Compiled with |:profile| support. |
2826 | 6969 python Compiled with Python 2.x interface. |has-python| |
6970 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 6971 qnx QNX version of Vim. |
6972 quickfix Compiled with |quickfix| support. | |
857 | 6973 reltime Compiled with |reltime()| support. |
7 | 6974 rightleft Compiled with 'rightleft' support. |
6975 ruby Compiled with Ruby interface |ruby|. | |
6976 scrollbind Compiled with 'scrollbind' support. | |
6977 showcmd Compiled with 'showcmd' support. | |
6978 signs Compiled with |:sign| support. | |
6979 smartindent Compiled with 'smartindent' support. | |
9 | 6980 sniff Compiled with SNiFF interface support. |
2681 | 6981 spell Compiled with spell checking support |spell|. |
1989 | 6982 startuptime Compiled with |--startuptime| support. |
7 | 6983 statusline Compiled with support for 'statusline', 'rulerformat' |
6984 and special formats of 'titlestring' and 'iconstring'. | |
6985 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 6986 syntax Compiled with syntax highlighting support |syntax|. |
7 | 6987 syntax_items There are active syntax highlighting items for the |
6988 current buffer. | |
6989 system Compiled to use system() instead of fork()/exec(). | |
6990 tag_binary Compiled with binary searching in tags files | |
6991 |tag-binary-search|. | |
6992 tag_old_static Compiled with support for old static tags | |
6993 |tag-old-static|. | |
6994 tag_any_white Compiled with support for any white characters in tags | |
6995 files |tag-any-white|. | |
6996 tcl Compiled with Tcl interface. | |
6997 terminfo Compiled with terminfo instead of termcap. | |
6998 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
6999 textobjects Compiled with support for |text-objects|. | |
7000 tgetent Compiled with tgetent support, able to use a termcap | |
7001 or terminfo file. | |
7002 title Compiled with window title support |'title'|. | |
7003 toolbar Compiled with support for |gui-toolbar|. | |
7004 unix Unix version of Vim. | |
7005 user_commands User-defined commands. | |
2681 | 7006 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 7007 vim_starting True while initial source'ing takes place. |startup| |
2681 | 7008 viminfo Compiled with viminfo support. |
7 | 7009 virtualedit Compiled with 'virtualedit' option. |
7010 visual Compiled with Visual mode. | |
7011 visualextra Compiled with extra Visual mode commands. | |
7012 |blockwise-operators|. | |
7013 vms VMS version of Vim. | |
7014 vreplace Compiled with |gR| and |gr| commands. | |
7015 wildignore Compiled with 'wildignore' option. | |
7016 wildmenu Compiled with 'wildmenu' option. | |
7017 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
|
7018 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
|
7019 64 bits) |
2681 | 7020 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 7021 win64 Win64 version of Vim (MS-Windows 64 bit). |
7022 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 7023 winaltkeys Compiled with 'winaltkeys' option. |
7024 windows Compiled with support for more than one window. | |
7 | 7025 writebackup Compiled with 'writebackup' default on. |
7026 xfontset Compiled with X fontset support |xfontset|. | |
7027 xim Compiled with X input method support |xim|. | |
5340 | 7028 xpm Compiled with pixmap support. |
7029 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
7030 backward compatibility. Use "xpm" instead.) | |
7 | 7031 xsmp Compiled with X session management support. |
7032 xsmp_interact Compiled with interactive X session management support. | |
7033 xterm_clipboard Compiled with support for xterm clipboard. | |
7034 xterm_save Compiled with support for saving and restoring the | |
7035 xterm screen. | |
7036 x11 Compiled with X11 support. | |
7037 | |
7038 *string-match* | |
7039 Matching a pattern in a String | |
7040 | |
7041 A regexp pattern as explained at |pattern| is normally used to find a match in | |
7042 the buffer lines. When a pattern is used to find a match in a String, almost | |
7043 everything works in the same way. The difference is that a String is handled | |
7044 like it is one line. When it contains a "\n" character, this is not seen as a | |
7045 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
7046 with ".". Example: > | |
7047 :let a = "aaaa\nxxxx" | |
7048 :echo matchstr(a, "..\n..") | |
7049 aa | |
7050 xx | |
7051 :echo matchstr(a, "a.x") | |
7052 a | |
7053 x | |
7054 | |
7055 Don't forget that "^" will only match at the first character of the String and | |
7056 "$" at the last character of the string. They don't match after or before a | |
7057 "\n". | |
7058 | |
7059 ============================================================================== | |
7060 5. Defining functions *user-functions* | |
7061 | |
7062 New functions can be defined. These can be called just like builtin | |
7063 functions. The function executes a sequence of Ex commands. Normal mode | |
7064 commands can be executed with the |:normal| command. | |
7065 | |
7066 The function name must start with an uppercase letter, to avoid confusion with | |
7067 builtin functions. To prevent from using the same name in different scripts | |
7068 avoid obvious, short names. A good habit is to start the function name with | |
7069 the name of the script, e.g., "HTMLcolor()". | |
7070 | |
504 | 7071 It's also possible to use curly braces, see |curly-braces-names|. And the |
7072 |autoload| facility is useful to define a function only when it's called. | |
7 | 7073 |
7074 *local-function* | |
7075 A function local to a script must start with "s:". A local script function | |
7076 can only be called from within the script and from functions, user commands | |
7077 and autocommands defined in the script. It is also possible to call the | |
1698 | 7078 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 7079 instead of "s:" when the mapping is expanded outside of the script. |
5862 | 7080 There are only script-local functions, no buffer-local or window-local |
7081 functions. | |
7 | 7082 |
7083 *:fu* *:function* *E128* *E129* *E123* | |
7084 :fu[nction] List all functions and their arguments. | |
7085 | |
7086 :fu[nction] {name} List function {name}. | |
685 | 7087 {name} can also be a |Dictionary| entry that is a |
7088 |Funcref|: > | |
114 | 7089 :function dict.init |
504 | 7090 |
7091 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
7092 Example that lists all functions ending with "File": > | |
7093 :function /File$ | |
482 | 7094 < |
7095 *:function-verbose* | |
7096 When 'verbose' is non-zero, listing a function will also display where it was | |
7097 last defined. Example: > | |
7098 | |
7099 :verbose function SetFileTypeSH | |
7100 function SetFileTypeSH(name) | |
7101 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
7102 < | |
484 | 7103 See |:verbose-cmd| for more information. |
482 | 7104 |
5862 | 7105 *E124* *E125* *E853* *E884* |
102 | 7106 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 7107 Define a new function by the name {name}. The name |
7108 must be made of alphanumeric characters and '_', and | |
5862 | 7109 must start with a capital or "s:" (see above). Note |
7110 that using "b:" or "g:" is not allowed. (since patch | |
7111 7.4.260 E884 is given if the function name has a colon | |
7112 in the name, e.g. for "foo:bar()". Before that patch | |
7113 no error was given). | |
114 | 7114 |
685 | 7115 {name} can also be a |Dictionary| entry that is a |
7116 |Funcref|: > | |
114 | 7117 :function dict.init(arg) |
1621 | 7118 < "dict" must be an existing dictionary. The entry |
114 | 7119 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 7120 is required to overwrite an existing function. The |
114 | 7121 result is a |Funcref| to a numbered function. The |
7122 function can only be used with a |Funcref| and will be | |
7123 deleted if there are no more references to it. | |
7 | 7124 *E127* *E122* |
7125 When a function by this name already exists and [!] is | |
7126 not used an error message is given. When [!] is used, | |
7127 an existing function is silently replaced. Unless it | |
7128 is currently being executed, that is an error. | |
133 | 7129 |
7130 For the {arguments} see |function-argument|. | |
7131 | |
5618 | 7132 *:func-range* *a:firstline* *a:lastline* |
7 | 7133 When the [range] argument is added, the function is |
7134 expected to take care of a range itself. The range is | |
7135 passed as "a:firstline" and "a:lastline". If [range] | |
7136 is excluded, ":{range}call" will call the function for | |
7137 each line in the range, with the cursor on the start | |
7138 of each line. See |function-range-example|. | |
3967 | 7139 The cursor is still moved to the first line of the |
7140 range, as is the case with all Ex commands. | |
5618 | 7141 *:func-abort* |
7 | 7142 When the [abort] argument is added, the function will |
7143 abort as soon as an error is detected. | |
5618 | 7144 *:func-dict* |
102 | 7145 When the [dict] argument is added, the function must |
1621 | 7146 be invoked through an entry in a |Dictionary|. The |
102 | 7147 local variable "self" will then be set to the |
7148 dictionary. See |Dictionary-function|. | |
7 | 7149 |
1621 | 7150 *function-search-undo* |
653 | 7151 The last used search pattern and the redo command "." |
1621 | 7152 will not be changed by the function. This also |
7153 implies that the effect of |:nohlsearch| is undone | |
7154 when the function returns. | |
653 | 7155 |
7 | 7156 *:endf* *:endfunction* *E126* *E193* |
7157 :endf[unction] The end of a function definition. Must be on a line | |
7158 by its own, without other commands. | |
7159 | |
7160 *:delf* *:delfunction* *E130* *E131* | |
7161 :delf[unction] {name} Delete function {name}. | |
685 | 7162 {name} can also be a |Dictionary| entry that is a |
7163 |Funcref|: > | |
114 | 7164 :delfunc dict.init |
1621 | 7165 < This will remove the "init" entry from "dict". The |
114 | 7166 function is deleted if there are no more references to |
7167 it. | |
7 | 7168 *:retu* *:return* *E133* |
7169 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
7170 evaluated and returned as the result of the function. | |
7171 If "[expr]" is not given, the number 0 is returned. | |
7172 When a function ends without an explicit ":return", | |
7173 the number 0 is returned. | |
7174 Note that there is no check for unreachable lines, | |
7175 thus there is no warning if commands follow ":return". | |
7176 | |
7177 If the ":return" is used after a |:try| but before the | |
7178 matching |:finally| (if present), the commands | |
7179 following the ":finally" up to the matching |:endtry| | |
7180 are executed first. This process applies to all | |
7181 nested ":try"s inside the function. The function | |
7182 returns at the outermost ":endtry". | |
7183 | |
133 | 7184 *function-argument* *a:var* |
1621 | 7185 An argument can be defined by giving its name. In the function this can then |
133 | 7186 be used as "a:name" ("a:" for argument). |
1156 | 7187 *a:0* *a:1* *a:000* *E740* *...* |
133 | 7188 Up to 20 arguments can be given, separated by commas. After the named |
7189 arguments an argument "..." can be specified, which means that more arguments | |
7190 may optionally be following. In the function the extra arguments can be used | |
7191 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 7192 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
7193 that "a:1" is the same as "a:000[0]". | |
148 | 7194 *E742* |
7195 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 7196 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 7197 Thus you can pass a |List| to a function and have the function add an item to |
7198 it. If you want to make sure the function cannot change a |List| or | |
7199 |Dictionary| use |:lockvar|. | |
133 | 7200 |
7201 When not using "...", the number of arguments in a function call must be equal | |
7202 to the number of named arguments. When using "...", the number of arguments | |
7203 may be larger. | |
7204 | |
7205 It is also possible to define a function without any arguments. You must | |
7206 still supply the () then. The body of the function follows in the next lines, | |
7207 until the matching |:endfunction|. It is allowed to define another function | |
7208 inside a function body. | |
7209 | |
7210 *local-variables* | |
7 | 7211 Inside a function variables can be used. These are local variables, which |
7212 will disappear when the function returns. Global variables need to be | |
7213 accessed with "g:". | |
7214 | |
7215 Example: > | |
7216 :function Table(title, ...) | |
7217 : echohl Title | |
7218 : echo a:title | |
7219 : echohl None | |
140 | 7220 : echo a:0 . " items:" |
7221 : for s in a:000 | |
7222 : echon ' ' . s | |
7223 : endfor | |
7 | 7224 :endfunction |
7225 | |
7226 This function can then be called with: > | |
140 | 7227 call Table("Table", "line1", "line2") |
7228 call Table("Empty Table") | |
7 | 7229 |
1156 | 7230 To return more than one value, return a |List|: > |
7231 :function Compute(n1, n2) | |
7 | 7232 : if a:n2 == 0 |
1156 | 7233 : return ["fail", 0] |
7 | 7234 : endif |
1156 | 7235 : return ["ok", a:n1 / a:n2] |
7 | 7236 :endfunction |
7237 | |
7238 This function can then be called with: > | |
1156 | 7239 :let [success, div] = Compute(102, 6) |
7 | 7240 :if success == "ok" |
7241 : echo div | |
7242 :endif | |
1156 | 7243 < |
786 | 7244 *:cal* *:call* *E107* *E117* |
7 | 7245 :[range]cal[l] {name}([arguments]) |
7246 Call a function. The name of the function and its arguments | |
7247 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 7248 used. The returned value is discarded. |
7 | 7249 Without a range and for functions that accept a range, the |
7250 function is called once. When a range is given the cursor is | |
7251 positioned at the start of the first line before executing the | |
7252 function. | |
7253 When a range is given and the function doesn't handle it | |
7254 itself, the function is executed for each line in the range, | |
7255 with the cursor in the first column of that line. The cursor | |
7256 is left at the last line (possibly moved by the last function | |
1621 | 7257 call). The arguments are re-evaluated for each line. Thus |
7 | 7258 this works: |
7259 *function-range-example* > | |
7260 :function Mynumber(arg) | |
7261 : echo line(".") . " " . a:arg | |
7262 :endfunction | |
7263 :1,5call Mynumber(getline(".")) | |
7264 < | |
7265 The "a:firstline" and "a:lastline" are defined anyway, they | |
7266 can be used to do something different at the start or end of | |
7267 the range. | |
7268 | |
7269 Example of a function that handles the range itself: > | |
7270 | |
7271 :function Cont() range | |
7272 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
7273 :endfunction | |
7274 :4,8call Cont() | |
7275 < | |
7276 This function inserts the continuation character "\" in front | |
7277 of all the lines in the range, except the first one. | |
7278 | |
1156 | 7279 When the function returns a composite value it can be further |
7280 dereferenced, but the range will not be used then. Example: > | |
7281 :4,8call GetDict().method() | |
7282 < Here GetDict() gets the range but method() does not. | |
7283 | |
7 | 7284 *E132* |
7285 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
7286 option. | |
7287 | |
161 | 7288 |
7289 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 7290 *autoload-functions* |
7291 When using many or large functions, it's possible to automatically define them | |
161 | 7292 only when they are used. There are two methods: with an autocommand and with |
7293 the "autoload" directory in 'runtimepath'. | |
7294 | |
7295 | |
7296 Using an autocommand ~ | |
7297 | |
170 | 7298 This is introduced in the user manual, section |41.14|. |
7299 | |
161 | 7300 The autocommand is useful if you have a plugin that is a long Vim script file. |
7301 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 7302 That makes Vim startup faster. The autocommand should then load the same file |
161 | 7303 again, setting a variable to skip the |:finish| command. |
7304 | |
7305 Use the FuncUndefined autocommand event with a pattern that matches the | |
7306 function(s) to be defined. Example: > | |
7 | 7307 |
7308 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
7309 | |
7310 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
7311 "BufNet". Also see |FuncUndefined|. | |
7312 | |
161 | 7313 |
7314 Using an autoload script ~ | |
168 | 7315 *autoload* *E746* |
170 | 7316 This is introduced in the user manual, section |41.15|. |
7317 | |
161 | 7318 Using a script in the "autoload" directory is simpler, but requires using |
7319 exactly the right file name. A function that can be autoloaded has a name | |
7320 like this: > | |
7321 | |
270 | 7322 :call filename#funcname() |
161 | 7323 |
7324 When such a function is called, and it is not defined yet, Vim will search the | |
7325 "autoload" directories in 'runtimepath' for a script file called | |
7326 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
7327 then define the function like this: > | |
7328 | |
270 | 7329 function filename#funcname() |
161 | 7330 echo "Done!" |
7331 endfunction | |
7332 | |
530 | 7333 The file name and the name used before the # in the function must match |
161 | 7334 exactly, and the defined function must have the name exactly as it will be |
7335 called. | |
7336 | |
270 | 7337 It is possible to use subdirectories. Every # in the function name works like |
7338 a path separator. Thus when calling a function: > | |
7339 | |
7340 :call foo#bar#func() | |
161 | 7341 |
7342 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
7343 | |
168 | 7344 This also works when reading a variable that has not been set yet: > |
7345 | |
270 | 7346 :let l = foo#bar#lvar |
168 | 7347 |
557 | 7348 However, when the autoload script was already loaded it won't be loaded again |
7349 for an unknown variable. | |
7350 | |
168 | 7351 When assigning a value to such a variable nothing special happens. This can |
7352 be used to pass settings to the autoload script before it's loaded: > | |
7353 | |
270 | 7354 :let foo#bar#toggle = 1 |
7355 :call foo#bar#func() | |
168 | 7356 |
164 | 7357 Note that when you make a mistake and call a function that is supposed to be |
7358 defined in an autoload script, but the script doesn't actually define the | |
7359 function, the script will be sourced every time you try to call the function. | |
168 | 7360 And you will get an error message every time. |
7361 | |
7362 Also note that if you have two script files, and one calls a function in the | |
1621 | 7363 other and vice versa, before the used function is defined, it won't work. |
168 | 7364 Avoid using the autoload functionality at the toplevel. |
161 | 7365 |
794 | 7366 Hint: If you distribute a bunch of scripts you can pack them together with the |
7367 |vimball| utility. Also read the user manual |distribute-script|. | |
7368 | |
7 | 7369 ============================================================================== |
7370 6. Curly braces names *curly-braces-names* | |
7371 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7372 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
|
7373 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
|
7374 wrapped in braces {} like this: > |
7 | 7375 my_{adjective}_variable |
7376 | |
7377 When Vim encounters this, it evaluates the expression inside the braces, puts | |
7378 that in place of the expression, and re-interprets the whole as a variable | |
7379 name. So in the above example, if the variable "adjective" was set to | |
7380 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
7381 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
7382 | |
7383 One application for this is to create a set of variables governed by an option | |
1621 | 7384 value. For example, the statement > |
7 | 7385 echo my_{&background}_message |
7386 | |
7387 would output the contents of "my_dark_message" or "my_light_message" depending | |
7388 on the current value of 'background'. | |
7389 | |
7390 You can use multiple brace pairs: > | |
7391 echo my_{adverb}_{adjective}_message | |
7392 ..or even nest them: > | |
7393 echo my_{ad{end_of_word}}_message | |
7394 where "end_of_word" is either "verb" or "jective". | |
7395 | |
7396 However, the expression inside the braces must evaluate to a valid single | |
236 | 7397 variable name, e.g. this is invalid: > |
7 | 7398 :let foo='a + b' |
7399 :echo c{foo}d | |
7400 .. since the result of expansion is "ca + bd", which is not a variable name. | |
7401 | |
7402 *curly-braces-function-names* | |
7403 You can call and define functions by an evaluated name in a similar way. | |
7404 Example: > | |
7405 :let func_end='whizz' | |
7406 :call my_func_{func_end}(parameter) | |
7407 | |
7408 This would call the function "my_func_whizz(parameter)". | |
7409 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7410 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7411 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7412 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7413 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7414 |
7 | 7415 ============================================================================== |
7416 7. Commands *expression-commands* | |
7417 | |
7418 :let {var-name} = {expr1} *:let* *E18* | |
7419 Set internal variable {var-name} to the result of the | |
7420 expression {expr1}. The variable will get the type | |
7421 from the {expr}. If {var-name} didn't exist yet, it | |
7422 is created. | |
7423 | |
85 | 7424 :let {var-name}[{idx}] = {expr1} *E689* |
7425 Set a list item to the result of the expression | |
7426 {expr1}. {var-name} must refer to a list and {idx} | |
7427 must be a valid index in that list. For nested list | |
7428 the index can be repeated. | |
1621 | 7429 This cannot be used to add an item to a |List|. |
7430 This cannot be used to set a byte in a String. You | |
7431 can do that like this: > | |
7432 :let var = var[0:2] . 'X' . var[4:] | |
7433 < | |
114 | 7434 *E711* *E719* |
7435 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 7436 Set a sequence of items in a |List| to the result of |
7437 the expression {expr1}, which must be a list with the | |
87 | 7438 correct number of items. |
7439 {idx1} can be omitted, zero is used instead. | |
7440 {idx2} can be omitted, meaning the end of the list. | |
7441 When the selected range of items is partly past the | |
7442 end of the list, items will be added. | |
7443 | |
153 | 7444 *:let+=* *:let-=* *:let.=* *E734* |
114 | 7445 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
7446 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
7447 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
7448 These fail if {var} was not set yet and when the type | |
7449 of {var} and {expr1} don't fit the operator. | |
7450 | |
7451 | |
7 | 7452 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
7453 Set environment variable {env-name} to the result of | |
7454 the expression {expr1}. The type is always String. | |
114 | 7455 :let ${env-name} .= {expr1} |
7456 Append {expr1} to the environment variable {env-name}. | |
7457 If the environment variable didn't exist yet this | |
7458 works like "=". | |
7 | 7459 |
7460 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
7461 Write the result of the expression {expr1} in register | |
7462 {reg-name}. {reg-name} must be a single letter, and | |
7463 must be the name of a writable register (see | |
7464 |registers|). "@@" can be used for the unnamed | |
7465 register, "@/" for the search pattern. | |
7466 If the result of {expr1} ends in a <CR> or <NL>, the | |
7467 register will be linewise, otherwise it will be set to | |
7468 characterwise. | |
7469 This can be used to clear the last search pattern: > | |
7470 :let @/ = "" | |
7471 < This is different from searching for an empty string, | |
7472 that would match everywhere. | |
7473 | |
114 | 7474 :let @{reg-name} .= {expr1} |
1621 | 7475 Append {expr1} to register {reg-name}. If the |
114 | 7476 register was empty it's like setting it to {expr1}. |
7477 | |
1156 | 7478 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 7479 Set option {option-name} to the result of the |
68 | 7480 expression {expr1}. A String or Number value is |
7481 always converted to the type of the option. | |
7 | 7482 For an option local to a window or buffer the effect |
7483 is just like using the |:set| command: both the local | |
555 | 7484 value and the global value are changed. |
68 | 7485 Example: > |
7486 :let &path = &path . ',/usr/local/include' | |
7 | 7487 |
114 | 7488 :let &{option-name} .= {expr1} |
7489 For a string option: Append {expr1} to the value. | |
7490 Does not insert a comma like |:set+=|. | |
7491 | |
7492 :let &{option-name} += {expr1} | |
7493 :let &{option-name} -= {expr1} | |
7494 For a number or boolean option: Add or subtract | |
7495 {expr1}. | |
7496 | |
7 | 7497 :let &l:{option-name} = {expr1} |
114 | 7498 :let &l:{option-name} .= {expr1} |
7499 :let &l:{option-name} += {expr1} | |
7500 :let &l:{option-name} -= {expr1} | |
7 | 7501 Like above, but only set the local value of an option |
7502 (if there is one). Works like |:setlocal|. | |
7503 | |
7504 :let &g:{option-name} = {expr1} | |
114 | 7505 :let &g:{option-name} .= {expr1} |
7506 :let &g:{option-name} += {expr1} | |
7507 :let &g:{option-name} -= {expr1} | |
7 | 7508 Like above, but only set the global value of an option |
7509 (if there is one). Works like |:setglobal|. | |
7510 | |
85 | 7511 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 7512 {expr1} must evaluate to a |List|. The first item in |
68 | 7513 the list is assigned to {name1}, the second item to |
7514 {name2}, etc. | |
7515 The number of names must match the number of items in | |
685 | 7516 the |List|. |
68 | 7517 Each name can be one of the items of the ":let" |
7518 command as mentioned above. | |
7519 Example: > | |
7520 :let [s, item] = GetItem(s) | |
114 | 7521 < Detail: {expr1} is evaluated first, then the |
7522 assignments are done in sequence. This matters if | |
7523 {name2} depends on {name1}. Example: > | |
7524 :let x = [0, 1] | |
7525 :let i = 0 | |
7526 :let [i, x[i]] = [1, 2] | |
7527 :echo x | |
7528 < The result is [0, 2]. | |
7529 | |
7530 :let [{name1}, {name2}, ...] .= {expr1} | |
7531 :let [{name1}, {name2}, ...] += {expr1} | |
7532 :let [{name1}, {name2}, ...] -= {expr1} | |
7533 Like above, but append/add/subtract the value for each | |
685 | 7534 |List| item. |
68 | 7535 |
7536 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 7537 Like |:let-unpack| above, but the |List| may have more |
114 | 7538 items than there are names. A list of the remaining |
7539 items is assigned to {lastname}. If there are no | |
7540 remaining items {lastname} is set to an empty list. | |
68 | 7541 Example: > |
7542 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
7543 < | |
114 | 7544 :let [{name}, ..., ; {lastname}] .= {expr1} |
7545 :let [{name}, ..., ; {lastname}] += {expr1} | |
7546 :let [{name}, ..., ; {lastname}] -= {expr1} | |
7547 Like above, but append/add/subtract the value for each | |
685 | 7548 |List| item. |
2596 | 7549 |
7550 *E121* | |
1621 | 7551 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 7552 variable names may be given. Special names recognized |
7553 here: *E738* | |
777 | 7554 g: global variables |
7555 b: local buffer variables | |
7556 w: local window variables | |
819 | 7557 t: local tab page variables |
777 | 7558 s: script-local variables |
7559 l: local function variables | |
123 | 7560 v: Vim variables. |
7 | 7561 |
55 | 7562 :let List the values of all variables. The type of the |
7563 variable is indicated before the value: | |
7564 <nothing> String | |
7565 # Number | |
856 | 7566 * Funcref |
7 | 7567 |
148 | 7568 |
1156 | 7569 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 7570 Remove the internal variable {name}. Several variable |
7571 names can be given, they are all removed. The name | |
685 | 7572 may also be a |List| or |Dictionary| item. |
7 | 7573 With [!] no error message is given for non-existing |
7574 variables. | |
685 | 7575 One or more items from a |List| can be removed: > |
108 | 7576 :unlet list[3] " remove fourth item |
7577 :unlet list[3:] " remove fourth item to last | |
685 | 7578 < One item from a |Dictionary| can be removed at a time: > |
108 | 7579 :unlet dict['two'] |
7580 :unlet dict.two | |
1668 | 7581 < This is especially useful to clean up used global |
7582 variables and script-local variables (these are not | |
7583 deleted when the script ends). Function-local | |
7584 variables are automatically deleted when the function | |
7585 ends. | |
7 | 7586 |
148 | 7587 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
7588 Lock the internal variable {name}. Locking means that | |
7589 it can no longer be changed (until it is unlocked). | |
7590 A locked variable can be deleted: > | |
7591 :lockvar v | |
7592 :let v = 'asdf' " fails! | |
7593 :unlet v | |
7594 < *E741* | |
7595 If you try to change a locked variable you get an | |
6530 | 7596 error message: "E741: Value is locked: {name}" |
148 | 7597 |
685 | 7598 [depth] is relevant when locking a |List| or |
7599 |Dictionary|. It specifies how deep the locking goes: | |
7600 1 Lock the |List| or |Dictionary| itself, | |
148 | 7601 cannot add or remove items, but can |
7602 still change their values. | |
7603 2 Also lock the values, cannot change | |
685 | 7604 the items. If an item is a |List| or |
7605 |Dictionary|, cannot add or remove | |
148 | 7606 items, but can still change the |
7607 values. | |
685 | 7608 3 Like 2 but for the |List| / |
7609 |Dictionary| in the |List| / | |
7610 |Dictionary|, one level deeper. | |
7611 The default [depth] is 2, thus when {name} is a |List| | |
7612 or |Dictionary| the values cannot be changed. | |
148 | 7613 *E743* |
7614 For unlimited depth use [!] and omit [depth]. | |
7615 However, there is a maximum depth of 100 to catch | |
7616 loops. | |
7617 | |
685 | 7618 Note that when two variables refer to the same |List| |
7619 and you lock one of them, the |List| will also be | |
819 | 7620 locked when used through the other variable. |
7621 Example: > | |
148 | 7622 :let l = [0, 1, 2, 3] |
7623 :let cl = l | |
7624 :lockvar l | |
7625 :let cl[1] = 99 " won't work! | |
7626 < You may want to make a copy of a list to avoid this. | |
7627 See |deepcopy()|. | |
7628 | |
7629 | |
7630 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
7631 Unlock the internal variable {name}. Does the | |
7632 opposite of |:lockvar|. | |
7633 | |
7634 | |
7 | 7635 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
7636 :en[dif] Execute the commands until the next matching ":else" | |
7637 or ":endif" if {expr1} evaluates to non-zero. | |
7638 | |
7639 From Vim version 4.5 until 5.0, every Ex command in | |
7640 between the ":if" and ":endif" is ignored. These two | |
7641 commands were just to allow for future expansions in a | |
7642 backwards compatible way. Nesting was allowed. Note | |
7643 that any ":else" or ":elseif" was ignored, the "else" | |
7644 part was not executed either. | |
7645 | |
7646 You can use this to remain compatible with older | |
7647 versions: > | |
7648 :if version >= 500 | |
7649 : version-5-specific-commands | |
7650 :endif | |
7651 < The commands still need to be parsed to find the | |
7652 "endif". Sometimes an older Vim has a problem with a | |
7653 new command. For example, ":silent" is recognized as | |
7654 a ":substitute" command. In that case ":execute" can | |
7655 avoid problems: > | |
7656 :if version >= 600 | |
7657 : execute "silent 1,$delete" | |
7658 :endif | |
7659 < | |
7660 NOTE: The ":append" and ":insert" commands don't work | |
7661 properly in between ":if" and ":endif". | |
7662 | |
7663 *:else* *:el* *E581* *E583* | |
7664 :el[se] Execute the commands until the next matching ":else" | |
7665 or ":endif" if they previously were not being | |
7666 executed. | |
7667 | |
7668 *:elseif* *:elsei* *E582* *E584* | |
7669 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
7670 is no extra ":endif". | |
7671 | |
7672 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 7673 *E170* *E585* *E588* *E733* |
7 | 7674 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
7675 as long as {expr1} evaluates to non-zero. | |
7676 When an error is detected from a command inside the | |
7677 loop, execution continues after the "endwhile". | |
75 | 7678 Example: > |
7679 :let lnum = 1 | |
7680 :while lnum <= line("$") | |
7681 :call FixLine(lnum) | |
7682 :let lnum = lnum + 1 | |
7683 :endwhile | |
7684 < | |
7 | 7685 NOTE: The ":append" and ":insert" commands don't work |
99 | 7686 properly inside a ":while" and ":for" loop. |
75 | 7687 |
114 | 7688 :for {var} in {list} *:for* *E690* *E732* |
75 | 7689 :endfo[r] *:endfo* *:endfor* |
7690 Repeat the commands between ":for" and ":endfor" for | |
158 | 7691 each item in {list}. Variable {var} is set to the |
79 | 7692 value of each item. |
7693 When an error is detected for a command inside the | |
75 | 7694 loop, execution continues after the "endfor". |
464 | 7695 Changing {list} inside the loop affects what items are |
7696 used. Make a copy if this is unwanted: > | |
79 | 7697 :for item in copy(mylist) |
7698 < When not making a copy, Vim stores a reference to the | |
7699 next item in the list, before executing the commands | |
1621 | 7700 with the current item. Thus the current item can be |
79 | 7701 removed without effect. Removing any later item means |
7702 it will not be found. Thus the following example | |
7703 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7704 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7705 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7706 endfor |
87 | 7707 < Note that reordering the list (e.g., with sort() or |
7708 reverse()) may have unexpected effects. | |
7709 Note that the type of each list item should be | |
75 | 7710 identical to avoid errors for the type of {var} |
7711 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7712 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7713 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7714 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7715 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7716 endfor |
75 | 7717 |
7718 :for [{var1}, {var2}, ...] in {listlist} | |
7719 :endfo[r] | |
7720 Like ":for" above, but each item in {listlist} must be | |
7721 a list, of which each item is assigned to {var1}, | |
7722 {var2}, etc. Example: > | |
7723 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
7724 :echo getline(lnum)[col] | |
7725 :endfor | |
7726 < | |
7 | 7727 *:continue* *:con* *E586* |
75 | 7728 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
7729 to the start of the loop. | |
7730 If it is used after a |:try| inside the loop but | |
7731 before the matching |:finally| (if present), the | |
7732 commands following the ":finally" up to the matching | |
7733 |:endtry| are executed first. This process applies to | |
7734 all nested ":try"s inside the loop. The outermost | |
7735 ":endtry" then jumps back to the start of the loop. | |
7 | 7736 |
7737 *:break* *:brea* *E587* | |
75 | 7738 :brea[k] When used inside a ":while" or ":for" loop, skips to |
7739 the command after the matching ":endwhile" or | |
7740 ":endfor". | |
7741 If it is used after a |:try| inside the loop but | |
7742 before the matching |:finally| (if present), the | |
7743 commands following the ":finally" up to the matching | |
7744 |:endtry| are executed first. This process applies to | |
7745 all nested ":try"s inside the loop. The outermost | |
7746 ":endtry" then jumps to the command after the loop. | |
7 | 7747 |
7748 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
7749 :endt[ry] Change the error handling for the commands between | |
7750 ":try" and ":endtry" including everything being | |
7751 executed across ":source" commands, function calls, | |
7752 or autocommand invocations. | |
7753 | |
7754 When an error or interrupt is detected and there is | |
7755 a |:finally| command following, execution continues | |
7756 after the ":finally". Otherwise, or when the | |
7757 ":endtry" is reached thereafter, the next | |
7758 (dynamically) surrounding ":try" is checked for | |
7759 a corresponding ":finally" etc. Then the script | |
7760 processing is terminated. (Whether a function | |
7761 definition has an "abort" argument does not matter.) | |
7762 Example: > | |
7763 :try | edit too much | finally | echo "cleanup" | endtry | |
7764 :echo "impossible" " not reached, script terminated above | |
7765 < | |
7766 Moreover, an error or interrupt (dynamically) inside | |
7767 ":try" and ":endtry" is converted to an exception. It | |
7768 can be caught as if it were thrown by a |:throw| | |
7769 command (see |:catch|). In this case, the script | |
7770 processing is not terminated. | |
7771 | |
7772 The value "Vim:Interrupt" is used for an interrupt | |
7773 exception. An error in a Vim command is converted | |
7774 to a value of the form "Vim({command}):{errmsg}", | |
7775 other errors are converted to a value of the form | |
7776 "Vim:{errmsg}". {command} is the full command name, | |
7777 and {errmsg} is the message that is displayed if the | |
7778 error exception is not caught, always beginning with | |
7779 the error number. | |
7780 Examples: > | |
7781 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
7782 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
7783 < | |
7784 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7785 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 7786 |:finally|, or |:endtry| that belongs to the same |
7787 |:try| as the ":catch" are executed when an exception | |
7788 matching {pattern} is being thrown and has not yet | |
7789 been caught by a previous ":catch". Otherwise, these | |
7790 commands are skipped. | |
7791 When {pattern} is omitted all errors are caught. | |
7792 Examples: > | |
7793 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
7794 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
7795 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
7796 :catch /^Vim(write):/ " catch all errors in :write | |
7797 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
7798 :catch /my-exception/ " catch user exception | |
7799 :catch /.*/ " catch everything | |
7800 :catch " same as /.*/ | |
7801 < | |
7802 Another character can be used instead of / around the | |
7803 {pattern}, so long as it does not have a special | |
7804 meaning (e.g., '|' or '"') and doesn't occur inside | |
7805 {pattern}. | |
5814 | 7806 Information about the exception is available in |
7807 |v:exception|. Also see |throw-variables|. | |
7 | 7808 NOTE: It is not reliable to ":catch" the TEXT of |
7809 an error message because it may vary in different | |
7810 locales. | |
7811 | |
7812 *:fina* *:finally* *E606* *E607* | |
7813 :fina[lly] The following commands until the matching |:endtry| | |
7814 are executed whenever the part between the matching | |
7815 |:try| and the ":finally" is left: either by falling | |
7816 through to the ":finally" or by a |:continue|, | |
7817 |:break|, |:finish|, or |:return|, or by an error or | |
7818 interrupt or exception (see |:throw|). | |
7819 | |
7820 *:th* *:throw* *E608* | |
7821 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
7822 If the ":throw" is used after a |:try| but before the | |
7823 first corresponding |:catch|, commands are skipped | |
7824 until the first ":catch" matching {expr1} is reached. | |
7825 If there is no such ":catch" or if the ":throw" is | |
7826 used after a ":catch" but before the |:finally|, the | |
7827 commands following the ":finally" (if present) up to | |
7828 the matching |:endtry| are executed. If the ":throw" | |
7829 is after the ":finally", commands up to the ":endtry" | |
7830 are skipped. At the ":endtry", this process applies | |
7831 again for the next dynamically surrounding ":try" | |
7832 (which may be found in a calling function or sourcing | |
7833 script), until a matching ":catch" has been found. | |
7834 If the exception is not caught, the command processing | |
7835 is terminated. | |
7836 Example: > | |
7837 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 7838 < Note that "catch" may need to be on a separate line |
7839 for when an error causes the parsing to skip the whole | |
7840 line and not see the "|" that separates the commands. | |
7 | 7841 |
7842 *:ec* *:echo* | |
7843 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
7844 first {expr1} starts on a new line. | |
7845 Also see |:comment|. | |
7846 Use "\n" to start a new line. Use "\r" to move the | |
7847 cursor to the first column. | |
7848 Uses the highlighting set by the |:echohl| command. | |
7849 Cannot be followed by a comment. | |
7850 Example: > | |
7851 :echo "the value of 'shell' is" &shell | |
1156 | 7852 < *:echo-redraw* |
7853 A later redraw may make the message disappear again. | |
7854 And since Vim mostly postpones redrawing until it's | |
7855 finished with a sequence of commands this happens | |
7856 quite often. To avoid that a command from before the | |
7857 ":echo" causes a redraw afterwards (redraws are often | |
7858 postponed until you type something), force a redraw | |
7859 with the |:redraw| command. Example: > | |
7 | 7860 :new | redraw | echo "there is a new window" |
7861 < | |
7862 *:echon* | |
7863 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
7864 |:comment|. | |
7865 Uses the highlighting set by the |:echohl| command. | |
7866 Cannot be followed by a comment. | |
7867 Example: > | |
7868 :echon "the value of 'shell' is " &shell | |
7869 < | |
7870 Note the difference between using ":echo", which is a | |
7871 Vim command, and ":!echo", which is an external shell | |
7872 command: > | |
7873 :!echo % --> filename | |
7874 < The arguments of ":!" are expanded, see |:_%|. > | |
7875 :!echo "%" --> filename or "filename" | |
7876 < Like the previous example. Whether you see the double | |
7877 quotes or not depends on your 'shell'. > | |
7878 :echo % --> nothing | |
7879 < The '%' is an illegal character in an expression. > | |
7880 :echo "%" --> % | |
7881 < This just echoes the '%' character. > | |
7882 :echo expand("%") --> filename | |
7883 < This calls the expand() function to expand the '%'. | |
7884 | |
7885 *:echoh* *:echohl* | |
7886 :echoh[l] {name} Use the highlight group {name} for the following | |
7887 |:echo|, |:echon| and |:echomsg| commands. Also used | |
7888 for the |input()| prompt. Example: > | |
7889 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
7890 < Don't forget to set the group back to "None", | |
7891 otherwise all following echo's will be highlighted. | |
7892 | |
7893 *:echom* *:echomsg* | |
7894 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
7895 message in the |message-history|. | |
7896 Spaces are placed between the arguments as with the | |
7897 |:echo| command. But unprintable characters are | |
7898 displayed, not interpreted. | |
1156 | 7899 The parsing works slightly different from |:echo|, |
7900 more like |:execute|. All the expressions are first | |
7901 evaluated and concatenated before echoing anything. | |
7902 The expressions must evaluate to a Number or String, a | |
7903 Dictionary or List causes an error. | |
7 | 7904 Uses the highlighting set by the |:echohl| command. |
7905 Example: > | |
7906 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 7907 < See |:echo-redraw| to avoid the message disappearing |
7908 when the screen is redrawn. | |
7 | 7909 *:echoe* *:echoerr* |
7910 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
7911 message in the |message-history|. When used in a | |
7912 script or function the line number will be added. | |
7913 Spaces are placed between the arguments as with the | |
1621 | 7914 :echo command. When used inside a try conditional, |
7 | 7915 the message is raised as an error exception instead |
7916 (see |try-echoerr|). | |
7917 Example: > | |
7918 :echoerr "This script just failed!" | |
7919 < If you just want a highlighted message use |:echohl|. | |
7920 And to get a beep: > | |
7921 :exe "normal \<Esc>" | |
7922 < | |
7923 *:exe* *:execute* | |
7924 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 7925 of {expr1} as an Ex command. |
7926 Multiple arguments are concatenated, with a space in | |
7927 between. To avoid the extra space use the "." | |
7928 operator to concatenate strings into one argument. | |
7929 {expr1} is used as the processed command, command line | |
7930 editing keys are not recognized. | |
7 | 7931 Cannot be followed by a comment. |
7932 Examples: > | |
2152 | 7933 :execute "buffer" nextbuf |
7934 :execute "normal" count . "w" | |
7 | 7935 < |
7936 ":execute" can be used to append a command to commands | |
7937 that don't accept a '|'. Example: > | |
7938 :execute '!ls' | echo "theend" | |
7939 | |
7940 < ":execute" is also a nice way to avoid having to type | |
7941 control characters in a Vim script for a ":normal" | |
7942 command: > | |
7943 :execute "normal ixxx\<Esc>" | |
7944 < This has an <Esc> character, see |expr-string|. | |
7945 | |
1621 | 7946 Be careful to correctly escape special characters in |
7947 file names. The |fnameescape()| function can be used | |
1661 | 7948 for Vim commands, |shellescape()| for |:!| commands. |
7949 Examples: > | |
1621 | 7950 :execute "e " . fnameescape(filename) |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
7951 :execute "!ls " . shellescape(filename, 1) |
1621 | 7952 < |
7 | 7953 Note: The executed string may be any command-line, but |
5763 | 7954 starting or ending "if", "while" and "for" does not |
7955 always work, because when commands are skipped the | |
7956 ":execute" is not evaluated and Vim loses track of | |
7957 where blocks start and end. Also "break" and | |
7958 "continue" should not be inside ":execute". | |
7959 This example does not work, because the ":execute" is | |
7960 not evaluated and Vim does not see the "while", and | |
7961 gives an error for finding an ":endwhile": > | |
7962 :if 0 | |
7963 : execute 'while i > 5' | |
7964 : echo "test" | |
7965 : endwhile | |
7966 :endif | |
7 | 7967 < |
7968 It is allowed to have a "while" or "if" command | |
7969 completely in the executed string: > | |
7970 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
7971 < | |
7972 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7973 *:exe-comment* |
7 | 7974 ":execute", ":echo" and ":echon" cannot be followed by |
7975 a comment directly, because they see the '"' as the | |
7976 start of a string. But, you can use '|' followed by a | |
7977 comment. Example: > | |
7978 :echo "foo" | "this is a comment | |
7979 | |
7980 ============================================================================== | |
7981 8. Exception handling *exception-handling* | |
7982 | |
7983 The Vim script language comprises an exception handling feature. This section | |
7984 explains how it can be used in a Vim script. | |
7985 | |
7986 Exceptions may be raised by Vim on an error or on interrupt, see | |
7987 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
7988 exception by using the ":throw" command, see |throw-catch|. | |
7989 | |
7990 | |
7991 TRY CONDITIONALS *try-conditionals* | |
7992 | |
7993 Exceptions can be caught or can cause cleanup code to be executed. You can | |
7994 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
7995 a finally clause (to be executed for cleanup). | |
7996 A try conditional begins with a |:try| command and ends at the matching | |
7997 |:endtry| command. In between, you can use a |:catch| command to start | |
7998 a catch clause, or a |:finally| command to start a finally clause. There may | |
7999 be none or multiple catch clauses, but there is at most one finally clause, | |
8000 which must not be followed by any catch clauses. The lines before the catch | |
8001 clauses and the finally clause is called a try block. > | |
8002 | |
8003 :try | |
1621 | 8004 : ... |
8005 : ... TRY BLOCK | |
8006 : ... | |
7 | 8007 :catch /{pattern}/ |
1621 | 8008 : ... |
8009 : ... CATCH CLAUSE | |
8010 : ... | |
7 | 8011 :catch /{pattern}/ |
1621 | 8012 : ... |
8013 : ... CATCH CLAUSE | |
8014 : ... | |
7 | 8015 :finally |
1621 | 8016 : ... |
8017 : ... FINALLY CLAUSE | |
8018 : ... | |
7 | 8019 :endtry |
8020 | |
8021 The try conditional allows to watch code for exceptions and to take the | |
8022 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
8023 from the try block and also the catch clauses may cause cleanup actions. | |
8024 When no exception is thrown during execution of the try block, the control | |
8025 is transferred to the finally clause, if present. After its execution, the | |
8026 script continues with the line following the ":endtry". | |
8027 When an exception occurs during execution of the try block, the remaining | |
8028 lines in the try block are skipped. The exception is matched against the | |
8029 patterns specified as arguments to the ":catch" commands. The catch clause | |
8030 after the first matching ":catch" is taken, other catch clauses are not | |
8031 executed. The catch clause ends when the next ":catch", ":finally", or | |
8032 ":endtry" command is reached - whatever is first. Then, the finally clause | |
8033 (if present) is executed. When the ":endtry" is reached, the script execution | |
8034 continues in the following line as usual. | |
8035 When an exception that does not match any of the patterns specified by the | |
8036 ":catch" commands is thrown in the try block, the exception is not caught by | |
8037 that try conditional and none of the catch clauses is executed. Only the | |
8038 finally clause, if present, is taken. The exception pends during execution of | |
8039 the finally clause. It is resumed at the ":endtry", so that commands after | |
8040 the ":endtry" are not executed and the exception might be caught elsewhere, | |
8041 see |try-nesting|. | |
8042 When during execution of a catch clause another exception is thrown, the | |
1621 | 8043 remaining lines in that catch clause are not executed. The new exception is |
7 | 8044 not matched against the patterns in any of the ":catch" commands of the same |
8045 try conditional and none of its catch clauses is taken. If there is, however, | |
8046 a finally clause, it is executed, and the exception pends during its | |
8047 execution. The commands following the ":endtry" are not executed. The new | |
8048 exception might, however, be caught elsewhere, see |try-nesting|. | |
8049 When during execution of the finally clause (if present) an exception is | |
1621 | 8050 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 8051 clause has been taken because of an exception from the try block or one of the |
8052 catch clauses, the original (pending) exception is discarded. The commands | |
8053 following the ":endtry" are not executed, and the exception from the finally | |
8054 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
8055 | |
8056 The finally clause is also executed, when a ":break" or ":continue" for | |
8057 a ":while" loop enclosing the complete try conditional is executed from the | |
8058 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
8059 from the try block or a catch clause of a try conditional in a function or | |
8060 sourced script, respectively. The ":break", ":continue", ":return", or | |
8061 ":finish" pends during execution of the finally clause and is resumed when the | |
8062 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
8063 from the finally clause. | |
8064 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
8065 try conditional or when a ":return" or ":finish" is encountered in the finally | |
8066 clause, the rest of the finally clause is skipped, and the ":break", | |
8067 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
8068 clause has been taken because of an exception or an earlier ":break", | |
8069 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
8070 this pending exception or command is discarded. | |
8071 | |
8072 For examples see |throw-catch| and |try-finally|. | |
8073 | |
8074 | |
8075 NESTING OF TRY CONDITIONALS *try-nesting* | |
8076 | |
8077 Try conditionals can be nested arbitrarily. That is, a complete try | |
8078 conditional can be put into the try block, a catch clause, or the finally | |
8079 clause of another try conditional. If the inner try conditional does not | |
8080 catch an exception thrown in its try block or throws a new exception from one | |
8081 of its catch clauses or its finally clause, the outer try conditional is | |
8082 checked according to the rules above. If the inner try conditional is in the | |
8083 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 8084 otherwise only the finally clause is executed. It does not matter for |
7 | 8085 nesting, whether the inner try conditional is directly contained in the outer |
8086 one, or whether the outer one sources a script or calls a function containing | |
8087 the inner try conditional. | |
8088 | |
8089 When none of the active try conditionals catches an exception, just their | |
8090 finally clauses are executed. Thereafter, the script processing terminates. | |
8091 An error message is displayed in case of an uncaught exception explicitly | |
8092 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
8093 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
8094 as usual. | |
8095 | |
8096 For examples see |throw-catch|. | |
8097 | |
8098 | |
8099 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
8100 | |
8101 Exception handling code can get tricky. If you are in doubt what happens, set | |
8102 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
8103 script file. Then you see when an exception is thrown, discarded, caught, or | |
8104 finished. When using a verbosity level of at least 14, things pending in | |
8105 a finally clause are also shown. This information is also given in debug mode | |
8106 (see |debug-scripts|). | |
8107 | |
8108 | |
8109 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
8110 | |
8111 You can throw any number or string as an exception. Use the |:throw| command | |
8112 and pass the value to be thrown as argument: > | |
8113 :throw 4711 | |
8114 :throw "string" | |
8115 < *throw-expression* | |
8116 You can also specify an expression argument. The expression is then evaluated | |
8117 first, and the result is thrown: > | |
8118 :throw 4705 + strlen("string") | |
8119 :throw strpart("strings", 0, 6) | |
8120 | |
8121 An exception might be thrown during evaluation of the argument of the ":throw" | |
8122 command. Unless it is caught there, the expression evaluation is abandoned. | |
8123 The ":throw" command then does not throw a new exception. | |
8124 Example: > | |
8125 | |
8126 :function! Foo(arg) | |
8127 : try | |
8128 : throw a:arg | |
8129 : catch /foo/ | |
8130 : endtry | |
8131 : return 1 | |
8132 :endfunction | |
8133 : | |
8134 :function! Bar() | |
8135 : echo "in Bar" | |
8136 : return 4710 | |
8137 :endfunction | |
8138 : | |
8139 :throw Foo("arrgh") + Bar() | |
8140 | |
8141 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
8142 executed. > | |
8143 :throw Foo("foo") + Bar() | |
8144 however displays "in Bar" and throws 4711. | |
8145 | |
8146 Any other command that takes an expression as argument might also be | |
1621 | 8147 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 8148 exception is then propagated to the caller of the command. |
8149 Example: > | |
8150 | |
8151 :if Foo("arrgh") | |
8152 : echo "then" | |
8153 :else | |
8154 : echo "else" | |
8155 :endif | |
8156 | |
8157 Here neither of "then" or "else" is displayed. | |
8158 | |
8159 *catch-order* | |
8160 Exceptions can be caught by a try conditional with one or more |:catch| | |
8161 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
8162 command can be specified as a pattern argument. The subsequent catch clause | |
8163 gets executed when a matching exception is caught. | |
8164 Example: > | |
8165 | |
8166 :function! Foo(value) | |
8167 : try | |
8168 : throw a:value | |
8169 : catch /^\d\+$/ | |
8170 : echo "Number thrown" | |
8171 : catch /.*/ | |
8172 : echo "String thrown" | |
8173 : endtry | |
8174 :endfunction | |
8175 : | |
8176 :call Foo(0x1267) | |
8177 :call Foo('string') | |
8178 | |
8179 The first call to Foo() displays "Number thrown", the second "String thrown". | |
8180 An exception is matched against the ":catch" commands in the order they are | |
8181 specified. Only the first match counts. So you should place the more | |
8182 specific ":catch" first. The following order does not make sense: > | |
8183 | |
8184 : catch /.*/ | |
8185 : echo "String thrown" | |
8186 : catch /^\d\+$/ | |
8187 : echo "Number thrown" | |
8188 | |
8189 The first ":catch" here matches always, so that the second catch clause is | |
8190 never taken. | |
8191 | |
8192 *throw-variables* | |
8193 If you catch an exception by a general pattern, you may access the exact value | |
8194 in the variable |v:exception|: > | |
8195 | |
8196 : catch /^\d\+$/ | |
8197 : echo "Number thrown. Value is" v:exception | |
8198 | |
8199 You may also be interested where an exception was thrown. This is stored in | |
8200 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
8201 exception most recently caught as long it is not finished. | |
8202 Example: > | |
8203 | |
8204 :function! Caught() | |
8205 : if v:exception != "" | |
8206 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
8207 : else | |
8208 : echo 'Nothing caught' | |
8209 : endif | |
8210 :endfunction | |
8211 : | |
8212 :function! Foo() | |
8213 : try | |
8214 : try | |
8215 : try | |
8216 : throw 4711 | |
8217 : finally | |
8218 : call Caught() | |
8219 : endtry | |
8220 : catch /.*/ | |
8221 : call Caught() | |
8222 : throw "oops" | |
8223 : endtry | |
8224 : catch /.*/ | |
8225 : call Caught() | |
8226 : finally | |
8227 : call Caught() | |
8228 : endtry | |
8229 :endfunction | |
8230 : | |
8231 :call Foo() | |
8232 | |
8233 This displays > | |
8234 | |
8235 Nothing caught | |
8236 Caught "4711" in function Foo, line 4 | |
8237 Caught "oops" in function Foo, line 10 | |
8238 Nothing caught | |
8239 | |
8240 A practical example: The following command ":LineNumber" displays the line | |
8241 number in the script or function where it has been used: > | |
8242 | |
8243 :function! LineNumber() | |
8244 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
8245 :endfunction | |
8246 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
8247 < | |
8248 *try-nested* | |
8249 An exception that is not caught by a try conditional can be caught by | |
8250 a surrounding try conditional: > | |
8251 | |
8252 :try | |
8253 : try | |
8254 : throw "foo" | |
8255 : catch /foobar/ | |
8256 : echo "foobar" | |
8257 : finally | |
8258 : echo "inner finally" | |
8259 : endtry | |
8260 :catch /foo/ | |
8261 : echo "foo" | |
8262 :endtry | |
8263 | |
8264 The inner try conditional does not catch the exception, just its finally | |
8265 clause is executed. The exception is then caught by the outer try | |
8266 conditional. The example displays "inner finally" and then "foo". | |
8267 | |
8268 *throw-from-catch* | |
8269 You can catch an exception and throw a new one to be caught elsewhere from the | |
8270 catch clause: > | |
8271 | |
8272 :function! Foo() | |
8273 : throw "foo" | |
8274 :endfunction | |
8275 : | |
8276 :function! Bar() | |
8277 : try | |
8278 : call Foo() | |
8279 : catch /foo/ | |
8280 : echo "Caught foo, throw bar" | |
8281 : throw "bar" | |
8282 : endtry | |
8283 :endfunction | |
8284 : | |
8285 :try | |
8286 : call Bar() | |
8287 :catch /.*/ | |
8288 : echo "Caught" v:exception | |
8289 :endtry | |
8290 | |
8291 This displays "Caught foo, throw bar" and then "Caught bar". | |
8292 | |
8293 *rethrow* | |
8294 There is no real rethrow in the Vim script language, but you may throw | |
8295 "v:exception" instead: > | |
8296 | |
8297 :function! Bar() | |
8298 : try | |
8299 : call Foo() | |
8300 : catch /.*/ | |
8301 : echo "Rethrow" v:exception | |
8302 : throw v:exception | |
8303 : endtry | |
8304 :endfunction | |
8305 < *try-echoerr* | |
8306 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
8307 exceptions, because it is not possible to fake Vim internal exceptions. | |
8308 Trying so causes an error exception. You should throw your own exception | |
8309 denoting the situation. If you want to cause a Vim error exception containing | |
8310 the original error exception value, you can use the |:echoerr| command: > | |
8311 | |
8312 :try | |
8313 : try | |
8314 : asdf | |
8315 : catch /.*/ | |
8316 : echoerr v:exception | |
8317 : endtry | |
8318 :catch /.*/ | |
8319 : echo v:exception | |
8320 :endtry | |
8321 | |
8322 This code displays | |
8323 | |
1621 | 8324 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 8325 |
8326 | |
8327 CLEANUP CODE *try-finally* | |
8328 | |
8329 Scripts often change global settings and restore them at their end. If the | |
8330 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 8331 an inconsistent state. The same may happen to you in the development phase of |
7 | 8332 a script when an error occurs or you explicitly throw an exception without |
8333 catching it. You can solve these problems by using a try conditional with | |
8334 a finally clause for restoring the settings. Its execution is guaranteed on | |
8335 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
8336 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 8337 to exceptions. When not caught, they terminate the script after the finally |
7 | 8338 clause has been executed.) |
8339 Example: > | |
8340 | |
8341 :try | |
8342 : let s:saved_ts = &ts | |
8343 : set ts=17 | |
8344 : | |
8345 : " Do the hard work here. | |
8346 : | |
8347 :finally | |
8348 : let &ts = s:saved_ts | |
8349 : unlet s:saved_ts | |
8350 :endtry | |
8351 | |
8352 This method should be used locally whenever a function or part of a script | |
8353 changes global settings which need to be restored on failure or normal exit of | |
8354 that function or script part. | |
8355 | |
8356 *break-finally* | |
8357 Cleanup code works also when the try block or a catch clause is left by | |
8358 a ":continue", ":break", ":return", or ":finish". | |
8359 Example: > | |
8360 | |
8361 :let first = 1 | |
8362 :while 1 | |
8363 : try | |
8364 : if first | |
8365 : echo "first" | |
8366 : let first = 0 | |
8367 : continue | |
8368 : else | |
8369 : throw "second" | |
8370 : endif | |
8371 : catch /.*/ | |
8372 : echo v:exception | |
8373 : break | |
8374 : finally | |
8375 : echo "cleanup" | |
8376 : endtry | |
8377 : echo "still in while" | |
8378 :endwhile | |
8379 :echo "end" | |
8380 | |
8381 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
8382 | |
8383 :function! Foo() | |
8384 : try | |
8385 : return 4711 | |
8386 : finally | |
8387 : echo "cleanup\n" | |
8388 : endtry | |
8389 : echo "Foo still active" | |
8390 :endfunction | |
8391 : | |
8392 :echo Foo() "returned by Foo" | |
8393 | |
8394 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 8395 extra ":return" in the finally clause. (Above all, this would override the |
7 | 8396 return value.) |
8397 | |
8398 *except-from-finally* | |
8399 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
8400 a finally clause is possible, but not recommended since it abandons the | |
8401 cleanup actions for the try conditional. But, of course, interrupt and error | |
8402 exceptions might get raised from a finally clause. | |
8403 Example where an error in the finally clause stops an interrupt from | |
8404 working correctly: > | |
8405 | |
8406 :try | |
8407 : try | |
8408 : echo "Press CTRL-C for interrupt" | |
8409 : while 1 | |
8410 : endwhile | |
8411 : finally | |
8412 : unlet novar | |
8413 : endtry | |
8414 :catch /novar/ | |
8415 :endtry | |
8416 :echo "Script still running" | |
8417 :sleep 1 | |
8418 | |
8419 If you need to put commands that could fail into a finally clause, you should | |
8420 think about catching or ignoring the errors in these commands, see | |
8421 |catch-errors| and |ignore-errors|. | |
8422 | |
8423 | |
8424 CATCHING ERRORS *catch-errors* | |
8425 | |
8426 If you want to catch specific errors, you just have to put the code to be | |
8427 watched in a try block and add a catch clause for the error message. The | |
8428 presence of the try conditional causes all errors to be converted to an | |
8429 exception. No message is displayed and |v:errmsg| is not set then. To find | |
8430 the right pattern for the ":catch" command, you have to know how the format of | |
8431 the error exception is. | |
8432 Error exceptions have the following format: > | |
8433 | |
8434 Vim({cmdname}):{errmsg} | |
8435 or > | |
8436 Vim:{errmsg} | |
8437 | |
8438 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 8439 the command name is not known. {errmsg} is the error message usually produced |
7 | 8440 when the error occurs outside try conditionals. It always begins with |
8441 a capital "E", followed by a two or three-digit error number, a colon, and | |
8442 a space. | |
8443 | |
8444 Examples: | |
8445 | |
8446 The command > | |
8447 :unlet novar | |
8448 normally produces the error message > | |
8449 E108: No such variable: "novar" | |
8450 which is converted inside try conditionals to an exception > | |
8451 Vim(unlet):E108: No such variable: "novar" | |
8452 | |
8453 The command > | |
8454 :dwim | |
8455 normally produces the error message > | |
8456 E492: Not an editor command: dwim | |
8457 which is converted inside try conditionals to an exception > | |
8458 Vim:E492: Not an editor command: dwim | |
8459 | |
8460 You can catch all ":unlet" errors by a > | |
8461 :catch /^Vim(unlet):/ | |
8462 or all errors for misspelled command names by a > | |
8463 :catch /^Vim:E492:/ | |
8464 | |
8465 Some error messages may be produced by different commands: > | |
8466 :function nofunc | |
8467 and > | |
8468 :delfunction nofunc | |
8469 both produce the error message > | |
8470 E128: Function name must start with a capital: nofunc | |
8471 which is converted inside try conditionals to an exception > | |
8472 Vim(function):E128: Function name must start with a capital: nofunc | |
8473 or > | |
8474 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
8475 respectively. You can catch the error by its number independently on the | |
8476 command that caused it if you use the following pattern: > | |
8477 :catch /^Vim(\a\+):E128:/ | |
8478 | |
8479 Some commands like > | |
8480 :let x = novar | |
8481 produce multiple error messages, here: > | |
8482 E121: Undefined variable: novar | |
8483 E15: Invalid expression: novar | |
8484 Only the first is used for the exception value, since it is the most specific | |
8485 one (see |except-several-errors|). So you can catch it by > | |
8486 :catch /^Vim(\a\+):E121:/ | |
8487 | |
8488 You can catch all errors related to the name "nofunc" by > | |
8489 :catch /\<nofunc\>/ | |
8490 | |
8491 You can catch all Vim errors in the ":write" and ":read" commands by > | |
8492 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
8493 | |
8494 You can catch all Vim errors by the pattern > | |
8495 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
8496 < | |
8497 *catch-text* | |
8498 NOTE: You should never catch the error message text itself: > | |
8499 :catch /No such variable/ | |
6647 | 8500 only works in the English locale, but not when the user has selected |
7 | 8501 a different language by the |:language| command. It is however helpful to |
8502 cite the message text in a comment: > | |
8503 :catch /^Vim(\a\+):E108:/ " No such variable | |
8504 | |
8505 | |
8506 IGNORING ERRORS *ignore-errors* | |
8507 | |
8508 You can ignore errors in a specific Vim command by catching them locally: > | |
8509 | |
8510 :try | |
8511 : write | |
8512 :catch | |
8513 :endtry | |
8514 | |
8515 But you are strongly recommended NOT to use this simple form, since it could | |
8516 catch more than you want. With the ":write" command, some autocommands could | |
8517 be executed and cause errors not related to writing, for instance: > | |
8518 | |
8519 :au BufWritePre * unlet novar | |
8520 | |
8521 There could even be such errors you are not responsible for as a script | |
8522 writer: a user of your script might have defined such autocommands. You would | |
8523 then hide the error from the user. | |
8524 It is much better to use > | |
8525 | |
8526 :try | |
8527 : write | |
8528 :catch /^Vim(write):/ | |
8529 :endtry | |
8530 | |
8531 which only catches real write errors. So catch only what you'd like to ignore | |
8532 intentionally. | |
8533 | |
8534 For a single command that does not cause execution of autocommands, you could | |
8535 even suppress the conversion of errors to exceptions by the ":silent!" | |
8536 command: > | |
8537 :silent! nunmap k | |
8538 This works also when a try conditional is active. | |
8539 | |
8540 | |
8541 CATCHING INTERRUPTS *catch-interrupt* | |
8542 | |
8543 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 8544 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 8545 script is not terminated, then. |
8546 Example: > | |
8547 | |
8548 :function! TASK1() | |
8549 : sleep 10 | |
8550 :endfunction | |
8551 | |
8552 :function! TASK2() | |
8553 : sleep 20 | |
8554 :endfunction | |
8555 | |
8556 :while 1 | |
8557 : let command = input("Type a command: ") | |
8558 : try | |
8559 : if command == "" | |
8560 : continue | |
8561 : elseif command == "END" | |
8562 : break | |
8563 : elseif command == "TASK1" | |
8564 : call TASK1() | |
8565 : elseif command == "TASK2" | |
8566 : call TASK2() | |
8567 : else | |
8568 : echo "\nIllegal command:" command | |
8569 : continue | |
8570 : endif | |
8571 : catch /^Vim:Interrupt$/ | |
8572 : echo "\nCommand interrupted" | |
8573 : " Caught the interrupt. Continue with next prompt. | |
8574 : endtry | |
8575 :endwhile | |
8576 | |
8577 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 8578 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 8579 |
8580 For testing what happens when CTRL-C would be pressed on a specific line in | |
8581 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
8582 command on that line. See |debug-scripts|. | |
8583 | |
8584 | |
8585 CATCHING ALL *catch-all* | |
8586 | |
8587 The commands > | |
8588 | |
8589 :catch /.*/ | |
8590 :catch // | |
8591 :catch | |
8592 | |
8593 catch everything, error exceptions, interrupt exceptions and exceptions | |
8594 explicitly thrown by the |:throw| command. This is useful at the top level of | |
8595 a script in order to catch unexpected things. | |
8596 Example: > | |
8597 | |
8598 :try | |
8599 : | |
8600 : " do the hard work here | |
8601 : | |
8602 :catch /MyException/ | |
8603 : | |
8604 : " handle known problem | |
8605 : | |
8606 :catch /^Vim:Interrupt$/ | |
8607 : echo "Script interrupted" | |
8608 :catch /.*/ | |
8609 : echo "Internal error (" . v:exception . ")" | |
8610 : echo " - occurred at " . v:throwpoint | |
8611 :endtry | |
8612 :" end of script | |
8613 | |
8614 Note: Catching all might catch more things than you want. Thus, you are | |
8615 strongly encouraged to catch only for problems that you can really handle by | |
8616 specifying a pattern argument to the ":catch". | |
8617 Example: Catching all could make it nearly impossible to interrupt a script | |
8618 by pressing CTRL-C: > | |
8619 | |
8620 :while 1 | |
8621 : try | |
8622 : sleep 1 | |
8623 : catch | |
8624 : endtry | |
8625 :endwhile | |
8626 | |
8627 | |
8628 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
8629 | |
8630 Exceptions may be used during execution of autocommands. Example: > | |
8631 | |
8632 :autocmd User x try | |
8633 :autocmd User x throw "Oops!" | |
8634 :autocmd User x catch | |
8635 :autocmd User x echo v:exception | |
8636 :autocmd User x endtry | |
8637 :autocmd User x throw "Arrgh!" | |
8638 :autocmd User x echo "Should not be displayed" | |
8639 : | |
8640 :try | |
8641 : doautocmd User x | |
8642 :catch | |
8643 : echo v:exception | |
8644 :endtry | |
8645 | |
8646 This displays "Oops!" and "Arrgh!". | |
8647 | |
8648 *except-autocmd-Pre* | |
8649 For some commands, autocommands get executed before the main action of the | |
8650 command takes place. If an exception is thrown and not caught in the sequence | |
8651 of autocommands, the sequence and the command that caused its execution are | |
8652 abandoned and the exception is propagated to the caller of the command. | |
8653 Example: > | |
8654 | |
8655 :autocmd BufWritePre * throw "FAIL" | |
8656 :autocmd BufWritePre * echo "Should not be displayed" | |
8657 : | |
8658 :try | |
8659 : write | |
8660 :catch | |
8661 : echo "Caught:" v:exception "from" v:throwpoint | |
8662 :endtry | |
8663 | |
8664 Here, the ":write" command does not write the file currently being edited (as | |
8665 you can see by checking 'modified'), since the exception from the BufWritePre | |
8666 autocommand abandons the ":write". The exception is then caught and the | |
8667 script displays: > | |
8668 | |
8669 Caught: FAIL from BufWrite Auto commands for "*" | |
8670 < | |
8671 *except-autocmd-Post* | |
8672 For some commands, autocommands get executed after the main action of the | |
8673 command has taken place. If this main action fails and the command is inside | |
8674 an active try conditional, the autocommands are skipped and an error exception | |
8675 is thrown that can be caught by the caller of the command. | |
8676 Example: > | |
8677 | |
8678 :autocmd BufWritePost * echo "File successfully written!" | |
8679 : | |
8680 :try | |
8681 : write /i/m/p/o/s/s/i/b/l/e | |
8682 :catch | |
8683 : echo v:exception | |
8684 :endtry | |
8685 | |
8686 This just displays: > | |
8687 | |
8688 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
8689 | |
8690 If you really need to execute the autocommands even when the main action | |
8691 fails, trigger the event from the catch clause. | |
8692 Example: > | |
8693 | |
8694 :autocmd BufWritePre * set noreadonly | |
8695 :autocmd BufWritePost * set readonly | |
8696 : | |
8697 :try | |
8698 : write /i/m/p/o/s/s/i/b/l/e | |
8699 :catch | |
8700 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
8701 :endtry | |
8702 < | |
8703 You can also use ":silent!": > | |
8704 | |
8705 :let x = "ok" | |
8706 :let v:errmsg = "" | |
8707 :autocmd BufWritePost * if v:errmsg != "" | |
8708 :autocmd BufWritePost * let x = "after fail" | |
8709 :autocmd BufWritePost * endif | |
8710 :try | |
8711 : silent! write /i/m/p/o/s/s/i/b/l/e | |
8712 :catch | |
8713 :endtry | |
8714 :echo x | |
8715 | |
8716 This displays "after fail". | |
8717 | |
8718 If the main action of the command does not fail, exceptions from the | |
8719 autocommands will be catchable by the caller of the command: > | |
8720 | |
8721 :autocmd BufWritePost * throw ":-(" | |
8722 :autocmd BufWritePost * echo "Should not be displayed" | |
8723 : | |
8724 :try | |
8725 : write | |
8726 :catch | |
8727 : echo v:exception | |
8728 :endtry | |
8729 < | |
8730 *except-autocmd-Cmd* | |
8731 For some commands, the normal action can be replaced by a sequence of | |
8732 autocommands. Exceptions from that sequence will be catchable by the caller | |
8733 of the command. | |
8734 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 8735 had actually been written when the exception occurred. You need to tell it in |
7 | 8736 some way. > |
8737 | |
8738 :if !exists("cnt") | |
8739 : let cnt = 0 | |
8740 : | |
8741 : autocmd BufWriteCmd * if &modified | |
8742 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
8743 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
8744 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8745 : autocmd BufWriteCmd * endif | |
8746 : autocmd BufWriteCmd * write | set nomodified | |
8747 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
8748 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8749 : autocmd BufWriteCmd * endif | |
8750 : autocmd BufWriteCmd * echo "File successfully written!" | |
8751 : autocmd BufWriteCmd * endif | |
8752 :endif | |
8753 : | |
8754 :try | |
8755 : write | |
8756 :catch /^BufWriteCmdError$/ | |
8757 : if &modified | |
8758 : echo "Error on writing (file contents not changed)" | |
8759 : else | |
8760 : echo "Error after writing" | |
8761 : endif | |
8762 :catch /^Vim(write):/ | |
8763 : echo "Error on writing" | |
8764 :endtry | |
8765 | |
8766 When this script is sourced several times after making changes, it displays | |
8767 first > | |
8768 File successfully written! | |
8769 then > | |
8770 Error on writing (file contents not changed) | |
8771 then > | |
8772 Error after writing | |
8773 etc. | |
8774 | |
8775 *except-autocmd-ill* | |
8776 You cannot spread a try conditional over autocommands for different events. | |
8777 The following code is ill-formed: > | |
8778 | |
8779 :autocmd BufWritePre * try | |
8780 : | |
8781 :autocmd BufWritePost * catch | |
8782 :autocmd BufWritePost * echo v:exception | |
8783 :autocmd BufWritePost * endtry | |
8784 : | |
8785 :write | |
8786 | |
8787 | |
8788 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
8789 | |
8790 Some programming languages allow to use hierarchies of exception classes or to | |
8791 pass additional information with the object of an exception class. You can do | |
8792 similar things in Vim. | |
8793 In order to throw an exception from a hierarchy, just throw the complete | |
8794 class name with the components separated by a colon, for instance throw the | |
8795 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
8796 When you want to pass additional information with your exception class, add | |
8797 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
8798 for an error when writing "myfile". | |
8799 With the appropriate patterns in the ":catch" command, you can catch for | |
8800 base classes or derived classes of your hierarchy. Additional information in | |
8801 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
8802 Example: > | |
8803 | |
8804 :function! CheckRange(a, func) | |
8805 : if a:a < 0 | |
8806 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
8807 : endif | |
8808 :endfunction | |
8809 : | |
8810 :function! Add(a, b) | |
8811 : call CheckRange(a:a, "Add") | |
8812 : call CheckRange(a:b, "Add") | |
8813 : let c = a:a + a:b | |
8814 : if c < 0 | |
8815 : throw "EXCEPT:MATHERR:OVERFLOW" | |
8816 : endif | |
8817 : return c | |
8818 :endfunction | |
8819 : | |
8820 :function! Div(a, b) | |
8821 : call CheckRange(a:a, "Div") | |
8822 : call CheckRange(a:b, "Div") | |
8823 : if (a:b == 0) | |
8824 : throw "EXCEPT:MATHERR:ZERODIV" | |
8825 : endif | |
8826 : return a:a / a:b | |
8827 :endfunction | |
8828 : | |
8829 :function! Write(file) | |
8830 : try | |
1621 | 8831 : execute "write" fnameescape(a:file) |
7 | 8832 : catch /^Vim(write):/ |
8833 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
8834 : endtry | |
8835 :endfunction | |
8836 : | |
8837 :try | |
8838 : | |
8839 : " something with arithmetics and I/O | |
8840 : | |
8841 :catch /^EXCEPT:MATHERR:RANGE/ | |
8842 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
8843 : echo "Range error in" function | |
8844 : | |
8845 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
8846 : echo "Math error" | |
8847 : | |
8848 :catch /^EXCEPT:IO/ | |
8849 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
8850 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
8851 : if file !~ '^/' | |
8852 : let file = dir . "/" . file | |
8853 : endif | |
8854 : echo 'I/O error for "' . file . '"' | |
8855 : | |
8856 :catch /^EXCEPT/ | |
8857 : echo "Unspecified error" | |
8858 : | |
8859 :endtry | |
8860 | |
8861 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
8862 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
8863 exceptions with the "Vim" prefix; they are reserved for Vim. | |
8864 Vim error exceptions are parameterized with the name of the command that | |
8865 failed, if known. See |catch-errors|. | |
8866 | |
8867 | |
8868 PECULIARITIES | |
8869 *except-compat* | |
8870 The exception handling concept requires that the command sequence causing the | |
8871 exception is aborted immediately and control is transferred to finally clauses | |
8872 and/or a catch clause. | |
8873 | |
8874 In the Vim script language there are cases where scripts and functions | |
8875 continue after an error: in functions without the "abort" flag or in a command | |
8876 after ":silent!", control flow goes to the following line, and outside | |
8877 functions, control flow goes to the line following the outermost ":endwhile" | |
8878 or ":endif". On the other hand, errors should be catchable as exceptions | |
8879 (thus, requiring the immediate abortion). | |
8880 | |
8881 This problem has been solved by converting errors to exceptions and using | |
8882 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 8883 conditional is active. This is no restriction since an (error) exception can |
8884 be caught only from an active try conditional. If you want an immediate | |
7 | 8885 termination without catching the error, just use a try conditional without |
8886 catch clause. (You can cause cleanup code being executed before termination | |
8887 by specifying a finally clause.) | |
8888 | |
8889 When no try conditional is active, the usual abortion and continuation | |
8890 behavior is used instead of immediate abortion. This ensures compatibility of | |
8891 scripts written for Vim 6.1 and earlier. | |
8892 | |
8893 However, when sourcing an existing script that does not use exception handling | |
8894 commands (or when calling one of its functions) from inside an active try | |
8895 conditional of a new script, you might change the control flow of the existing | |
8896 script on error. You get the immediate abortion on error and can catch the | |
8897 error in the new script. If however the sourced script suppresses error | |
8898 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 8899 |v:errmsg| if appropriate), its execution path is not changed. The error is |
8900 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 8901 where this happens is for scripts that don't care about errors and produce |
8902 error messages. You probably won't want to use such code from your new | |
8903 scripts. | |
8904 | |
8905 *except-syntax-err* | |
8906 Syntax errors in the exception handling commands are never caught by any of | |
8907 the ":catch" commands of the try conditional they belong to. Its finally | |
8908 clauses, however, is executed. | |
8909 Example: > | |
8910 | |
8911 :try | |
8912 : try | |
8913 : throw 4711 | |
8914 : catch /\(/ | |
8915 : echo "in catch with syntax error" | |
8916 : catch | |
8917 : echo "inner catch-all" | |
8918 : finally | |
8919 : echo "inner finally" | |
8920 : endtry | |
8921 :catch | |
8922 : echo 'outer catch-all caught "' . v:exception . '"' | |
8923 : finally | |
8924 : echo "outer finally" | |
8925 :endtry | |
8926 | |
8927 This displays: > | |
8928 inner finally | |
8929 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
8930 outer finally | |
8931 The original exception is discarded and an error exception is raised, instead. | |
8932 | |
8933 *except-single-line* | |
8934 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
8935 a single line, but then syntax errors may make it difficult to recognize the | |
8936 "catch" line, thus you better avoid this. | |
8937 Example: > | |
8938 :try | unlet! foo # | catch | endtry | |
8939 raises an error exception for the trailing characters after the ":unlet!" | |
8940 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
8941 error exception is discarded and the "E488: Trailing characters" message gets | |
8942 displayed. | |
8943 | |
8944 *except-several-errors* | |
8945 When several errors appear in a single command, the first error message is | |
8946 usually the most specific one and therefor converted to the error exception. | |
8947 Example: > | |
8948 echo novar | |
8949 causes > | |
8950 E121: Undefined variable: novar | |
8951 E15: Invalid expression: novar | |
8952 The value of the error exception inside try conditionals is: > | |
8953 Vim(echo):E121: Undefined variable: novar | |
8954 < *except-syntax-error* | |
8955 But when a syntax error is detected after a normal error in the same command, | |
8956 the syntax error is used for the exception being thrown. | |
8957 Example: > | |
8958 unlet novar # | |
8959 causes > | |
8960 E108: No such variable: "novar" | |
8961 E488: Trailing characters | |
8962 The value of the error exception inside try conditionals is: > | |
8963 Vim(unlet):E488: Trailing characters | |
8964 This is done because the syntax error might change the execution path in a way | |
8965 not intended by the user. Example: > | |
8966 try | |
8967 try | unlet novar # | catch | echo v:exception | endtry | |
8968 catch /.*/ | |
8969 echo "outer catch:" v:exception | |
8970 endtry | |
8971 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
8972 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
8973 | |
8974 ============================================================================== | |
8975 9. Examples *eval-examples* | |
8976 | |
1156 | 8977 Printing in Binary ~ |
7 | 8978 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8979 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 8980 :func Nr2Bin(nr) |
7 | 8981 : let n = a:nr |
8982 : let r = "" | |
8983 : while n | |
1156 | 8984 : let r = '01'[n % 2] . r |
8985 : let n = n / 2 | |
7 | 8986 : endwhile |
8987 : return r | |
8988 :endfunc | |
8989 | |
1156 | 8990 :" The function String2Bin() converts each character in a string to a |
8991 :" binary string, separated with dashes. | |
8992 :func String2Bin(str) | |
7 | 8993 : let out = '' |
1156 | 8994 : for ix in range(strlen(a:str)) |
8995 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
8996 : endfor | |
8997 : return out[1:] | |
7 | 8998 :endfunc |
8999 | |
9000 Example of its use: > | |
1156 | 9001 :echo Nr2Bin(32) |
9002 result: "100000" > | |
9003 :echo String2Bin("32") | |
9004 result: "110011-110010" | |
9005 | |
9006 | |
9007 Sorting lines ~ | |
9008 | |
9009 This example sorts lines with a specific compare function. > | |
9010 | |
9011 :func SortBuffer() | |
9012 : let lines = getline(1, '$') | |
9013 : call sort(lines, function("Strcmp")) | |
9014 : call setline(1, lines) | |
7 | 9015 :endfunction |
9016 | |
1156 | 9017 As a one-liner: > |
9018 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
9019 | |
9020 | |
9021 scanf() replacement ~ | |
7 | 9022 *sscanf* |
9023 There is no sscanf() function in Vim. If you need to extract parts from a | |
9024 line, you can use matchstr() and substitute() to do it. This example shows | |
9025 how to get the file name, line number and column number out of a line like | |
9026 "foobar.txt, 123, 45". > | |
9027 :" Set up the match bit | |
9028 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
9029 :"get the part matching the whole expression | |
9030 :let l = matchstr(line, mx) | |
9031 :"get each item out of the match | |
9032 :let file = substitute(l, mx, '\1', '') | |
9033 :let lnum = substitute(l, mx, '\2', '') | |
9034 :let col = substitute(l, mx, '\3', '') | |
9035 | |
9036 The input is in the variable "line", the results in the variables "file", | |
9037 "lnum" and "col". (idea from Michael Geddes) | |
9038 | |
1156 | 9039 |
9040 getting the scriptnames in a Dictionary ~ | |
9041 *scriptnames-dictionary* | |
9042 The |:scriptnames| command can be used to get a list of all script files that | |
9043 have been sourced. There is no equivalent function or variable for this | |
9044 (because it's rarely needed). In case you need to manipulate the list this | |
9045 code can be used: > | |
9046 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
9047 let scriptnames_output = '' | |
9048 redir => scriptnames_output | |
9049 silent scriptnames | |
9050 redir END | |
9051 | |
1621 | 9052 " Split the output into lines and parse each line. Add an entry to the |
1156 | 9053 " "scripts" dictionary. |
9054 let scripts = {} | |
9055 for line in split(scriptnames_output, "\n") | |
9056 " Only do non-blank lines. | |
9057 if line =~ '\S' | |
9058 " Get the first number in the line. | |
1621 | 9059 let nr = matchstr(line, '\d\+') |
1156 | 9060 " Get the file name, remove the script number " 123: ". |
1621 | 9061 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 9062 " Add an item to the Dictionary |
1621 | 9063 let scripts[nr] = name |
1156 | 9064 endif |
9065 endfor | |
9066 unlet scriptnames_output | |
9067 | |
7 | 9068 ============================================================================== |
9069 10. No +eval feature *no-eval-feature* | |
9070 | |
9071 When the |+eval| feature was disabled at compile time, none of the expression | |
9072 evaluation commands are available. To prevent this from causing Vim scripts | |
9073 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
9074 recognized, though the argument of the ":if" and everything between the ":if" | |
9075 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
9076 only if the commands are at the start of the line. The ":else" command is not | |
9077 recognized. | |
9078 | |
9079 Example of how to avoid executing commands when the |+eval| feature is | |
9080 missing: > | |
9081 | |
9082 :if 1 | |
9083 : echo "Expression evaluation is compiled in" | |
9084 :else | |
9085 : echo "You will _never_ see this message" | |
9086 :endif | |
9087 | |
9088 ============================================================================== | |
9089 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
9090 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9091 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
|
9092 '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
|
9093 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
|
9094 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
|
9095 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 9096 The sandbox is also used for the |:sandbox| command. |
7 | 9097 |
9098 These items are not allowed in the sandbox: | |
9099 - changing the buffer text | |
9100 - defining or changing mapping, autocommands, functions, user commands | |
9101 - setting certain options (see |option-summary|) | |
1156 | 9102 - setting certain v: variables (see |v:var|) *E794* |
7 | 9103 - executing a shell command |
9104 - reading or writing a file | |
9105 - jumping to another buffer or editing a file | |
625 | 9106 - executing Python, Perl, etc. commands |
29 | 9107 This is not guaranteed 100% secure, but it should block most attacks. |
9108 | |
9109 *:san* *:sandbox* | |
401 | 9110 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 9111 option that may have been set from a modeline, e.g. |
9112 'foldexpr'. | |
9113 | |
634 | 9114 *sandbox-option* |
9115 A few options contain an expression. When this expression is evaluated it may | |
790 | 9116 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 9117 restrictive, thus this only happens when the option was set from an insecure |
9118 location. Insecure in this context are: | |
843 | 9119 - sourcing a .vimrc or .exrc in the current directory |
634 | 9120 - while executing in the sandbox |
9121 - value coming from a modeline | |
9122 | |
9123 Note that when in the sandbox and saving an option value and restoring it, the | |
9124 option will still be marked as it was set in the sandbox. | |
9125 | |
9126 ============================================================================== | |
9127 12. Textlock *textlock* | |
9128 | |
9129 In a few situations it is not allowed to change the text in the buffer, jump | |
9130 to another window and some other things that might confuse or break what Vim | |
9131 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 9132 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 9133 happen any moment the mouse cursor is resting at some position. |
9134 | |
9135 This is not allowed when the textlock is active: | |
9136 - changing the buffer text | |
9137 - jumping to another buffer or window | |
9138 - editing another file | |
9139 - closing a window or quitting Vim | |
9140 - etc. | |
9141 | |
7 | 9142 |
9143 vim:tw=78:ts=8:ft=help:norl: |