Mercurial > vim
annotate runtime/doc/eval.txt @ 7651:c7575b07de98 v7.4.1125
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Jan 17 21:15:58 2016 +0100
patch 7.4.1125
Problem: There is no perleval().
Solution: Add perleval(). (Damien)
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 17 Jan 2016 21:30:04 +0100 |
parents | befbed72da87 |
children | d4370fef0175 |
rev | line source |
---|---|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Jan 17 |
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 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
922 Watch out for confusion between a namespace and a variable followed by a colon |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
923 for a sublist: > |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
924 mylist[n:] " uses variable n |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
925 mylist[s:] " uses namespace s:, error! |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
926 |
685 | 927 |
928 expr8.name entry in a |Dictionary| *expr-entry* | |
929 | |
930 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
931 name will be used as a key in the |Dictionary|. This is just like: | |
932 expr8[name]. | |
99 | 933 |
934 The name must consist of alphanumeric characters, just like a variable name, | |
935 but it may start with a number. Curly braces cannot be used. | |
936 | |
937 There must not be white space before or after the dot. | |
938 | |
939 Examples: > | |
940 :let dict = {"one": 1, 2: "two"} | |
941 :echo dict.one | |
942 :echo dict .2 | |
943 | |
944 Note that the dot is also used for String concatenation. To avoid confusion | |
945 always put spaces around the dot for String concatenation. | |
946 | |
947 | |
685 | 948 expr8(expr1, ...) |Funcref| function call |
102 | 949 |
950 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
951 | |
952 | |
953 | |
954 *expr9* | |
7 | 955 number |
956 ------ | |
3224 | 957 number number constant *expr-number* |
958 *hex-number* *octal-number* | |
7 | 959 |
960 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
961 | |
1621 | 962 *floating-point-format* |
963 Floating point numbers can be written in two forms: | |
964 | |
965 [-+]{N}.{M} | |
6530 | 966 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 967 |
968 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
969 contain digits. | |
970 [-+] means there is an optional plus or minus sign. | |
971 {exp} is the exponent, power of 10. | |
972 Only a decimal point is accepted, not a comma. No matter what the current | |
973 locale is. | |
974 {only when compiled with the |+float| feature} | |
975 | |
976 Examples: | |
977 123.456 | |
978 +0.0001 | |
979 55.0 | |
980 -0.123 | |
981 1.234e03 | |
982 1.0E-6 | |
983 -3.1416e+88 | |
984 | |
985 These are INVALID: | |
986 3. empty {M} | |
987 1e40 missing .{M} | |
988 | |
1698 | 989 *float-pi* *float-e* |
990 A few useful values to copy&paste: > | |
991 :let pi = 3.14159265359 | |
992 :let e = 2.71828182846 | |
993 | |
1621 | 994 Rationale: |
995 Before floating point was introduced, the text "123.456" was interpreted as | |
996 the two numbers "123" and "456", both converted to a string and concatenated, | |
997 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 998 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 999 incompatibility was accepted in favor of being able to use the normal notation |
1000 for floating point numbers. | |
1001 | |
1002 *floating-point-precision* | |
1003 The precision and range of floating points numbers depends on what "double" | |
1004 means in the library Vim was compiled with. There is no way to change this at | |
1005 runtime. | |
1006 | |
1007 The default for displaying a |Float| is to use 6 decimal places, like using | |
1008 printf("%g", f). You can select something else when using the |printf()| | |
1009 function. Example: > | |
1010 :echo printf('%.15e', atan(1)) | |
1011 < 7.853981633974483e-01 | |
1012 | |
1013 | |
7 | 1014 |
6884 | 1015 string *string* *String* *expr-string* *E114* |
7 | 1016 ------ |
1017 "string" string constant *expr-quote* | |
1018 | |
1019 Note that double quotes are used. | |
1020 | |
1021 A string constant accepts these special characters: | |
1022 \... three-digit octal number (e.g., "\316") | |
1023 \.. two-digit octal number (must be followed by non-digit) | |
1024 \. one-digit octal number (must be followed by non-digit) | |
1025 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1026 \x. byte specified with one hex number (must be followed by non-hex char) | |
1027 \X.. same as \x.. | |
1028 \X. same as \x. | |
1621 | 1029 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1030 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1031 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1032 \b backspace <BS> |
1033 \e escape <Esc> | |
1034 \f formfeed <FF> | |
1035 \n newline <NL> | |
1036 \r return <CR> | |
1037 \t tab <Tab> | |
1038 \\ backslash | |
1039 \" double quote | |
2152 | 1040 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1041 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1042 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1043 |
1156 | 1044 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1045 encodings. Use "\u00ff" to store character 255 according to the current value | |
1046 of 'encoding'. | |
1047 | |
7 | 1048 Note that "\000" and "\x00" force the end of the string. |
1049 | |
1050 | |
1051 literal-string *literal-string* *E115* | |
1052 --------------- | |
26 | 1053 'string' string constant *expr-'* |
7 | 1054 |
1055 Note that single quotes are used. | |
1056 | |
1621 | 1057 This string is taken as it is. No backslashes are removed or have a special |
99 | 1058 meaning. The only exception is that two quotes stand for one quote. |
26 | 1059 |
1060 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1061 to be doubled. These two commands are equivalent: > |
26 | 1062 if a =~ "\\s*" |
1063 if a =~ '\s*' | |
7 | 1064 |
1065 | |
1066 option *expr-option* *E112* *E113* | |
1067 ------ | |
1068 &option option value, local value if possible | |
1069 &g:option global option value | |
1070 &l:option local option value | |
1071 | |
1072 Examples: > | |
1073 echo "tabstop is " . &tabstop | |
1074 if &insertmode | |
1075 | |
1076 Any option name can be used here. See |options|. When using the local value | |
1077 and there is no buffer-local or window-local value, the global value is used | |
1078 anyway. | |
1079 | |
1080 | |
1156 | 1081 register *expr-register* *@r* |
7 | 1082 -------- |
1083 @r contents of register 'r' | |
1084 | |
1085 The result is the contents of the named register, as a single string. | |
1086 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1087 register use @" or @@. See |registers| for an explanation of the available |
336 | 1088 registers. |
1089 | |
1090 When using the '=' register you get the expression itself, not what it | |
1091 evaluates to. Use |eval()| to evaluate it. | |
7 | 1092 |
1093 | |
1094 nesting *expr-nesting* *E110* | |
1095 ------- | |
1096 (expr1) nested expression | |
1097 | |
1098 | |
1099 environment variable *expr-env* | |
1100 -------------------- | |
1101 $VAR environment variable | |
1102 | |
1103 The String value of any environment variable. When it is not defined, the | |
1104 result is an empty string. | |
1105 *expr-env-expand* | |
1106 Note that there is a difference between using $VAR directly and using | |
1107 expand("$VAR"). Using it directly will only expand environment variables that | |
1108 are known inside the current Vim session. Using expand() will first try using | |
1109 the environment variables known inside the current Vim session. If that | |
1110 fails, a shell will be used to expand the variable. This can be slow, but it | |
1111 does expand all variables that the shell knows about. Example: > | |
6180 | 1112 :echo $shell |
1113 :echo expand("$shell") | |
1114 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1115 variable (if your shell supports it). |
1116 | |
1117 | |
1118 internal variable *expr-variable* | |
1119 ----------------- | |
1120 variable internal variable | |
1121 See below |internal-variables|. | |
1122 | |
1123 | |
170 | 1124 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1125 ------------- |
1126 function(expr1, ...) function call | |
1127 See below |functions|. | |
1128 | |
1129 | |
1130 ============================================================================== | |
2596 | 1131 3. Internal variable *internal-variables* *E461* |
1132 | |
7 | 1133 An internal variable name can be made up of letters, digits and '_'. But it |
1134 cannot start with a digit. It's also possible to use curly braces, see | |
1135 |curly-braces-names|. | |
1136 | |
1137 An internal variable is created with the ":let" command |:let|. | |
87 | 1138 An internal variable is explicitly destroyed with the ":unlet" command |
1139 |:unlet|. | |
1140 Using a name that is not an internal variable or refers to a variable that has | |
1141 been destroyed results in an error. | |
7 | 1142 |
1143 There are several name spaces for variables. Which one is to be used is | |
1144 specified by what is prepended: | |
1145 | |
1146 (nothing) In a function: local to a function; otherwise: global | |
1147 |buffer-variable| b: Local to the current buffer. | |
1148 |window-variable| w: Local to the current window. | |
819 | 1149 |tabpage-variable| t: Local to the current tab page. |
7 | 1150 |global-variable| g: Global. |
1151 |local-variable| l: Local to a function. | |
1152 |script-variable| s: Local to a |:source|'ed Vim script. | |
1153 |function-argument| a: Function argument (only inside a function). | |
5815 | 1154 |vim-variable| v: Global, predefined by Vim. |
7 | 1155 |
685 | 1156 The scope name by itself can be used as a |Dictionary|. For example, to |
1157 delete all script-local variables: > | |
133 | 1158 :for k in keys(s:) |
1159 : unlet s:[k] | |
1160 :endfor | |
1161 < | |
4358 | 1162 *buffer-variable* *b:var* *b:* |
7 | 1163 A variable name that is preceded with "b:" is local to the current buffer. |
1164 Thus you can have several "b:foo" variables, one for each buffer. | |
1165 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1166 |:bdelete|. | |
1167 | |
1168 One local buffer variable is predefined: | |
4264 | 1169 *b:changedtick* *changetick* |
7 | 1170 b:changedtick The total number of changes to the current buffer. It is |
1171 incremented for each change. An undo command is also a change | |
1172 in this case. This can be used to perform an action only when | |
1173 the buffer has changed. Example: > | |
1174 :if my_changedtick != b:changedtick | |
1621 | 1175 : let my_changedtick = b:changedtick |
1176 : call My_Update() | |
7 | 1177 :endif |
1178 < | |
4358 | 1179 *window-variable* *w:var* *w:* |
7 | 1180 A variable name that is preceded with "w:" is local to the current window. It |
1181 is deleted when the window is closed. | |
1182 | |
4437 | 1183 *tabpage-variable* *t:var* *t:* |
819 | 1184 A variable name that is preceded with "t:" is local to the current tab page, |
1185 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
|
1186 without the |+windows| feature} |
819 | 1187 |
4358 | 1188 *global-variable* *g:var* *g:* |
7 | 1189 Inside functions global variables are accessed with "g:". Omitting this will |
1621 | 1190 access a variable local to a function. But "g:" can also be used in any other |
7 | 1191 place if you like. |
1192 | |
4358 | 1193 *local-variable* *l:var* *l:* |
7 | 1194 Inside functions local variables are accessed without prepending anything. |
1156 | 1195 But you can also prepend "l:" if you like. However, without prepending "l:" |
1196 you may run into reserved variable names. For example "count". By itself it | |
1197 refers to "v:count". Using "l:count" you can have a local variable with the | |
1198 same name. | |
7 | 1199 |
1200 *script-variable* *s:var* | |
1201 In a Vim script variables starting with "s:" can be used. They cannot be | |
1202 accessed from outside of the scripts, thus are local to the script. | |
1203 | |
1204 They can be used in: | |
1205 - commands executed while the script is sourced | |
1206 - functions defined in the script | |
1207 - autocommands defined in the script | |
1208 - functions and autocommands defined in functions and autocommands which were | |
1209 defined in the script (recursively) | |
1210 - user defined commands defined in the script | |
1211 Thus not in: | |
1212 - other scripts sourced from this one | |
1213 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1214 - menus |
7 | 1215 - etc. |
1216 | |
1156 | 1217 Script variables can be used to avoid conflicts with global variable names. |
1218 Take this example: > | |
7 | 1219 |
1220 let s:counter = 0 | |
1221 function MyCounter() | |
1222 let s:counter = s:counter + 1 | |
1223 echo s:counter | |
1224 endfunction | |
1225 command Tick call MyCounter() | |
1226 | |
1227 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1228 that script will not be changed, only the "s:counter" in the script where | |
1229 "Tick" was defined is used. | |
1230 | |
1231 Another example that does the same: > | |
1232 | |
1233 let s:counter = 0 | |
1234 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1235 | |
1236 When calling a function and invoking a user-defined command, the context for | |
9 | 1237 script variables is set to the script where the function or command was |
7 | 1238 defined. |
1239 | |
1240 The script variables are also available when a function is defined inside a | |
1241 function that is defined in a script. Example: > | |
1242 | |
1243 let s:counter = 0 | |
1244 function StartCounting(incr) | |
1245 if a:incr | |
1246 function MyCounter() | |
1247 let s:counter = s:counter + 1 | |
1248 endfunction | |
1249 else | |
1250 function MyCounter() | |
1251 let s:counter = s:counter - 1 | |
1252 endfunction | |
1253 endif | |
1254 endfunction | |
1255 | |
1256 This defines the MyCounter() function either for counting up or counting down | |
1257 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1258 called, the s:counter variable will be accessible in MyCounter(). | |
1259 | |
1260 When the same script is sourced again it will use the same script variables. | |
1261 They will remain valid as long as Vim is running. This can be used to | |
1262 maintain a counter: > | |
1263 | |
1264 if !exists("s:counter") | |
1265 let s:counter = 1 | |
1266 echo "script executed for the first time" | |
1267 else | |
1268 let s:counter = s:counter + 1 | |
1269 echo "script executed " . s:counter . " times now" | |
1270 endif | |
1271 | |
1272 Note that this means that filetype plugins don't get a different set of script | |
1273 variables for each buffer. Use local buffer variables instead |b:var|. | |
1274 | |
1275 | |
4358 | 1276 Predefined Vim variables: *vim-variable* *v:var* *v:* |
7 | 1277 |
189 | 1278 *v:beval_col* *beval_col-variable* |
1279 v:beval_col The number of the column, over which the mouse pointer is. | |
1280 This is the byte index in the |v:beval_lnum| line. | |
1281 Only valid while evaluating the 'balloonexpr' option. | |
1282 | |
1283 *v:beval_bufnr* *beval_bufnr-variable* | |
1284 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1285 valid while evaluating the 'balloonexpr' option. | |
1286 | |
1287 *v:beval_lnum* *beval_lnum-variable* | |
1288 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1289 valid while evaluating the 'balloonexpr' option. | |
1290 | |
1291 *v:beval_text* *beval_text-variable* | |
374 | 1292 v:beval_text The text under or after the mouse pointer. Usually a word as |
1293 it is useful for debugging a C program. 'iskeyword' applies, | |
1294 but a dot and "->" before the position is included. When on a | |
1295 ']' the text before it is used, including the matching '[' and | |
189 | 1296 word before it. When on a Visual area within one line the |
1297 highlighted text is used. | |
1298 Only valid while evaluating the 'balloonexpr' option. | |
1299 | |
1300 *v:beval_winnr* *beval_winnr-variable* | |
1301 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1302 valid while evaluating the 'balloonexpr' option. The first |
1303 window has number zero (unlike most other places where a | |
1304 window gets a number). | |
189 | 1305 |
844 | 1306 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1307 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
|
1308 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
|
1309 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1310 |
7 | 1311 *v:charconvert_from* *charconvert_from-variable* |
1312 v:charconvert_from | |
1313 The name of the character encoding of a file to be converted. | |
1314 Only valid while evaluating the 'charconvert' option. | |
1315 | |
1316 *v:charconvert_to* *charconvert_to-variable* | |
1317 v:charconvert_to | |
1318 The name of the character encoding of a file after conversion. | |
1319 Only valid while evaluating the 'charconvert' option. | |
1320 | |
1321 *v:cmdarg* *cmdarg-variable* | |
1322 v:cmdarg This variable is used for two purposes: | |
1323 1. The extra arguments given to a file read/write command. | |
1324 Currently these are "++enc=" and "++ff=". This variable is | |
1325 set before an autocommand event for a file read/write | |
1326 command is triggered. There is a leading space to make it | |
1327 possible to append this variable directly after the | |
1621 | 1328 read/write command. Note: The "+cmd" argument isn't |
7 | 1329 included here, because it will be executed anyway. |
1330 2. When printing a PostScript file with ":hardcopy" this is | |
1331 the argument for the ":hardcopy" command. This can be used | |
1332 in 'printexpr'. | |
1333 | |
1334 *v:cmdbang* *cmdbang-variable* | |
1335 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1336 was used the value is 1, otherwise it is 0. Note that this | |
1337 can only be used in autocommands. For user commands |<bang>| | |
1338 can be used. | |
1339 | |
6909 | 1340 *v:completed_item* *completed_item-variable* |
1341 v:completed_item | |
1342 |Dictionary| containing the |complete-items| for the most | |
1343 recently completed word after |CompleteDone|. The | |
1344 |Dictionary| is empty if the completion failed. | |
1345 | |
7 | 1346 *v:count* *count-variable* |
1347 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1348 to get the count before a mapping. Read-only. Example: > |
7 | 1349 :map _x :<C-U>echo "the count is " . v:count<CR> |
1350 < Note: The <C-U> is required to remove the line range that you | |
1351 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1352 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1353 just like what happens in the command, "d6w" for the example. |
667 | 1354 Also used for evaluating the 'formatexpr' option. |
7 | 1355 "count" also works, for backwards compatibility. |
1356 | |
1357 *v:count1* *count1-variable* | |
1358 v:count1 Just like "v:count", but defaults to one when no count is | |
1359 used. | |
1360 | |
1361 *v:ctype* *ctype-variable* | |
1362 v:ctype The current locale setting for characters of the runtime | |
1363 environment. This allows Vim scripts to be aware of the | |
1364 current locale encoding. Technical: it's the value of | |
1365 LC_CTYPE. When not using a locale the value is "C". | |
1366 This variable can not be set directly, use the |:language| | |
1367 command. | |
1368 See |multi-lang|. | |
1369 | |
1370 *v:dying* *dying-variable* | |
1621 | 1371 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1372 one. When multiple signals are caught the number increases. |
1373 Can be used in an autocommand to check if Vim didn't | |
1374 terminate normally. {only works on Unix} | |
1375 Example: > | |
1376 :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
|
1377 < 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
|
1378 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
|
1379 |
7 | 1380 *v:errmsg* *errmsg-variable* |
1381 v:errmsg Last given error message. It's allowed to set this variable. | |
1382 Example: > | |
1383 :let v:errmsg = "" | |
1384 :silent! next | |
1385 :if v:errmsg != "" | |
1386 : ... handle error | |
1387 < "errmsg" also works, for backwards compatibility. | |
1388 | |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1389 *v:errors* *errors-variable* |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1390 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
|
1391 This is a list of strings. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1392 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
|
1393 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
|
1394 :let v:errors = [] |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1395 < 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
|
1396 list by the assert function. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1397 |
7 | 1398 *v:exception* *exception-variable* |
1399 v:exception The value of the exception most recently caught and not | |
1400 finished. See also |v:throwpoint| and |throw-variables|. | |
1401 Example: > | |
1402 :try | |
1403 : throw "oops" | |
1404 :catch /.*/ | |
1405 : echo "caught" v:exception | |
1406 :endtry | |
1407 < Output: "caught oops". | |
1408 | |
179 | 1409 *v:fcs_reason* *fcs_reason-variable* |
1410 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1411 Can be used in an autocommand to decide what to do and/or what | |
1412 to set v:fcs_choice to. Possible values: | |
1413 deleted file no longer exists | |
1414 conflict file contents, mode or timestamp was | |
1415 changed and buffer is modified | |
1416 changed file contents has changed | |
1417 mode mode of file changed | |
1418 time only file timestamp changed | |
1419 | |
1420 *v:fcs_choice* *fcs_choice-variable* | |
1421 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1422 triggered. Can be used in an autocommand to tell Vim what to | |
1423 do with the affected buffer: | |
1424 reload Reload the buffer (does not work if | |
1425 the file was deleted). | |
1426 ask Ask the user what to do, as if there | |
1427 was no autocommand. Except that when | |
1428 only the timestamp changed nothing | |
1429 will happen. | |
1430 <empty> Nothing, the autocommand should do | |
1431 everything that needs to be done. | |
1432 The default is empty. If another (invalid) value is used then | |
1433 Vim behaves like it is empty, there is no warning message. | |
1434 | |
7 | 1435 *v:fname_in* *fname_in-variable* |
579 | 1436 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1437 option used for ~ |
1438 'charconvert' file to be converted | |
1439 'diffexpr' original file | |
1440 'patchexpr' original file | |
1441 'printexpr' file to be printed | |
593 | 1442 And set to the swap file name for |SwapExists|. |
7 | 1443 |
1444 *v:fname_out* *fname_out-variable* | |
1445 v:fname_out The name of the output file. Only valid while | |
1446 evaluating: | |
1447 option used for ~ | |
1448 'charconvert' resulting converted file (*) | |
1449 'diffexpr' output of diff | |
1450 'patchexpr' resulting patched file | |
1451 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1452 file") it will be equal to v:fname_in. When doing conversion |
7 | 1453 for a read command (e.g., ":e file") it will be a temporary |
1454 file and different from v:fname_in. | |
1455 | |
1456 *v:fname_new* *fname_new-variable* | |
1457 v:fname_new The name of the new version of the file. Only valid while | |
1458 evaluating 'diffexpr'. | |
1459 | |
1460 *v:fname_diff* *fname_diff-variable* | |
1461 v:fname_diff The name of the diff (patch) file. Only valid while | |
1462 evaluating 'patchexpr'. | |
1463 | |
1464 *v:folddashes* *folddashes-variable* | |
1465 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1466 fold. | |
29 | 1467 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1468 |
1469 *v:foldlevel* *foldlevel-variable* | |
1470 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1471 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1472 |
1473 *v:foldend* *foldend-variable* | |
1474 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1475 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1476 |
1477 *v:foldstart* *foldstart-variable* | |
1478 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1479 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1480 |
5460 | 1481 *v:hlsearch* *hlsearch-variable* |
6413 | 1482 v:hlsearch Variable that indicates whether search highlighting is on. |
1483 Setting it makes sense only if 'hlsearch' is enabled which | |
1484 requires |+extra_search|. Setting this variable to zero acts | |
1485 the like |:nohlsearch| command, setting it to one acts like > | |
5460 | 1486 let &hlsearch = &hlsearch |
6918 | 1487 < Note that the value is restored when returning from a |
1488 function. |function-search-undo|. | |
1489 | |
11 | 1490 *v:insertmode* *insertmode-variable* |
1491 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1492 events. Values: | |
1493 i Insert mode | |
1494 r Replace mode | |
1495 v Virtual Replace mode | |
1496 | |
102 | 1497 *v:key* *key-variable* |
685 | 1498 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1499 evaluating the expression used with |map()| and |filter()|. |
1500 Read-only. | |
1501 | |
7 | 1502 *v:lang* *lang-variable* |
1503 v:lang The current locale setting for messages of the runtime | |
1504 environment. This allows Vim scripts to be aware of the | |
1505 current language. Technical: it's the value of LC_MESSAGES. | |
1506 The value is system dependent. | |
1507 This variable can not be set directly, use the |:language| | |
1508 command. | |
1509 It can be different from |v:ctype| when messages are desired | |
1510 in a different language than what is used for character | |
1511 encoding. See |multi-lang|. | |
1512 | |
1513 *v:lc_time* *lc_time-variable* | |
1514 v:lc_time The current locale setting for time messages of the runtime | |
1515 environment. This allows Vim scripts to be aware of the | |
1516 current language. Technical: it's the value of LC_TIME. | |
1517 This variable can not be set directly, use the |:language| | |
1518 command. See |multi-lang|. | |
1519 | |
1520 *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
|
1521 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
|
1522 '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
|
1523 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
|
1524 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
|
1525 |sandbox|. |
7 | 1526 |
1029 | 1527 *v:mouse_win* *mouse_win-variable* |
1528 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1529 First window has number 1, like with |winnr()|. The value is | |
1530 zero when there was no mouse button click. | |
1531 | |
1532 *v:mouse_lnum* *mouse_lnum-variable* | |
1533 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1534 This is the text line number, not the screen line number. The | |
1535 value is zero when there was no mouse button click. | |
1536 | |
1537 *v:mouse_col* *mouse_col-variable* | |
1538 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1539 This is the screen column number, like with |virtcol()|. The | |
1540 value is zero when there was no mouse button click. | |
1541 | |
1733 | 1542 *v:oldfiles* *oldfiles-variable* |
1543 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1544 startup. These are the files that Vim remembers marks for. | |
1545 The length of the List is limited by the ' argument of the | |
1546 'viminfo' option (default is 100). | |
5618 | 1547 When the |viminfo| file is not used the List is empty. |
1733 | 1548 Also see |:oldfiles| and |c_#<|. |
1549 The List can be modified, but this has no effect on what is | |
1550 stored in the |viminfo| file later. If you use values other | |
1551 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
|
1552 {only when compiled with the |+viminfo| feature} |
1733 | 1553 |
6935 | 1554 *v:option_new* |
1555 v:option_new New value of the option. Valid while executing an |OptionSet| | |
1556 autocommand. | |
1557 *v:option_old* | |
1558 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
1559 autocommand. | |
1560 *v:option_type* | |
1561 v:option_type Scope of the set command. Valid while executing an | |
1562 |OptionSet| autocommand. Can be either "global" or "local" | |
1490 | 1563 *v:operator* *operator-variable* |
1564 v:operator The last operator given in Normal mode. This is a single | |
1565 character except for commands starting with <g> or <z>, | |
1566 in which case it is two characters. Best used alongside | |
1567 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1568 Operator-pending mode and then use the operator, e.g.: > | |
1569 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1570 < The value remains set until another operator is entered, thus | |
1571 don't expect it to be empty. | |
1572 v:operator is not set for |:delete|, |:yank| or other Ex | |
1573 commands. | |
1574 Read-only. | |
1575 | |
7 | 1576 *v:prevcount* *prevcount-variable* |
1577 v:prevcount The count given for the last but one Normal mode command. | |
1578 This is the v:count value of the previous command. Useful if | |
1490 | 1579 you want to cancel Visual or Operator-pending mode and then |
1580 use the count, e.g.: > | |
7 | 1581 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1582 < Read-only. | |
1583 | |
170 | 1584 *v:profiling* *profiling-variable* |
1621 | 1585 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1586 See |profiling|. |
1587 | |
7 | 1588 *v:progname* *progname-variable* |
1589 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 1590 invoked. Allows you to do special initialisations for |view|, |
1591 |evim| etc., or any other name you might symlink to Vim. | |
7 | 1592 Read-only. |
1593 | |
5780 | 1594 *v:progpath* *progpath-variable* |
1595 v:progpath Contains the command with which Vim was invoked, including the | |
1596 path. Useful if you want to message a Vim server using a | |
1597 |--remote-expr|. | |
5782 | 1598 To get the full path use: > |
1599 echo exepath(v:progpath) | |
1600 < NOTE: This does not work when the command is a relative path | |
1601 and the current directory has changed. | |
5780 | 1602 Read-only. |
1603 | |
7 | 1604 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1605 v:register The name of the register in effect for the current normal mode |
3492 | 1606 command (regardless of whether that command actually used a |
1607 register). Or for the currently executing normal mode mapping | |
1608 (use this in custom commands that take a register). | |
1609 If none is supplied it is the default register '"', unless | |
1610 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
1611 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1612 Also see |getreg()| and |setreg()| |
7 | 1613 |
540 | 1614 *v:scrollstart* *scrollstart-variable* |
1615 v:scrollstart String describing the script or function that caused the | |
1616 screen to scroll up. It's only set when it is empty, thus the | |
1617 first reason is remembered. It is set to "Unknown" for a | |
1618 typed command. | |
1619 This can be used to find out why your script causes the | |
1620 hit-enter prompt. | |
1621 | |
7 | 1622 *v:servername* *servername-variable* |
1623 v:servername The resulting registered |x11-clientserver| name if any. | |
1624 Read-only. | |
1625 | |
1621 | 1626 |
1627 v:searchforward *v:searchforward* *searchforward-variable* | |
1628 Search direction: 1 after a forward search, 0 after a | |
1629 backward search. It is reset to forward when directly setting | |
1630 the last search pattern, see |quote/|. | |
1631 Note that the value is restored when returning from a | |
1632 function. |function-search-undo|. | |
1633 Read-write. | |
1634 | |
7 | 1635 *v:shell_error* *shell_error-variable* |
1636 v:shell_error Result of the last shell command. When non-zero, the last | |
1637 shell command had an error. When zero, there was no problem. | |
1638 This only works when the shell returns the error code to Vim. | |
1639 The value -1 is often used when the command could not be | |
1640 executed. Read-only. | |
1641 Example: > | |
1642 :!mv foo bar | |
1643 :if v:shell_error | |
1644 : echo 'could not rename "foo" to "bar"!' | |
1645 :endif | |
1646 < "shell_error" also works, for backwards compatibility. | |
1647 | |
1648 *v:statusmsg* *statusmsg-variable* | |
1649 v:statusmsg Last given status message. It's allowed to set this variable. | |
1650 | |
579 | 1651 *v:swapname* *swapname-variable* |
1652 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1653 the swap file found. Read-only. | |
1654 | |
1655 *v:swapchoice* *swapchoice-variable* | |
1656 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1657 for handling an existing swap file: | |
1658 'o' Open read-only | |
1659 'e' Edit anyway | |
1660 'r' Recover | |
1661 'd' Delete swapfile | |
1662 'q' Quit | |
1663 'a' Abort | |
1621 | 1664 The value should be a single-character string. An empty value |
579 | 1665 results in the user being asked, as would happen when there is |
1666 no SwapExists autocommand. The default is empty. | |
1667 | |
590 | 1668 *v:swapcommand* *swapcommand-variable* |
625 | 1669 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1670 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1671 another Vim open the file and jump to the right place. For |
590 | 1672 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1673 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1674 |
7 | 1675 *v:termresponse* *termresponse-variable* |
1676 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1677 termcap entry. It is set when Vim receives an escape sequence |
7 | 1678 that starts with ESC [ or CSI and ends in a 'c', with only |
1679 digits, ';' and '.' in between. | |
1680 When this option is set, the TermResponse autocommand event is | |
1681 fired, so that you can react to the response from the | |
1682 terminal. | |
1683 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1684 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1685 patch level (since this was introduced in patch 95, it's | |
1686 always 95 or bigger). Pc is always zero. | |
1687 {only when compiled with |+termresponse| feature} | |
1688 | |
1689 *v:this_session* *this_session-variable* | |
1690 v:this_session Full filename of the last loaded or saved session file. See | |
1691 |:mksession|. It is allowed to set this variable. When no | |
1692 session file has been saved, this variable is empty. | |
1693 "this_session" also works, for backwards compatibility. | |
1694 | |
1695 *v:throwpoint* *throwpoint-variable* | |
1696 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1697 finished was thrown. Not set when commands are typed. See |
7 | 1698 also |v:exception| and |throw-variables|. |
1699 Example: > | |
1700 :try | |
1701 : throw "oops" | |
1702 :catch /.*/ | |
1703 : echo "Exception from" v:throwpoint | |
1704 :endtry | |
1705 < Output: "Exception from test.vim, line 2" | |
1706 | |
102 | 1707 *v:val* *val-variable* |
1621 | 1708 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1709 valid while evaluating the expression used with |map()| and |
102 | 1710 |filter()|. Read-only. |
1711 | |
7 | 1712 *v:version* *version-variable* |
1713 v:version Version number of Vim: Major version number times 100 plus | |
1714 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1715 is 501. Read-only. "version" also works, for backwards | |
1716 compatibility. | |
1717 Use |has()| to check if a certain patch was included, e.g.: > | |
5786 | 1718 if has("patch-7.4.123") |
7 | 1719 < Note that patch numbers are specific to the version, thus both |
1720 version 5.0 and 5.1 may have a patch 123, but these are | |
1721 completely different. | |
1722 | |
1723 *v:warningmsg* *warningmsg-variable* | |
1724 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1725 | |
2609 | 1726 *v:windowid* *windowid-variable* |
1727 v:windowid When any X11 based GUI is running or when running in a | |
1728 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1729 set to the window ID. |
1730 When an MS-Windows GUI is running this will be set to the | |
1731 window handle. | |
1732 Otherwise the value is zero. | |
1733 Note: for windows inside Vim use |winnr()|. | |
2609 | 1734 |
7 | 1735 ============================================================================== |
1736 4. Builtin Functions *functions* | |
1737 | |
1738 See |function-list| for a list grouped by what the function is used for. | |
1739 | |
236 | 1740 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1741 |
1742 USAGE RESULT DESCRIPTION ~ | |
1743 | |
1621 | 1744 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
|
1745 acos( {expr}) Float arc cosine of {expr} |
685 | 1746 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
|
1747 alloc_fail( {id}, {countdown}, {repeat}) |
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1748 none make memory allocation fail |
3214 | 1749 and( {expr}, {expr}) Number bitwise AND |
55 | 1750 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1751 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1752 argc() Number number of files in the argument list |
55 | 1753 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
|
1754 arglistid( [{winnr} [, {tabnr}]]) |
5942 | 1755 Number argument list id |
7 | 1756 argv( {nr}) String {nr} entry of the argument list |
818 | 1757 argv( ) List the argument list |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1758 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
|
1759 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
|
1760 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
|
1761 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
|
1762 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
|
1763 asin( {expr}) Float arc sine of {expr} |
1621 | 1764 atan( {expr}) Float arc tangent of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1765 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
7 | 1766 browse( {save}, {title}, {initdir}, {default}) |
1767 String put up a file requester | |
1621 | 1768 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1769 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1770 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1771 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1772 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
|
1773 bufnr( {expr} [, {create}]) Number Number of the buffer {expr} |
7 | 1774 bufwinnr( {expr}) Number window number of buffer {expr} |
1775 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1776 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
5413 | 1777 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1778 call( {func}, {arglist} [, {dict}]) |
1779 any call {func} with arguments {arglist} | |
1621 | 1780 ceil( {expr}) Float round {expr} up |
1781 changenr() Number current change number | |
4051 | 1782 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
55 | 1783 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1784 clearmatches() none clear all matches |
7 | 1785 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1786 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1787 complete_add( {expr}) Number add completion match |
1621 | 1788 complete_check() Number check for key typed during completion |
7 | 1789 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1790 Number number of choice picked by user | |
55 | 1791 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1792 cos( {expr}) Float cosine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1793 cosh( {expr}) Float hyperbolic cosine of {expr} |
6259 | 1794 count( {list}, {expr} [, {ic} [, {start}]]) |
95 | 1795 Number count how many {expr} are in {list} |
7 | 1796 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1797 Number checks existence of cscope connection | |
6385 | 1798 cursor( {lnum}, {col} [, {off}]) |
1799 Number move cursor to {lnum}, {col}, {off} | |
703 | 1800 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
|
1801 deepcopy( {expr} [, {noref}]) any make a full copy of {expr} |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1802 delete( {fname} [, {flags}]) Number delete the file or directory {fname} |
7 | 1803 did_filetype() Number TRUE if FileType autocommand event used |
55 | 1804 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1805 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
85 | 1806 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1807 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1808 eval( {string}) any evaluate {string} into its value |
55 | 1809 eventhandler( ) Number TRUE if inside an event handler |
7 | 1810 executable( {expr}) Number 1 if executable {expr} exists |
5782 | 1811 exepath( {expr}) String full path of the command {expr} |
7 | 1812 exists( {expr}) Number TRUE if {expr} exists |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1813 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1814 List/Dict insert items of {expr2} into {expr1} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1815 exp( {expr}) Float exponential of {expr} |
3398 | 1816 expand( {expr} [, {nosuf} [, {list}]]) |
1817 any expand special keywords in {expr} | |
1621 | 1818 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1819 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1820 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1821 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1822 {string} is 0 | |
95 | 1823 finddir( {name}[, {path}[, {count}]]) |
824 | 1824 String find directory {name} in {path} |
19 | 1825 findfile( {name}[, {path}[, {count}]]) |
824 | 1826 String find file {name} in {path} |
1621 | 1827 float2nr( {expr}) Number convert Float {expr} to a Number |
1828 floor( {expr}) Float round {expr} down | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1829 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
1586 | 1830 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1831 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1832 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1833 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1834 foldlevel( {lnum}) Number fold level at {lnum} |
55 | 1835 foldtext( ) String line displayed for closed fold |
824 | 1836 foldtextresult( {lnum}) String text for closed fold at {lnum} |
7 | 1837 foreground( ) Number bring the Vim window to the foreground |
55 | 1838 function( {name}) Funcref reference to function {name} |
3224 | 1839 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
82 | 1840 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1841 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1842 getbufline( {expr}, {lnum} [, {end}]) |
1843 List lines {lnum} to {end} of buffer {expr} | |
4157 | 1844 getbufvar( {expr}, {varname} [, {def}]) |
1845 any variable {varname} in buffer {expr} | |
55 | 1846 getchar( [expr]) Number get one character from the user |
1847 getcharmod( ) Number modifiers for the last typed character | |
7013 | 1848 getcharsearch() Dict last character search |
7 | 1849 getcmdline() String return the current command-line |
1850 getcmdpos() Number return cursor position in command-line | |
6153 | 1851 getcmdtype() String return current command-line type |
1852 getcmdwintype() String return current command-line window type | |
5944 | 1853 getcurpos() List position of the cursor |
7 | 1854 getcwd() String the current working directory |
5944 | 1855 getfontname( [{name}]) String name of font being used |
20 | 1856 getfperm( {fname}) String file permissions of file {fname} |
1857 getfsize( {fname}) Number size in bytes of file {fname} | |
7 | 1858 getftime( {fname}) Number last modification time of file |
20 | 1859 getftype( {fname}) String description of type of file {fname} |
161 | 1860 getline( {lnum}) String line {lnum} of current buffer |
1861 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
|
1862 getloclist( {nr}) List list of location list items |
1326 | 1863 getmatches() List list of current matches |
1548 | 1864 getpid() Number process ID of Vim |
703 | 1865 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1866 getqflist() List list of quickfix items |
5796 | 1867 getreg( [{regname} [, 1 [, {list}]]]) |
1868 String or List contents of register | |
55 | 1869 getregtype( [{regname}]) String type of register |
4157 | 1870 gettabvar( {nr}, {varname} [, {def}]) |
1871 any variable {varname} in tab {nr} or {def} | |
1872 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
831 | 1873 any {name} in {winnr} in tab page {tabnr} |
7 | 1874 getwinposx() Number X coord in pixels of GUI Vim window |
1875 getwinposy() Number Y coord in pixels of GUI Vim window | |
4157 | 1876 getwinvar( {nr}, {varname} [, {def}]) |
1877 any variable {varname} in window {nr} | |
6663 | 1878 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
3398 | 1879 any expand file wildcards in {expr} |
6697 | 1880 glob2regpat( {expr}) String convert a glob pat into a search pat |
6663 | 1881 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
1754 | 1882 String do glob({expr}) for all dirs in {path} |
7 | 1883 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1884 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
1104 | 1885 haslocaldir() Number TRUE if current window executed |:lcd| |
782 | 1886 hasmapto( {what} [, {mode} [, {abbr}]]) |
1887 Number TRUE if mapping to {what} exists | |
7 | 1888 histadd( {history},{item}) String add an item to a history |
1889 histdel( {history} [, {item}]) String remove an item from a history | |
1890 histget( {history} [, {index}]) String get the item {index} from a history | |
1891 histnr( {history}) Number highest index of a history | |
1892 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1893 hlID( {name}) Number syntax ID of highlight group {name} | |
1894 hostname() String name of the machine Vim is running on | |
55 | 1895 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1896 indent( {lnum}) Number indent of line {lnum} | |
95 | 1897 index( {list}, {expr} [, {start} [, {ic}]]) |
1898 Number index in {list} where {expr} appears | |
531 | 1899 input( {prompt} [, {text} [, {completion}]]) |
1900 String get input from the user | |
7 | 1901 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1902 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1903 inputrestore() Number restore typeahead |
1904 inputsave() Number save and clear typeahead | |
7 | 1905 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1906 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
3214 | 1907 invert( {expr}) Number bitwise invert |
7 | 1908 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1909 islocked( {expr}) Number TRUE if {expr} is locked |
685 | 1910 items( {dict}) List key-value pairs in {dict} |
95 | 1911 join( {list} [, {sep}]) String join {list} items into one String |
685 | 1912 keys( {dict}) List keys in {dict} |
55 | 1913 len( {expr}) Number the length of {expr} |
1914 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1915 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1916 line( {expr}) Number line nr of cursor, last line or mark | |
1917 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1918 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1919 localtime() Number current time |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1920 log( {expr}) Float natural logarithm (base e) of {expr} |
1621 | 1921 log10( {expr}) Float logarithm of Float {expr} to base 10 |
3492 | 1922 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
102 | 1923 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
2610 | 1924 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 1925 String or Dict |
1926 rhs of mapping {name} in mode {mode} | |
782 | 1927 mapcheck( {name}[, {mode} [, {abbr}]]) |
1928 String check for mappings matching {name} | |
19 | 1929 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1930 Number position where {pat} matches in {expr} |
1326 | 1931 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
1932 Number highlight {pattern} with {group} | |
5979 | 1933 matchaddpos( {group}, {list}[, {priority}[, {id}]]) |
1934 Number highlight positions with {group} | |
819 | 1935 matcharg( {nr}) List arguments of |:match| |
1326 | 1936 matchdelete( {id}) Number delete match identified by {id} |
19 | 1937 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 1938 Number position where {pat} ends in {expr} |
158 | 1939 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
1940 List match and submatches of {pat} in {expr} | |
19 | 1941 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
1942 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1943 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1944 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1945 mkdir( {name} [, {path} [, {prot}]]) |
168 | 1946 Number create directory {name} |
1621 | 1947 mode( [expr]) String current editing mode |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1948 mzeval( {expr}) any evaluate |MzScheme| expression |
7 | 1949 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
4051 | 1950 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
3214 | 1951 or( {expr}, {expr}) Number bitwise OR |
819 | 1952 pathshorten( {expr}) String shorten directory names in a path |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
1953 perleval( {expr}) any evaluate |Perl| expression |
1621 | 1954 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 1955 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 1956 printf( {fmt}, {expr1}...) String format text |
1957 pumvisible() Number whether popup menu is visible | |
3682 | 1958 pyeval( {expr}) any evaluate |Python| expression |
1959 py3eval( {expr}) any evaluate |python3| expression | |
99 | 1960 range( {expr} [, {max} [, {stride}]]) |
1961 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1962 readfile( {fname} [, {binary} [, {max}]]) |
168 | 1963 List get list of lines from file {fname} |
794 | 1964 reltime( [{start} [, {end}]]) List get time value |
1965 reltimestr( {time}) String turn time value into a String | |
7 | 1966 remote_expr( {server}, {string} [, {idvar}]) |
1967 String send expression | |
1968 remote_foreground( {server}) Number bring Vim server to the foreground | |
1969 remote_peek( {serverid} [, {retvar}]) | |
1970 Number check for reply string | |
1971 remote_read( {serverid}) String read reply string | |
1972 remote_send( {server}, {string} [, {idvar}]) | |
1973 String send key sequence | |
79 | 1974 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 1975 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 1976 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
1977 repeat( {expr}, {count}) String repeat {expr} {count} times | |
1978 resolve( {filename}) String get filename a shortcut points to | |
82 | 1979 reverse( {list}) List reverse {list} in-place |
1621 | 1980 round( {expr}) Float round off {expr} |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1981 screenattr( {row}, {col}) Number attribute at screen position |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1982 screenchar( {row}, {col}) Number character at screen position |
3986 | 1983 screencol() Number current cursor column |
1984 screenrow() Number current cursor row | |
1496 | 1985 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1986 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1987 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 1988 Number search for variable declaration |
1496 | 1989 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 1990 Number search for other end of start/end pair |
1496 | 1991 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 1992 List search for other end of start/end pair |
1496 | 1993 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 1994 List search for {pattern} |
7 | 1995 server2client( {clientid}, {string}) |
1996 Number send reply string | |
1997 serverlist() String get a list of available servers | |
1998 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
6991 | 1999 setcharsearch( {dict}) Dict set character search from {dict} |
7 | 2000 setcmdpos( {pos}) Number set cursor position in command-line |
2001 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
647 | 2002 setloclist( {nr}, {list}[, {action}]) |
2003 Number modify location list using {list} | |
1326 | 2004 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2005 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 2006 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 2007 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
|
2008 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
831 | 2009 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
2010 {winnr} in tab page {tabnr} to {val} | |
7 | 2011 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
4126 | 2012 sha256( {string}) String SHA256 checksum of {string} |
1661 | 2013 shellescape( {string} [, {special}]) |
2014 String escape {string} for use as shell | |
985 | 2015 command argument |
3875 | 2016 shiftwidth() Number effective value of 'shiftwidth' |
55 | 2017 simplify( {filename}) String simplify filename as much as possible |
1621 | 2018 sin( {expr}) Float sine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2019 sinh( {expr}) Float hyperbolic sine of {expr} |
2902 | 2020 sort( {list} [, {func} [, {dict}]]) |
2021 List sort {list}, using {func} to compare | |
374 | 2022 soundfold( {word}) String sound-fold {word} |
344 | 2023 spellbadword() String badly spelled word at cursor |
537 | 2024 spellsuggest( {word} [, {max} [, {capital}]]) |
2025 List spelling suggestions | |
282 | 2026 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 2027 List make |List| from {pat} separated {expr} |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2028 sqrt( {expr}) Float square root of {expr} |
1621 | 2029 str2float( {expr}) Float convert String to Float |
2030 str2nr( {expr} [, {base}]) Number convert String to Number | |
6870 | 2031 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
2032 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
7 | 2033 strftime( {format}[, {time}]) String time in specified format |
133 | 2034 stridx( {haystack}, {needle}[, {start}]) |
2035 Number index of {needle} in {haystack} | |
95 | 2036 string( {expr}) String String representation of {expr} value |
7 | 2037 strlen( {expr}) Number length of the String {expr} |
2038 strpart( {src}, {start}[, {len}]) | |
2039 String {len} characters of {src} at {start} | |
140 | 2040 strridx( {haystack}, {needle} [, {start}]) |
2041 Number last index of {needle} in {haystack} | |
7 | 2042 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
|
2043 strwidth( {expr}) Number display cell length of the String {expr} |
5794 | 2044 submatch( {nr}[, {list}]) String or List |
2045 specific match in ":s" or substitute() | |
7 | 2046 substitute( {expr}, {pat}, {sub}, {flags}) |
2047 String all {pat} in {expr} replaced with {sub} | |
32 | 2048 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 2049 synIDattr( {synID}, {what} [, {mode}]) |
2050 String attribute {what} of syntax ID {synID} | |
2051 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2052 synconcealed( {lnum}, {col}) List info about concealing |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2053 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 2054 system( {expr} [, {input}]) String output of shell command/filter {expr} |
5808 | 2055 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
677 | 2056 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
2057 tabpagenr( [{arg}]) Number number of current or last tab page | |
2058 tabpagewinnr( {tabarg}[, {arg}]) | |
2059 Number number of current window in tab page | |
2060 taglist( {expr}) List list of tags matching {expr} | |
1621 | 2061 tagfiles() List tags files used |
7 | 2062 tempname() String name for a temporary file |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2063 tan( {expr}) Float tangent of {expr} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2064 tanh( {expr}) Float hyperbolic tangent of {expr} |
7 | 2065 tolower( {expr}) String the String {expr} switched to lowercase |
2066 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 2067 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
2068 to chars in {tostr} | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2069 trunc( {expr}) Float truncate Float {expr} |
7 | 2070 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
|
2071 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
|
2072 undotree() List undo file tree |
5747 | 2073 uniq( {list} [, {func} [, {dict}]]) |
2074 List remove adjacent duplicates from a list | |
685 | 2075 values( {dict}) List values in {dict} |
7 | 2076 virtcol( {expr}) Number screen column of cursor or mark |
2077 visualmode( [expr]) String last visual mode used | |
4151 | 2078 wildmenumode() Number whether 'wildmenu' mode is active |
7 | 2079 winbufnr( {nr}) Number buffer number of window {nr} |
2080 wincol() Number window column of the cursor | |
2081 winheight( {nr}) Number height of window {nr} | |
2082 winline() Number window line of the cursor | |
674 | 2083 winnr( [{expr}]) Number number of current window |
55 | 2084 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2085 winrestview( {dict}) none restore view of current window |
712 | 2086 winsaveview() Dict save view of current window |
7 | 2087 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
|
2088 wordcount() Dict get byte/char/word statistics |
6341 | 2089 writefile( {list}, {fname} [, {flags}]) |
158 | 2090 Number write list of lines to file {fname} |
3214 | 2091 xor( {expr}, {expr}) Number bitwise XOR |
7 | 2092 |
1621 | 2093 abs({expr}) *abs()* |
2094 Return the absolute value of {expr}. When {expr} evaluates to | |
2095 a |Float| abs() returns a |Float|. When {expr} can be | |
2096 converted to a |Number| abs() returns a |Number|. Otherwise | |
2097 abs() gives an error message and returns -1. | |
2098 Examples: > | |
2099 echo abs(1.456) | |
2100 < 1.456 > | |
2101 echo abs(-5.456) | |
2102 < 5.456 > | |
2103 echo abs(-4) | |
2104 < 4 | |
2105 {only available when compiled with the |+float| feature} | |
2106 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2107 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2108 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2109 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
|
2110 |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
|
2111 {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
|
2112 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2113 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2114 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2115 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2116 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2117 < 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
|
2118 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2119 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2120 |
82 | 2121 add({list}, {expr}) *add()* |
685 | 2122 Append the item {expr} to |List| {list}. Returns the |
2123 resulting |List|. Examples: > | |
82 | 2124 :let alist = add([1, 2, 3], item) |
2125 :call add(mylist, "woodstock") | |
685 | 2126 < Note that when {expr} is a |List| it is appended as a single |
692 | 2127 item. Use |extend()| to concatenate |Lists|. |
85 | 2128 Use |insert()| to add an item at another position. |
55 | 2129 |
82 | 2130 |
7513
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2131 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
|
2132 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
|
2133 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
|
2134 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
|
2135 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
|
2136 |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2137 |
3214 | 2138 and({expr}, {expr}) *and()* |
2139 Bitwise AND on the two arguments. The arguments are converted | |
2140 to a number. A List, Dict or Float argument causes an error. | |
2141 Example: > | |
2142 :let flag = and(bits, 0x80) | |
2143 | |
2144 | |
82 | 2145 append({lnum}, {expr}) *append()* |
685 | 2146 When {expr} is a |List|: Append each item of the |List| as a |
2147 text line below line {lnum} in the current buffer. | |
153 | 2148 Otherwise append {expr} as one text line below line {lnum} in |
2149 the current buffer. | |
2150 {lnum} can be zero to insert a line before the first one. | |
82 | 2151 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2152 0 for success. Example: > |
55 | 2153 :let failed = append(line('$'), "# THE END") |
82 | 2154 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2155 < |
7 | 2156 *argc()* |
2157 argc() The result is the number of files in the argument list of the | |
2158 current window. See |arglist|. | |
2159 | |
2160 *argidx()* | |
2161 argidx() The result is the current index in the argument list. 0 is | |
2162 the first file. argc() - 1 is the last one. See |arglist|. | |
2163 | |
5942 | 2164 *arglistid()* |
2165 arglistid([{winnr}, [ {tabnr} ]]) | |
2166 Return the argument list ID. This is a number which | |
2167 identifies the argument list being used. Zero is used for the | |
6153 | 2168 global argument list. See |arglist|. |
2169 Return -1 if the arguments are invalid. | |
5942 | 2170 |
2171 Without arguments use the current window. | |
2172 With {winnr} only use this window in the current tab page. | |
2173 With {winnr} and {tabnr} use the window in the specified tab | |
2174 page. | |
2175 | |
7 | 2176 *argv()* |
818 | 2177 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2178 current window. See |arglist|. "argv(0)" is the first one. |
2179 Example: > | |
2180 :let i = 0 | |
2181 :while i < argc() | |
1621 | 2182 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2183 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2184 : let i = i + 1 | |
2185 :endwhile | |
818 | 2186 < Without the {nr} argument a |List| with the whole |arglist| is |
2187 returned. | |
2188 | |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2189 *assert_equal()* |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2190 assert_equal({expected}, {actual} [, {msg}]) |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2191 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
|
2192 added to |v:errors|. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2193 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
|
2194 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
|
2195 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
|
2196 always matters. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2197 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
|
2198 {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
|
2199 Example: > |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2200 assert_equal('foo', 'bar') |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2201 < 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
|
2202 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
|
2203 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2204 assert_exception({error} [, {msg}]) *assert_exception()* |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2205 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
|
2206 message is added to |v:errors|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2207 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
|
2208 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
|
2209 with translations: > |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2210 try |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2211 commandthatfails |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2212 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
|
2213 catch |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2214 call assert_exception('E492:') |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2215 endtry |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2216 |
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2217 assert_fails({cmd} [, {error}]) *assert_fails()* |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2218 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
|
2219 NOT produce an error. |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2220 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
|
2221 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2222 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
|
2223 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
|
2224 |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
|
2225 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
|
2226 number the assert fails. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2227 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
|
2228 got {actual}" is produced. |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2229 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2230 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
|
2231 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
|
2232 |v:errors|, like with |assert_equal()|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2233 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
|
2234 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
|
2235 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
|
2236 got {actual}" is produced. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2237 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2238 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2239 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
|
2240 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
|
2241 {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
|
2242 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2243 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2244 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2245 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2246 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2247 < -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
|
2248 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2249 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2250 |
1621 | 2251 atan({expr}) *atan()* |
2252 Return the principal value of the arc tangent of {expr}, in | |
2253 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2254 {expr} must evaluate to a |Float| or a |Number|. | |
2255 Examples: > | |
2256 :echo atan(100) | |
2257 < 1.560797 > | |
2258 :echo atan(-4.01) | |
2259 < -1.326405 | |
2260 {only available when compiled with the |+float| feature} | |
2261 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2262 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2263 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2264 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
|
2265 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
|
2266 {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
|
2267 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2268 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2269 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2270 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2271 < 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
|
2272 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2273 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2274 |
7 | 2275 *browse()* |
2276 browse({save}, {title}, {initdir}, {default}) | |
2277 Put up a file requester. This only works when "has("browse")" | |
2278 returns non-zero (only in some GUI versions). | |
2279 The input fields are: | |
2280 {save} when non-zero, select file to write | |
2281 {title} title for the requester | |
2282 {initdir} directory to start browsing in | |
2283 {default} default file name | |
2284 When the "Cancel" button is hit, something went wrong, or | |
2285 browsing is not possible, an empty string is returned. | |
2286 | |
29 | 2287 *browsedir()* |
2288 browsedir({title}, {initdir}) | |
2289 Put up a directory requester. This only works when | |
2290 "has("browse")" returns non-zero (only in some GUI versions). | |
2291 On systems where a directory browser is not supported a file | |
2292 browser is used. In that case: select a file in the directory | |
2293 to be used. | |
2294 The input fields are: | |
2295 {title} title for the requester | |
2296 {initdir} directory to start browsing in | |
2297 When the "Cancel" button is hit, something went wrong, or | |
2298 browsing is not possible, an empty string is returned. | |
2299 | |
7 | 2300 bufexists({expr}) *bufexists()* |
2301 The result is a Number, which is non-zero if a buffer called | |
2302 {expr} exists. | |
9 | 2303 If the {expr} argument is a number, buffer numbers are used. |
7 | 2304 If the {expr} argument is a string it must match a buffer name |
9 | 2305 exactly. The name can be: |
2306 - Relative to the current directory. | |
2307 - A full path. | |
1621 | 2308 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2309 - A URL name. |
7 | 2310 Unlisted buffers will be found. |
2311 Note that help files are listed by their short name in the | |
2312 output of |:buffers|, but bufexists() requires using their | |
2313 long name to be able to find them. | |
1621 | 2314 bufexists() may report a buffer exists, but to use the name |
2315 with a |:buffer| command you may need to use |expand()|. Esp | |
2316 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2317 Use "bufexists(0)" to test for the existence of an alternate |
2318 file name. | |
2319 *buffer_exists()* | |
2320 Obsolete name: buffer_exists(). | |
2321 | |
2322 buflisted({expr}) *buflisted()* | |
2323 The result is a Number, which is non-zero if a buffer called | |
2324 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2325 The {expr} argument is used like with |bufexists()|. |
7 | 2326 |
2327 bufloaded({expr}) *bufloaded()* | |
2328 The result is a Number, which is non-zero if a buffer called | |
2329 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2330 The {expr} argument is used like with |bufexists()|. |
7 | 2331 |
2332 bufname({expr}) *bufname()* | |
2333 The result is the name of a buffer, as it is displayed by the | |
2334 ":ls" command. | |
2335 If {expr} is a Number, that buffer number's name is given. | |
2336 Number zero is the alternate buffer for the current window. | |
2337 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2338 with the buffer names. This is always done like 'magic' is |
7 | 2339 set and 'cpoptions' is empty. When there is more than one |
2340 match an empty string is returned. | |
2341 "" or "%" can be used for the current buffer, "#" for the | |
2342 alternate buffer. | |
2343 A full match is preferred, otherwise a match at the start, end | |
1156 | 2344 or middle of the buffer name is accepted. If you only want a |
2345 full match then put "^" at the start and "$" at the end of the | |
2346 pattern. | |
7 | 2347 Listed buffers are found first. If there is a single match |
2348 with a listed buffer, that one is returned. Next unlisted | |
2349 buffers are searched for. | |
2350 If the {expr} is a String, but you want to use it as a buffer | |
2351 number, force it to be a Number by adding zero to it: > | |
2352 :echo bufname("3" + 0) | |
2353 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2354 string is returned. > | |
2355 bufname("#") alternate buffer name | |
2356 bufname(3) name of buffer 3 | |
2357 bufname("%") name of current buffer | |
2358 bufname("file2") name of buffer where "file2" matches. | |
2359 < *buffer_name()* | |
2360 Obsolete name: buffer_name(). | |
2361 | |
2362 *bufnr()* | |
707 | 2363 bufnr({expr} [, {create}]) |
2364 The result is the number of a buffer, as it is displayed by | |
7 | 2365 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2366 above. |
2367 If the buffer doesn't exist, -1 is returned. Or, if the | |
2368 {create} argument is present and not zero, a new, unlisted, | |
2369 buffer is created and its number is returned. | |
7 | 2370 bufnr("$") is the last buffer: > |
2371 :let last_buffer = bufnr("$") | |
2372 < The result is a Number, which is the highest buffer number | |
2373 of existing buffers. Note that not all buffers with a smaller | |
2374 number necessarily exist, because ":bwipeout" may have removed | |
2375 them. Use bufexists() to test for the existence of a buffer. | |
2376 *buffer_number()* | |
2377 Obsolete name: buffer_number(). | |
2378 *last_buffer_nr()* | |
2379 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2380 | |
2381 bufwinnr({expr}) *bufwinnr()* | |
2382 The result is a Number, which is the number of the first | |
2383 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2384 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2385 there is no such window, -1 is returned. Example: > |
2386 | |
2387 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2388 | |
2389 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2390 |:wincmd|. | |
1156 | 2391 Only deals with the current tab page. |
7 | 2392 |
2393 | |
2394 byte2line({byte}) *byte2line()* | |
2395 Return the line number that contains the character at byte | |
2396 count {byte} in the current buffer. This includes the | |
2397 end-of-line character, depending on the 'fileformat' option | |
2398 for the current buffer. The first character has byte count | |
2399 one. | |
2400 Also see |line2byte()|, |go| and |:goto|. | |
2401 {not available when compiled without the |+byte_offset| | |
2402 feature} | |
2403 | |
18 | 2404 byteidx({expr}, {nr}) *byteidx()* |
2405 Return byte index of the {nr}'th character in the string | |
2406 {expr}. Use zero for the first character, it returns zero. | |
2407 This function is only useful when there are multibyte | |
2408 characters, otherwise the returned value is equal to {nr}. | |
5413 | 2409 Composing characters are not counted separately, their byte |
2410 length is added to the preceding base character. See | |
2411 |byteidxcomp()| below for counting composing characters | |
2412 separately. | |
18 | 2413 Example : > |
2414 echo matchstr(str, ".", byteidx(str, 3)) | |
2415 < will display the fourth character. Another way to do the | |
2416 same: > | |
2417 let s = strpart(str, byteidx(str, 3)) | |
2418 echo strpart(s, 0, byteidx(s, 1)) | |
2419 < If there are less than {nr} characters -1 is returned. | |
2420 If there are exactly {nr} characters the length of the string | |
5413 | 2421 in bytes is returned. |
2422 | |
2423 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
2424 Like byteidx(), except that a composing character is counted | |
2425 as a separate character. Example: > | |
2426 let s = 'e' . nr2char(0x301) | |
2427 echo byteidx(s, 1) | |
2428 echo byteidxcomp(s, 1) | |
2429 echo byteidxcomp(s, 2) | |
2430 < The first and third echo result in 3 ('e' plus composing | |
2431 character is 3 bytes), the second echo results in 1 ('e' is | |
2432 one byte). | |
2433 Only works different from byteidx() when 'encoding' is set to | |
2434 a Unicode encoding. | |
18 | 2435 |
102 | 2436 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2437 Call function {func} with the items in |List| {arglist} as |
79 | 2438 arguments. |
685 | 2439 {func} can either be a |Funcref| or the name of a function. |
79 | 2440 a:firstline and a:lastline are set to the cursor line. |
2441 Returns the return value of the called function. | |
102 | 2442 {dict} is for functions with the "dict" attribute. It will be |
2443 used to set the local variable "self". |Dictionary-function| | |
79 | 2444 |
1621 | 2445 ceil({expr}) *ceil()* |
2446 Return the smallest integral value greater than or equal to | |
2447 {expr} as a |Float| (round up). | |
2448 {expr} must evaluate to a |Float| or a |Number|. | |
2449 Examples: > | |
2450 echo ceil(1.456) | |
2451 < 2.0 > | |
2452 echo ceil(-5.456) | |
2453 < -5.0 > | |
2454 echo ceil(4.0) | |
2455 < 4.0 | |
2456 {only available when compiled with the |+float| feature} | |
2457 | |
777 | 2458 changenr() *changenr()* |
2459 Return the number of the most recent change. This is the same | |
2460 number as what is displayed with |:undolist| and can be used | |
2461 with the |:undo| command. | |
2462 When a change was made it is the number of that change. After | |
2463 redo it is the number of the redone change. After undo it is | |
2464 one less than the number of the undone change. | |
2465 | |
4051 | 2466 char2nr({expr}[, {utf8}]) *char2nr()* |
7 | 2467 Return number value of the first char in {expr}. Examples: > |
2468 char2nr(" ") returns 32 | |
2469 char2nr("ABC") returns 65 | |
4051 | 2470 < When {utf8} is omitted or zero, the current 'encoding' is used. |
2471 Example for "utf-8": > | |
1156 | 2472 char2nr("á") returns 225 |
2473 char2nr("á"[0]) returns 195 | |
4051 | 2474 < With {utf8} set to 1, always treat as utf-8 characters. |
2475 A combining character is a separate character. | |
2965 | 2476 |nr2char()| does the opposite. |
7 | 2477 |
2478 cindent({lnum}) *cindent()* | |
2479 Get the amount of indent for line {lnum} according the C | |
2480 indenting rules, as with 'cindent'. | |
2481 The indent is counted in spaces, the value of 'tabstop' is | |
2482 relevant. {lnum} is used just like in |getline()|. | |
2483 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2484 feature, -1 is returned. | |
548 | 2485 See |C-indenting|. |
7 | 2486 |
1326 | 2487 clearmatches() *clearmatches()* |
2488 Clears all matches previously defined by |matchadd()| and the | |
2489 |:match| commands. | |
2490 | |
7 | 2491 *col()* |
24 | 2492 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2493 position given with {expr}. The accepted positions are: |
2494 . the cursor position | |
2495 $ the end of the cursor line (the result is the | |
3513 | 2496 number of bytes in the cursor line plus one) |
7 | 2497 'x position of mark x (if the mark is not set, 0 is |
2498 returned) | |
6447 | 2499 v In Visual mode: the start of the Visual area (the |
2500 cursor is the end). When not in Visual mode | |
2501 returns the cursor position. Differs from |'<| in | |
2502 that it's updated right away. | |
1317 | 2503 Additionally {expr} can be [lnum, col]: a |List| with the line |
2504 and column number. Most useful when the column is "$", to get | |
1621 | 2505 the last column of a specific line. When "lnum" or "col" is |
1317 | 2506 out of range then col() returns zero. |
1156 | 2507 To get the line number use |line()|. To get both use |
703 | 2508 |getpos()|. |
7 | 2509 For the screen column position use |virtcol()|. |
2510 Note that only marks in the current file can be used. | |
2511 Examples: > | |
2512 col(".") column of cursor | |
2513 col("$") length of cursor line plus one | |
2514 col("'t") column of mark t | |
2515 col("'" . markname) column of mark markname | |
1621 | 2516 < The first column is 1. 0 is returned for an error. |
1156 | 2517 For an uppercase mark the column may actually be in another |
2518 buffer. | |
7 | 2519 For the cursor position, when 'virtualedit' is active, the |
2520 column is one higher if the cursor is after the end of the | |
2521 line. This can be used to obtain the column in Insert mode: > | |
2522 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2523 \<C-O>:set ve=all<CR> | |
2524 \<C-O>:echo col(".") . "\n" <Bar> | |
2525 \let &ve = save_ve<CR> | |
2526 < | |
464 | 2527 |
724 | 2528 complete({startcol}, {matches}) *complete()* *E785* |
2529 Set the matches for Insert mode completion. | |
2530 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2531 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2532 with an expression mapping. | |
724 | 2533 {startcol} is the byte offset in the line where the completed |
2534 text start. The text up to the cursor is the original text | |
2535 that will be replaced by the matches. Use col('.') for an | |
2536 empty string. "col('.') - 1" will replace one character by a | |
2537 match. | |
2538 {matches} must be a |List|. Each |List| item is one match. | |
2539 See |complete-items| for the kind of items that are possible. | |
2540 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
|
2541 inserting anything that would cause completion to stop. |
724 | 2542 The match can be selected with CTRL-N and CTRL-P as usual with |
2543 Insert mode completion. The popup menu will appear if | |
2544 specified, see |ins-completion-menu|. | |
2545 Example: > | |
1156 | 2546 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2547 |
2548 func! ListMonths() | |
2549 call complete(col('.'), ['January', 'February', 'March', | |
2550 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2551 \ 'October', 'November', 'December']) | |
2552 return '' | |
2553 endfunc | |
2554 < This isn't very useful, but it shows how it works. Note that | |
2555 an empty string is returned to avoid a zero being inserted. | |
2556 | |
464 | 2557 complete_add({expr}) *complete_add()* |
2558 Add {expr} to the list of matches. Only to be used by the | |
2559 function specified with the 'completefunc' option. | |
2560 Returns 0 for failure (empty string or out of memory), | |
2561 1 when the match was added, 2 when the match was already in | |
2562 the list. | |
1621 | 2563 See |complete-functions| for an explanation of {expr}. It is |
786 | 2564 the same as one item in the list that 'omnifunc' would return. |
464 | 2565 |
2566 complete_check() *complete_check()* | |
2567 Check for a key typed while looking for completion matches. | |
2568 This is to be used when looking for matches takes some time. | |
2569 Returns non-zero when searching for matches is to be aborted, | |
2570 zero otherwise. | |
2571 Only to be used by the function specified with the | |
2572 'completefunc' option. | |
2573 | |
7 | 2574 *confirm()* |
2575 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2576 Confirm() offers the user a dialog, from which a choice can be | |
2577 made. It returns the number of the choice. For the first | |
2578 choice this is 1. | |
2579 Note: confirm() is only supported when compiled with dialog | |
2580 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
|
2581 |
7 | 2582 {msg} is displayed in a |dialog| with {choices} as the |
2583 alternatives. When {choices} is missing or empty, "&OK" is | |
2584 used (and translated). | |
2585 {msg} is a String, use '\n' to include a newline. Only on | |
2586 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
|
2587 |
7 | 2588 {choices} is a String, with the individual choices separated |
2589 by '\n', e.g. > | |
2590 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2591 < The letter after the '&' is the shortcut key for that choice. | |
2592 Thus you can type 'c' to select "Cancel". The shortcut does | |
2593 not need to be the first letter: > | |
2594 confirm("file has been modified", "&Save\nSave &All") | |
2595 < For the console, the first letter of each choice is used as | |
2596 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
|
2597 |
7 | 2598 The optional {default} argument is the number of the choice |
2599 that is made if the user hits <CR>. Use 1 to make the first | |
2600 choice the default one. Use 0 to not set a default. If | |
2601 {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
|
2602 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2603 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
|
2604 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
|
2605 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
|
2606 "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
|
2607 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
|
2608 |
7 | 2609 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2610 or another valid interrupt key, confirm() returns 0. | |
2611 | |
2612 An example: > | |
2613 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2614 :if choice == 0 | |
2615 : echo "make up your mind!" | |
2616 :elseif choice == 3 | |
2617 : echo "tasteful" | |
2618 :else | |
2619 : echo "I prefer bananas myself." | |
2620 :endif | |
2621 < In a GUI dialog, buttons are used. The layout of the buttons | |
2622 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2623 the buttons are always put vertically. Otherwise, confirm() |
7 | 2624 tries to put the buttons in one horizontal line. If they |
2625 don't fit, a vertical layout is used anyway. For some systems | |
2626 the horizontal layout is always used. | |
2627 | |
55 | 2628 *copy()* |
1621 | 2629 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2630 different from using {expr} directly. |
685 | 2631 When {expr} is a |List| a shallow copy is created. This means |
2632 that the original |List| can be changed without changing the | |
1621 | 2633 copy, and vice versa. But the items are identical, thus |
2634 changing an item changes the contents of both |Lists|. Also | |
685 | 2635 see |deepcopy()|. |
55 | 2636 |
1621 | 2637 cos({expr}) *cos()* |
2638 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2639 {expr} must evaluate to a |Float| or a |Number|. | |
2640 Examples: > | |
2641 :echo cos(100) | |
2642 < 0.862319 > | |
2643 :echo cos(-4.01) | |
2644 < -0.646043 | |
2645 {only available when compiled with the |+float| feature} | |
2646 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2647 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2648 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2649 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
|
2650 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2651 {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
|
2652 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2653 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2654 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2655 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2656 < -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
|
2657 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2658 |
1621 | 2659 |
102 | 2660 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2661 Return the number of times an item with value {expr} appears |
685 | 2662 in |List| or |Dictionary| {comp}. |
102 | 2663 If {start} is given then start with the item with this index. |
685 | 2664 {start} can only be used with a |List|. |
79 | 2665 When {ic} is given and it's non-zero then case is ignored. |
2666 | |
2667 | |
7 | 2668 *cscope_connection()* |
2669 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2670 Checks for the existence of a |cscope| connection. If no | |
2671 parameters are specified, then the function returns: | |
2672 0, if cscope was not available (not compiled in), or | |
2673 if there are no cscope connections; | |
2674 1, if there is at least one cscope connection. | |
2675 | |
2676 If parameters are specified, then the value of {num} | |
2677 determines how existence of a cscope connection is checked: | |
2678 | |
2679 {num} Description of existence check | |
2680 ----- ------------------------------ | |
2681 0 Same as no parameters (e.g., "cscope_connection()"). | |
2682 1 Ignore {prepend}, and use partial string matches for | |
2683 {dbpath}. | |
2684 2 Ignore {prepend}, and use exact string matches for | |
2685 {dbpath}. | |
2686 3 Use {prepend}, use partial string matches for both | |
2687 {dbpath} and {prepend}. | |
2688 4 Use {prepend}, use exact string matches for both | |
2689 {dbpath} and {prepend}. | |
2690 | |
2691 Note: All string comparisons are case sensitive! | |
2692 | |
2693 Examples. Suppose we had the following (from ":cs show"): > | |
2694 | |
2695 # pid database name prepend path | |
2696 0 27664 cscope.out /usr/local | |
2697 < | |
2698 Invocation Return Val ~ | |
2699 ---------- ---------- > | |
2700 cscope_connection() 1 | |
2701 cscope_connection(1, "out") 1 | |
2702 cscope_connection(2, "out") 0 | |
2703 cscope_connection(3, "out") 0 | |
2704 cscope_connection(3, "out", "local") 1 | |
2705 cscope_connection(4, "out") 0 | |
2706 cscope_connection(4, "out", "local") 0 | |
2707 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2708 < | |
703 | 2709 cursor({lnum}, {col} [, {off}]) *cursor()* |
2710 cursor({list}) | |
1156 | 2711 Positions the cursor at the column (byte count) {col} in the |
2712 line {lnum}. The first column is one. | |
5938 | 2713 |
703 | 2714 When there is one argument {list} this is used as a |List| |
5938 | 2715 with two, three or four item: |
2716 [{lnum}, {col}, {off}] | |
2717 [{lnum}, {col}, {off}, {curswant}] | |
6009 | 2718 This is like the return value of |getpos()| or |getcurpos()|, |
5944 | 2719 but without the first item. |
5938 | 2720 |
7 | 2721 Does not change the jumplist. |
2722 If {lnum} is greater than the number of lines in the buffer, | |
2723 the cursor will be positioned at the last line in the buffer. | |
2724 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 2725 If {col} is greater than the number of bytes in the line, |
7 | 2726 the cursor will be positioned at the last character in the |
2727 line. | |
2728 If {col} is zero, the cursor will stay in the current column. | |
5944 | 2729 If {curswant} is given it is used to set the preferred column |
6180 | 2730 for vertical movement. Otherwise {col} is used. |
6385 | 2731 |
703 | 2732 When 'virtualedit' is used {off} specifies the offset in |
2733 screen columns from the start of the character. E.g., a | |
1266 | 2734 position within a <Tab> or after the last character. |
1851 | 2735 Returns 0 when the position could be set, -1 otherwise. |
7 | 2736 |
55 | 2737 |
164 | 2738 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 2739 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2740 different from using {expr} directly. |
685 | 2741 When {expr} is a |List| a full copy is created. This means |
2742 that the original |List| can be changed without changing the | |
1621 | 2743 copy, and vice versa. When an item is a |List|, a copy for it |
55 | 2744 is made, recursively. Thus changing an item in the copy does |
685 | 2745 not change the contents of the original |List|. |
2746 When {noref} is omitted or zero a contained |List| or | |
2747 |Dictionary| is only copied once. All references point to | |
2748 this single copy. With {noref} set to 1 every occurrence of a | |
2749 |List| or |Dictionary| results in a new copy. This also means | |
2750 that a cyclic reference causes deepcopy() to fail. | |
114 | 2751 *E724* |
2752 Nesting is possible up to 100 levels. When there is an item | |
164 | 2753 that refers back to a higher level making a deep copy with |
2754 {noref} set to 1 will fail. | |
55 | 2755 Also see |copy()|. |
2756 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2757 delete({fname} [, {flags}]) *delete()* |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2758 Without {flags} or with {flags} empty: Deletes the file by the |
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2759 name {fname}. This also works when {fname} is a symbolic link. |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2760 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2761 When {flags} is "d": Deletes the directory by the name |
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2762 {fname}. This fails when directory {fname} is not empty. |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2763 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2764 When {flags} is "rf": Deletes the directory by the name |
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2765 {fname} and everything in it, recursively. BE CAREFUL! |
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2766 A symbolic link itself is deleted, not what it points to. |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2767 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2768 The result is a Number, which is 0 if the delete operation was |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2769 successful and -1 when the deletion failed or partly failed. |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2770 |
685 | 2771 Use |remove()| to delete an item from a |List|. |
4229 | 2772 To delete a line from the buffer use |:delete|. Use |:exe| |
2773 when the line number is in a variable. | |
7 | 2774 |
2775 *did_filetype()* | |
2776 did_filetype() Returns non-zero when autocommands are being executed and the | |
2777 FileType event has been triggered at least once. Can be used | |
2778 to avoid triggering the FileType event again in the scripts | |
2779 that detect the file type. |FileType| | |
2780 When editing another file, the counter is reset, thus this | |
2781 really checks if the FileType event has been triggered for the | |
2782 current buffer. This allows an autocommand that starts | |
2783 editing another buffer to set 'filetype' and load a syntax | |
2784 file. | |
2785 | |
32 | 2786 diff_filler({lnum}) *diff_filler()* |
2787 Returns the number of filler lines above line {lnum}. | |
2788 These are the lines that were inserted at this point in | |
2789 another diff'ed window. These filler lines are shown in the | |
2790 display but don't exist in the buffer. | |
2791 {lnum} is used like with |getline()|. Thus "." is the current | |
2792 line, "'m" mark m, etc. | |
2793 Returns 0 if the current window is not in diff mode. | |
2794 | |
2795 diff_hlID({lnum}, {col}) *diff_hlID()* | |
2796 Returns the highlight ID for diff mode at line {lnum} column | |
2797 {col} (byte index). When the current line does not have a | |
2798 diff change zero is returned. | |
2799 {lnum} is used like with |getline()|. Thus "." is the current | |
2800 line, "'m" mark m, etc. | |
2801 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
2802 line. | |
2803 The highlight ID can be used with |synIDattr()| to obtain | |
2804 syntax information about the highlighting. | |
2805 | |
85 | 2806 empty({expr}) *empty()* |
2807 Return the Number 1 if {expr} is empty, zero otherwise. | |
685 | 2808 A |List| or |Dictionary| is empty when it does not have any |
1621 | 2809 items. A Number is empty when its value is zero. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2810 For a long |List| this is much faster than comparing the |
685 | 2811 length with zero. |
85 | 2812 |
7 | 2813 escape({string}, {chars}) *escape()* |
2814 Escape the characters in {chars} that occur in {string} with a | |
2815 backslash. Example: > | |
2816 :echo escape('c:\program files\vim', ' \') | |
2817 < results in: > | |
2818 c:\\program\ files\\vim | |
1621 | 2819 < Also see |shellescape()|. |
2820 | |
2821 *eval()* | |
95 | 2822 eval({string}) Evaluate {string} and return the result. Especially useful to |
2823 turn the result of |string()| back into the original value. | |
1621 | 2824 This works for Numbers, Floats, Strings and composites of |
2825 them. Also works for |Funcref|s that refer to existing | |
2826 functions. | |
95 | 2827 |
7 | 2828 eventhandler() *eventhandler()* |
2829 Returns 1 when inside an event handler. That is that Vim got | |
2830 interrupted while waiting for the user to type a character, | |
2831 e.g., when dropping a file on Vim. This means interactive | |
2832 commands cannot be used. Otherwise zero is returned. | |
2833 | |
2834 executable({expr}) *executable()* | |
2835 This function checks if an executable with the name {expr} | |
2836 exists. {expr} must be the name of the program without any | |
10 | 2837 arguments. |
2838 executable() uses the value of $PATH and/or the normal | |
2839 searchpath for programs. *PATHEXT* | |
2840 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
2841 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 2842 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
2843 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 2844 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 2845 the name without an extension. When 'shell' looks like a |
10 | 2846 Unix shell, then the name is also tried without adding an |
2847 extension. | |
2848 On MS-DOS and MS-Windows it only checks if the file exists and | |
2849 is not a directory, not if it's really executable. | |
819 | 2850 On MS-Windows an executable in the same directory as Vim is |
2851 always found. Since this directory is added to $PATH it | |
2852 should also work to execute it |win32-PATH|. | |
7 | 2853 The result is a Number: |
2854 1 exists | |
2855 0 does not exist | |
2856 -1 not implemented on this system | |
2857 | |
5782 | 2858 exepath({expr}) *exepath()* |
2859 If {expr} is an executable and is either an absolute path, a | |
2860 relative path or found in $PATH, return the full path. | |
2861 Note that the current directory is used when {expr} starts | |
2862 with "./", which may be a problem for Vim: > | |
2863 echo exepath(v:progpath) | |
5814 | 2864 < If {expr} cannot be found in $PATH or is not executable then |
5782 | 2865 an empty string is returned. |
2866 | |
7 | 2867 *exists()* |
2868 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
2869 defined, zero otherwise. The {expr} argument is a string, | |
2870 which contains one of these: | |
2871 &option-name Vim option (only checks if it exists, | |
2872 not if it really works) | |
2873 +option-name Vim option that works. | |
2874 $ENVNAME environment variable (could also be | |
2875 done by comparing with an empty | |
2876 string) | |
2877 *funcname built-in function (see |functions|) | |
2878 or user defined function (see | |
5862 | 2879 |user-functions|). Also works for a |
2880 variable that is a Funcref. | |
7 | 2881 varname internal variable (see |
1621 | 2882 |internal-variables|). Also works |
685 | 2883 for |curly-braces-names|, |Dictionary| |
2884 entries, |List| items, etc. Beware | |
1668 | 2885 that evaluating an index may cause an |
2886 error message for an invalid | |
2887 expression. E.g.: > | |
2888 :let l = [1, 2, 3] | |
2889 :echo exists("l[5]") | |
2890 < 0 > | |
2891 :echo exists("l[xx]") | |
2892 < E121: Undefined variable: xx | |
2893 0 | |
7 | 2894 :cmdname Ex command: built-in command, user |
2895 command or command modifier |:command|. | |
2896 Returns: | |
2897 1 for match with start of a command | |
2898 2 full match with a command | |
2899 3 matches several user commands | |
2900 To check for a supported command | |
2901 always check the return value to be 2. | |
864 | 2902 :2match The |:2match| command. |
2903 :3match The |:3match| command. | |
7 | 2904 #event autocommand defined for this event |
2905 #event#pattern autocommand defined for this event and | |
2906 pattern (the pattern is taken | |
2907 literally and compared to the | |
2908 autocommand patterns character by | |
2909 character) | |
613 | 2910 #group autocommand group exists |
2911 #group#event autocommand defined for this group and | |
2912 event. | |
2913 #group#event#pattern | |
856 | 2914 autocommand defined for this group, |
613 | 2915 event and pattern. |
615 | 2916 ##event autocommand for this event is |
2917 supported. | |
7 | 2918 For checking for a supported feature use |has()|. |
2919 | |
2920 Examples: > | |
2921 exists("&shortname") | |
2922 exists("$HOSTNAME") | |
2923 exists("*strftime") | |
2924 exists("*s:MyFunc") | |
2925 exists("bufcount") | |
2926 exists(":Make") | |
613 | 2927 exists("#CursorHold") |
7 | 2928 exists("#BufReadPre#*.gz") |
613 | 2929 exists("#filetypeindent") |
2930 exists("#filetypeindent#FileType") | |
2931 exists("#filetypeindent#FileType#*") | |
615 | 2932 exists("##ColorScheme") |
7 | 2933 < There must be no space between the symbol (&/$/*/#) and the |
2934 name. | |
867 | 2935 There must be no extra characters after the name, although in |
2936 a few cases this is ignored. That may become more strict in | |
2937 the future, thus don't count on it! | |
2938 Working example: > | |
2939 exists(":make") | |
2940 < NOT working example: > | |
2941 exists(":make install") | |
859 | 2942 |
2943 < Note that the argument must be a string, not the name of the | |
2944 variable itself. For example: > | |
7 | 2945 exists(bufcount) |
2946 < This doesn't check for existence of the "bufcount" variable, | |
853 | 2947 but gets the value of "bufcount", and checks if that exists. |
7 | 2948 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2949 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2950 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
|
2951 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2952 {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
|
2953 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2954 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2955 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2956 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2957 < 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
|
2958 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2959 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2960 |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2961 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
7 | 2962 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
|
2963 'wildignorecase' applies. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2964 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2965 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
|
2966 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
|
2967 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
|
2968 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
|
2969 file name contains a space] |
7 | 2970 |
1621 | 2971 If the expansion fails, the result is an empty string. A name |
4869 | 2972 for a non-existing file is not included, unless {expr} does |
2973 not start with '%', '#' or '<', see below. | |
7 | 2974 |
2975 When {expr} starts with '%', '#' or '<', the expansion is done | |
2976 like for the |cmdline-special| variables with their associated | |
2977 modifiers. Here is a short overview: | |
2978 | |
2979 % current file name | |
2980 # alternate file name | |
2981 #n alternate file name n | |
2982 <cfile> file name under the cursor | |
2983 <afile> autocmd file name | |
2984 <abuf> autocmd buffer number (as a String!) | |
2985 <amatch> autocmd matched name | |
5734 | 2986 <sfile> sourced script file or function name |
2662 | 2987 <slnum> sourced script file line number |
7 | 2988 <cword> word under the cursor |
2989 <cWORD> WORD under the cursor | |
2990 <client> the {clientid} of the last received | |
2991 message |server2client()| | |
2992 Modifiers: | |
2993 :p expand to full path | |
2994 :h head (last path component removed) | |
2995 :t tail (last path component only) | |
2996 :r root (one extension removed) | |
2997 :e extension only | |
2998 | |
2999 Example: > | |
3000 :let &tags = expand("%:p:h") . "/tags" | |
3001 < Note that when expanding a string that starts with '%', '#' or | |
3002 '<', any following text is ignored. This does NOT work: > | |
3003 :let doesntwork = expand("%:h.bak") | |
3004 < Use this: > | |
3005 :let doeswork = expand("%:h") . ".bak" | |
3006 < Also note that expanding "<cfile>" and others only returns the | |
3007 referenced file name without further expansion. If "<cfile>" | |
3008 is "~/.cshrc", you need to do another expand() to have the | |
3009 "~/" expanded into the path of the home directory: > | |
3010 :echo expand(expand("<cfile>")) | |
3011 < | |
3012 There cannot be white space between the variables and the | |
3013 following modifier. The |fnamemodify()| function can be used | |
3014 to modify normal file names. | |
3015 | |
3016 When using '%' or '#', and the current or alternate file name | |
3017 is not defined, an empty string is used. Using "%:p" in a | |
3018 buffer with no name, results in the current directory, with a | |
3019 '/' added. | |
3020 | |
3021 When {expr} does not start with '%', '#' or '<', it is | |
3022 expanded like a file name is expanded on the command line. | |
3023 'suffixes' and 'wildignore' are used, unless the optional | |
3398 | 3024 {nosuf} argument is given and it is non-zero. |
3025 Names for non-existing files are included. The "**" item can | |
3026 be used to search in a directory tree. For example, to find | |
3027 all "README" files in the current directory and below: > | |
444 | 3028 :echo expand("**/README") |
3029 < | |
7 | 3030 Expand() can also be used to expand variables and environment |
3031 variables that are only known in a shell. But this can be | |
6180 | 3032 slow, because a shell may be used to do the expansion. See |
3033 |expr-env-expand|. | |
7 | 3034 The expanded variable is still handled like a list of file |
1621 | 3035 names. When an environment variable cannot be expanded, it is |
7 | 3036 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
3037 "$FOOBAR". | |
3038 | |
3039 See |glob()| for finding existing files. See |system()| for | |
3040 getting the raw output of an external command. | |
3041 | |
102 | 3042 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 3043 {expr1} and {expr2} must be both |Lists| or both |
3044 |Dictionaries|. | |
3045 | |
3046 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 3047 If {expr3} is given insert the items of {expr2} before item |
3048 {expr3} in {expr1}. When {expr3} is zero insert before the | |
3049 first item. When {expr3} is equal to len({expr1}) then | |
3050 {expr2} is appended. | |
79 | 3051 Examples: > |
3052 :echo sort(extend(mylist, [7, 5])) | |
3053 :call extend(mylist, [2, 3], 1) | |
1699 | 3054 < When {expr1} is the same List as {expr2} then the number of |
3055 items copied is equal to the original length of the List. | |
3056 E.g., when {expr3} is 1 you get N new copies of the first item | |
3057 (where N is the original length of the List). | |
3058 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 3059 two lists into a new list use the + operator: > |
79 | 3060 :let newlist = [1, 2, 3] + [4, 5] |
102 | 3061 < |
692 | 3062 If they are |Dictionaries|: |
102 | 3063 Add all entries from {expr2} to {expr1}. |
3064 If a key exists in both {expr1} and {expr2} then {expr3} is | |
3065 used to decide what to do: | |
3066 {expr3} = "keep": keep the value of {expr1} | |
3067 {expr3} = "force": use the value of {expr2} | |
856 | 3068 {expr3} = "error": give an error message *E737* |
102 | 3069 When {expr3} is omitted then "force" is assumed. |
3070 | |
3071 {expr1} is changed when {expr2} is not empty. If necessary | |
3072 make a copy of {expr1} first. | |
3073 {expr2} remains unchanged. | |
6823 | 3074 When {expr1} is locked and {expr2} is not empty the operation |
3075 fails. | |
102 | 3076 Returns {expr1}. |
3077 | |
79 | 3078 |
842 | 3079 feedkeys({string} [, {mode}]) *feedkeys()* |
3080 Characters in {string} are queued for processing as if they | |
6549 | 3081 come from a mapping or were typed by the user. |
3082 By default the string is added to the end of the typeahead | |
3083 buffer, thus if a mapping is still being executed the | |
3084 characters come after them. Use the 'i' flag to insert before | |
3085 other characters, they will be executed next, before any | |
3086 characters from a mapping. | |
842 | 3087 The function does not wait for processing of keys contained in |
3088 {string}. | |
3089 To include special keys into {string}, use double-quotes | |
3090 and "\..." notation |expr-quote|. For example, | |
1215 | 3091 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 3092 feedkeys('\<CR>') pushes 5 characters. |
3093 If {mode} is absent, keys are remapped. | |
3094 {mode} is a String, which can contain these character flags: | |
843 | 3095 'm' Remap keys. This is default. |
3096 'n' Do not remap keys. | |
3097 't' Handle keys as if typed; otherwise they are handled as | |
3098 if coming from a mapping. This matters for undo, | |
3099 opening folds, etc. | |
6549 | 3100 'i' Insert the string instead of appending (see above). |
842 | 3101 Return value is always 0. |
3102 | |
7 | 3103 filereadable({file}) *filereadable()* |
3104 The result is a Number, which is TRUE when a file with the | |
3105 name {file} exists, and can be read. If {file} doesn't exist, | |
3106 or is a directory, the result is FALSE. {file} is any | |
3107 expression, which is used as a String. | |
1156 | 3108 If you don't care about the file being readable you can use |
3109 |glob()|. | |
7 | 3110 *file_readable()* |
3111 Obsolete name: file_readable(). | |
3112 | |
95 | 3113 |
1156 | 3114 filewritable({file}) *filewritable()* |
3115 The result is a Number, which is 1 when a file with the | |
3116 name {file} exists, and can be written. If {file} doesn't | |
1621 | 3117 exist, or is not writable, the result is 0. If {file} is a |
1156 | 3118 directory, and we can write to it, the result is 2. |
3119 | |
3120 | |
102 | 3121 filter({expr}, {string}) *filter()* |
685 | 3122 {expr} must be a |List| or a |Dictionary|. |
102 | 3123 For each item in {expr} evaluate {string} and when the result |
685 | 3124 is zero remove the item from the |List| or |Dictionary|. |
102 | 3125 Inside {string} |v:val| has the value of the current item. |
685 | 3126 For a |Dictionary| |v:key| has the key of the current item. |
102 | 3127 Examples: > |
3128 :call filter(mylist, 'v:val !~ "OLD"') | |
3129 < Removes the items where "OLD" appears. > | |
3130 :call filter(mydict, 'v:key >= 8') | |
3131 < Removes the items with a key below 8. > | |
3132 :call filter(var, 0) | |
685 | 3133 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 3134 |
102 | 3135 Note that {string} is the result of expression and is then |
3136 used as an expression again. Often it is good to use a | |
3137 |literal-string| to avoid having to double backslashes. | |
3138 | |
685 | 3139 The operation is done in-place. If you want a |List| or |
3140 |Dictionary| to remain unmodified make a copy first: > | |
650 | 3141 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 3142 |
685 | 3143 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3144 When an error is encountered while evaluating {string} no |
3145 further items in {expr} are processed. | |
95 | 3146 |
3147 | |
19 | 3148 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 3149 Find directory {name} in {path}. Supports both downwards and |
3150 upwards recursive directory searches. See |file-searching| | |
3151 for the syntax of {path}. | |
3152 Returns the path of the first found match. When the found | |
3153 directory is below the current directory a relative path is | |
3154 returned. Otherwise a full path is returned. | |
19 | 3155 If {path} is omitted or empty then 'path' is used. |
3156 If the optional {count} is given, find {count}'s occurrence of | |
794 | 3157 {name} in {path} instead of the first one. |
809 | 3158 When {count} is negative return all the matches in a |List|. |
19 | 3159 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
|
3160 {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
|
3161 feature} |
794 | 3162 |
3163 findfile({name}[, {path}[, {count}]]) *findfile()* | |
3164 Just like |finddir()|, but find a file instead of a directory. | |
3165 Uses 'suffixesadd'. | |
19 | 3166 Example: > |
3167 :echo findfile("tags.vim", ".;") | |
1156 | 3168 < Searches from the directory of the current file upwards until |
3169 it finds the file "tags.vim". | |
7 | 3170 |
1621 | 3171 float2nr({expr}) *float2nr()* |
3172 Convert {expr} to a Number by omitting the part after the | |
3173 decimal point. | |
3174 {expr} must evaluate to a |Float| or a Number. | |
3175 When the value of {expr} is out of range for a |Number| the | |
3176 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
3177 in -0x80000000. | |
3178 Examples: > | |
3179 echo float2nr(3.95) | |
3180 < 3 > | |
3181 echo float2nr(-23.45) | |
3182 < -23 > | |
3183 echo float2nr(1.0e100) | |
3184 < 2147483647 > | |
3185 echo float2nr(-1.0e150) | |
3186 < -2147483647 > | |
3187 echo float2nr(1.0e-100) | |
3188 < 0 | |
3189 {only available when compiled with the |+float| feature} | |
3190 | |
3191 | |
3192 floor({expr}) *floor()* | |
3193 Return the largest integral value less than or equal to | |
3194 {expr} as a |Float| (round down). | |
3195 {expr} must evaluate to a |Float| or a |Number|. | |
3196 Examples: > | |
3197 echo floor(1.856) | |
3198 < 1.0 > | |
3199 echo floor(-5.456) | |
3200 < -6.0 > | |
3201 echo floor(4.0) | |
3202 < 4.0 | |
3203 {only available when compiled with the |+float| feature} | |
3204 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3205 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3206 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3207 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3208 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3209 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
|
3210 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
|
3211 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
|
3212 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
|
3213 {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
|
3214 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3215 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3216 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3217 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3218 < -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
|
3219 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3220 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3221 |
1586 | 3222 fnameescape({string}) *fnameescape()* |
1621 | 3223 Escape {string} for use as file name command argument. All |
1586 | 3224 characters that have a special meaning, such as '%' and '|' |
3225 are escaped with a backslash. | |
1621 | 3226 For most systems the characters escaped are |
3227 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3228 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3229 A leading '+' and '>' is also escaped (special after |:edit| |
3230 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3231 Example: > |
1700 | 3232 :let fname = '+some str%nge|name' |
1586 | 3233 :exe "edit " . fnameescape(fname) |
3234 < results in executing: > | |
1700 | 3235 edit \+some\ str\%nge\|name |
1586 | 3236 |
7 | 3237 fnamemodify({fname}, {mods}) *fnamemodify()* |
3238 Modify file name {fname} according to {mods}. {mods} is a | |
3239 string of characters like it is used for file names on the | |
3240 command line. See |filename-modifiers|. | |
3241 Example: > | |
3242 :echo fnamemodify("main.c", ":p:h") | |
3243 < results in: > | |
3244 /home/mool/vim/vim/src | |
1621 | 3245 < Note: Environment variables don't work in {fname}, use |
7 | 3246 |expand()| first then. |
3247 | |
3248 foldclosed({lnum}) *foldclosed()* | |
3249 The result is a Number. If the line {lnum} is in a closed | |
3250 fold, the result is the number of the first line in that fold. | |
3251 If the line {lnum} is not in a closed fold, -1 is returned. | |
3252 | |
3253 foldclosedend({lnum}) *foldclosedend()* | |
3254 The result is a Number. If the line {lnum} is in a closed | |
3255 fold, the result is the number of the last line in that fold. | |
3256 If the line {lnum} is not in a closed fold, -1 is returned. | |
3257 | |
3258 foldlevel({lnum}) *foldlevel()* | |
3259 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3260 in the current buffer. For nested folds the deepest level is |
7 | 3261 returned. If there is no fold at line {lnum}, zero is |
3262 returned. It doesn't matter if the folds are open or closed. | |
3263 When used while updating folds (from 'foldexpr') -1 is | |
3264 returned for lines where folds are still to be updated and the | |
3265 foldlevel is unknown. As a special case the level of the | |
3266 previous line is usually available. | |
3267 | |
3268 *foldtext()* | |
3269 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3270 the default function used for the 'foldtext' option and should | |
3271 only be called from evaluating 'foldtext'. It uses the | |
3272 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3273 The returned string looks like this: > | |
3274 +-- 45 lines: abcdef | |
1621 | 3275 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3276 the number of lines in the fold. "abcdef" is the text in the |
3277 first non-blank line of the fold. Leading white space, "//" | |
3278 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3279 options is removed. | |
3280 {not available when compiled without the |+folding| feature} | |
3281 | |
29 | 3282 foldtextresult({lnum}) *foldtextresult()* |
3283 Returns the text that is displayed for the closed fold at line | |
3284 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3285 When there is no closed fold at {lnum} an empty string is | |
3286 returned. | |
3287 {lnum} is used like with |getline()|. Thus "." is the current | |
3288 line, "'m" mark m, etc. | |
3289 Useful when exporting folded text, e.g., to HTML. | |
3290 {not available when compiled without the |+folding| feature} | |
3291 | |
7 | 3292 *foreground()* |
1621 | 3293 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3294 a client to a Vim server. |remote_send()| |
3295 On Win32 systems this might not work, the OS does not always | |
3296 allow a window to bring itself to the foreground. Use | |
3297 |remote_foreground()| instead. | |
3298 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3299 Win32 console version} | |
3300 | |
82 | 3301 |
85 | 3302 function({name}) *function()* *E700* |
685 | 3303 Return a |Funcref| variable that refers to function {name}. |
55 | 3304 {name} can be a user defined function or an internal function. |
3305 | |
82 | 3306 |
3224 | 3307 garbagecollect([{atexit}]) *garbagecollect()* |
692 | 3308 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 3309 references. There is hardly ever a need to invoke this |
3310 function, as it is automatically done when Vim runs out of | |
3311 memory or is waiting for the user to press a key after | |
3312 'updatetime'. Items without circular references are always | |
3313 freed when they become unused. | |
685 | 3314 This is useful if you have deleted a very big |List| and/or |
3315 |Dictionary| with circular references in a script that runs | |
3316 for a long time. | |
3224 | 3317 When the optional {atexit} argument is one, garbage |
1405 | 3318 collection will also be done when exiting Vim, if it wasn't |
3319 done before. This is useful when checking for memory leaks. | |
370 | 3320 |
140 | 3321 get({list}, {idx} [, {default}]) *get()* |
685 | 3322 Get item {idx} from |List| {list}. When this item is not |
82 | 3323 available return {default}. Return zero when {default} is |
3324 omitted. | |
102 | 3325 get({dict}, {key} [, {default}]) |
685 | 3326 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3327 item is not available return {default}. Return zero when |
3328 {default} is omitted. | |
3329 | |
435 | 3330 *getbufline()* |
3331 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3332 Return a |List| with the lines starting from {lnum} to {end} |
3333 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3334 |List| with only the line {lnum} is returned. | |
435 | 3335 |
3336 For the use of {expr}, see |bufname()| above. | |
3337 | |
448 | 3338 For {lnum} and {end} "$" can be used for the last line of the |
3339 buffer. Otherwise a number must be used. | |
435 | 3340 |
3341 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3342 lines in the buffer, an empty |List| is returned. |
435 | 3343 |
3344 When {end} is greater than the number of lines in the buffer, | |
3345 it is treated as {end} is set to the number of lines in the | |
685 | 3346 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3347 returned. |
3348 | |
448 | 3349 This function works only for loaded buffers. For unloaded and |
685 | 3350 non-existing buffers, an empty |List| is returned. |
435 | 3351 |
3352 Example: > | |
3353 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3354 |
4157 | 3355 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
82 | 3356 The result is the value of option or local buffer variable |
3357 {varname} in buffer {expr}. Note that the name without "b:" | |
3358 must be used. | |
1668 | 3359 When {varname} is empty returns a dictionary with all the |
3360 buffer-local variables. | |
216 | 3361 This also works for a global or buffer-local option, but it |
3362 doesn't work for a global variable, window-local variable or | |
3363 window-local option. | |
82 | 3364 For the use of {expr}, see |bufname()| above. |
4157 | 3365 When the buffer or variable doesn't exist {def} or an empty |
3366 string is returned, there is no error message. | |
82 | 3367 Examples: > |
3368 :let bufmodified = getbufvar(1, "&mod") | |
3369 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3370 < | |
7 | 3371 getchar([expr]) *getchar()* |
867 | 3372 Get a single character from the user or input stream. |
7 | 3373 If [expr] is omitted, wait until a character is available. |
3374 If [expr] is 0, only get a character when one is available. | |
867 | 3375 Return zero otherwise. |
7 | 3376 If [expr] is 1, only check if a character is available, it is |
867 | 3377 not consumed. Return zero if no character available. |
3378 | |
5555 | 3379 Without [expr] and when [expr] is 0 a whole character or |
867 | 3380 special key is returned. If it is an 8-bit character, the |
3381 result is a number. Use nr2char() to convert it to a String. | |
3382 Otherwise a String is returned with the encoded character. | |
3383 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3384 (decimal: 128). This is the same value as the string |
3385 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3386 String when a modifier (shift, control, alt) was used that is | |
3387 not included in the character. | |
867 | 3388 |
5968 | 3389 When [expr] is 0 and Esc is typed, there will be a short delay |
3390 while Vim waits to see if this is the start of an escape | |
3391 sequence. | |
3392 | |
5555 | 3393 When [expr] is 1 only the first byte is returned. For a |
872 | 3394 one-byte character it is the character itself as a number. |
3395 Use nr2char() to convert it to a String. | |
867 | 3396 |
3224 | 3397 Use getcharmod() to obtain any additional modifiers. |
3398 | |
1029 | 3399 When the user clicks a mouse button, the mouse event will be |
3400 returned. The position can then be found in |v:mouse_col|, | |
3401 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3402 mouse as it would normally happen: > | |
3403 let c = getchar() | |
1621 | 3404 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3405 exe v:mouse_win . "wincmd w" |
3406 exe v:mouse_lnum | |
3407 exe "normal " . v:mouse_col . "|" | |
3408 endif | |
3409 < | |
7 | 3410 There is no prompt, you will somehow have to make clear to the |
3411 user that a character has to be typed. | |
3412 There is no mapping for the character. | |
3413 Key codes are replaced, thus when the user presses the <Del> | |
3414 key you get the code for the <Del> key, not the raw character | |
3415 sequence. Examples: > | |
3416 getchar() == "\<Del>" | |
3417 getchar() == "\<S-Left>" | |
3418 < This example redefines "f" to ignore case: > | |
3419 :nmap f :call FindChar()<CR> | |
3420 :function FindChar() | |
3421 : let c = nr2char(getchar()) | |
3422 : while col('.') < col('$') - 1 | |
3423 : normal l | |
3424 : if getline('.')[col('.') - 1] ==? c | |
3425 : break | |
3426 : endif | |
3427 : endwhile | |
3428 :endfunction | |
6421 | 3429 < |
6647 | 3430 You may also receive synthetic characters, such as |
6421 | 3431 |<CursorHold>|. Often you will want to ignore this and get |
3432 another character: > | |
3433 :function GetKey() | |
3434 : let c = getchar() | |
3435 : while c == "\<CursorHold>" | |
3436 : let c = getchar() | |
3437 : endwhile | |
3438 : return c | |
3439 :endfunction | |
7 | 3440 |
3441 getcharmod() *getcharmod()* | |
3442 The result is a Number which is the state of the modifiers for | |
3443 the last obtained character with getchar() or in another way. | |
3444 These values are added together: | |
3445 2 shift | |
3446 4 control | |
3447 8 alt (meta) | |
3224 | 3448 16 meta (when it's different from ALT) |
3449 32 mouse double click | |
3450 64 mouse triple click | |
3451 96 mouse quadruple click (== 32 + 64) | |
3452 128 command (Macintosh only) | |
7 | 3453 Only the modifiers that have not been included in the |
1621 | 3454 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3455 without a modifier. |
7 | 3456 |
6991 | 3457 getcharsearch() *getcharsearch()* |
3458 Return the current character search information as a {dict} | |
3459 with the following entries: | |
3460 | |
3461 char character previously used for a character | |
3462 search (|t|, |f|, |T|, or |F|); empty string | |
3463 if no character search has been performed | |
3464 forward direction of character search; 1 for forward, | |
3465 0 for backward | |
3466 until type of character search; 1 for a |t| or |T| | |
3467 character search, 0 for an |f| or |F| | |
3468 character search | |
3469 | |
3470 This can be useful to always have |;| and |,| search | |
3471 forward/backward regardless of the direction of the previous | |
3472 character search: > | |
3473 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
3474 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
3475 < Also see |setcharsearch()|. | |
3476 | |
7 | 3477 getcmdline() *getcmdline()* |
3478 Return the current command-line. Only works when the command | |
3479 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3480 |c_CTRL-R_=|. | |
3481 Example: > | |
3482 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3483 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3484 |
95 | 3485 getcmdpos() *getcmdpos()* |
7 | 3486 Return the position of the cursor in the command line as a |
3487 byte count. The first column is 1. | |
3488 Only works when editing the command line, thus requires use of | |
3456 | 3489 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3490 Returns 0 otherwise. | |
531 | 3491 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3492 | |
3493 getcmdtype() *getcmdtype()* | |
3494 Return the current command-line type. Possible return values | |
3495 are: | |
532 | 3496 : normal Ex command |
3497 > debug mode command |debug-mode| | |
3498 / forward search command | |
3499 ? backward search command | |
3500 @ |input()| command | |
3501 - |:insert| or |:append| command | |
6213 | 3502 = |i_CTRL-R_=| |
531 | 3503 Only works when editing the command line, thus requires use of |
3456 | 3504 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3505 Returns an empty string otherwise. | |
531 | 3506 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
7 | 3507 |
6153 | 3508 getcmdwintype() *getcmdwintype()* |
3509 Return the current |command-line-window| type. Possible return | |
3510 values are the same as |getcmdtype()|. Returns an empty string | |
3511 when not in the command-line window. | |
3512 | |
5944 | 3513 *getcurpos()* |
3514 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
3515 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
|
3516 [bufnum, lnum, col, off, curswant] ~ |
5944 | 3517 The "curswant" number is the preferred column when moving the |
3518 cursor vertically. | |
3519 This can be used to save and restore the cursor position: > | |
3520 let save_cursor = getcurpos() | |
3521 MoveTheCursorAround | |
3522 call setpos('.', save_cursor) | |
6153 | 3523 < |
7 | 3524 *getcwd()* |
3525 getcwd() The result is a String, which is the name of the current | |
3526 working directory. | |
3527 | |
3528 getfsize({fname}) *getfsize()* | |
3529 The result is a Number, which is the size in bytes of the | |
3530 given file {fname}. | |
3531 If {fname} is a directory, 0 is returned. | |
3532 If the file {fname} can't be found, -1 is returned. | |
1293 | 3533 If the size of {fname} is too big to fit in a Number then -2 |
3534 is returned. | |
7 | 3535 |
37 | 3536 getfontname([{name}]) *getfontname()* |
3537 Without an argument returns the name of the normal font being | |
3538 used. Like what is used for the Normal highlight group | |
3539 |hl-Normal|. | |
3540 With an argument a check is done whether {name} is a valid | |
3541 font name. If not then an empty string is returned. | |
3542 Otherwise the actual font name is returned, or {name} if the | |
3543 GUI does not support obtaining the real name. | |
824 | 3544 Only works when the GUI is running, thus not in your vimrc or |
819 | 3545 gvimrc file. Use the |GUIEnter| autocommand to use this |
3546 function just after the GUI has started. | |
37 | 3547 Note that the GTK 2 GUI accepts any font name, thus checking |
3548 for a valid name does not work. | |
3549 | |
20 | 3550 getfperm({fname}) *getfperm()* |
3551 The result is a String, which is the read, write, and execute | |
3552 permissions of the given file {fname}. | |
3553 If {fname} does not exist or its directory cannot be read, an | |
3554 empty string is returned. | |
3555 The result is of the form "rwxrwxrwx", where each group of | |
3556 "rwx" flags represent, in turn, the permissions of the owner | |
3557 of the file, the group the file belongs to, and other users. | |
3558 If a user does not have a given permission the flag for this | |
3750 | 3559 is replaced with the string "-". Examples: > |
20 | 3560 :echo getfperm("/etc/passwd") |
3750 | 3561 :echo getfperm(expand("~/.vimrc")) |
20 | 3562 < This will hopefully (from a security point of view) display |
3563 the string "rw-r--r--" or even "rw-------". | |
205 | 3564 |
7 | 3565 getftime({fname}) *getftime()* |
3566 The result is a Number, which is the last modification time of | |
3567 the given file {fname}. The value is measured as seconds | |
3568 since 1st Jan 1970, and may be passed to strftime(). See also | |
3569 |localtime()| and |strftime()|. | |
3570 If the file {fname} can't be found -1 is returned. | |
3571 | |
20 | 3572 getftype({fname}) *getftype()* |
3573 The result is a String, which is a description of the kind of | |
3574 file of the given file {fname}. | |
3575 If {fname} does not exist an empty string is returned. | |
3576 Here is a table over different kinds of files and their | |
3577 results: | |
3578 Normal file "file" | |
3579 Directory "dir" | |
3580 Symbolic link "link" | |
3581 Block device "bdev" | |
3582 Character device "cdev" | |
3583 Socket "socket" | |
3584 FIFO "fifo" | |
3585 All other "other" | |
3586 Example: > | |
3587 getftype("/home") | |
3588 < Note that a type such as "link" will only be returned on | |
3589 systems that support it. On some systems only "dir" and | |
3590 "file" are returned. | |
3591 | |
7 | 3592 *getline()* |
82 | 3593 getline({lnum} [, {end}]) |
3594 Without {end} the result is a String, which is line {lnum} | |
3595 from the current buffer. Example: > | |
7 | 3596 getline(1) |
3597 < When {lnum} is a String that doesn't start with a | |
3598 digit, line() is called to translate the String into a Number. | |
3599 To get the line under the cursor: > | |
3600 getline(".") | |
3601 < When {lnum} is smaller than 1 or bigger than the number of | |
3602 lines in the buffer, an empty string is returned. | |
3603 | |
685 | 3604 When {end} is given the result is a |List| where each item is |
3605 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3606 including line {end}. |
3607 {end} is used in the same way as {lnum}. | |
3608 Non-existing lines are silently omitted. | |
685 | 3609 When {end} is before {lnum} an empty |List| is returned. |
82 | 3610 Example: > |
3611 :let start = line('.') | |
3612 :let end = search("^$") - 1 | |
3613 :let lines = getline(start, end) | |
3614 | |
1156 | 3615 < To get lines from another buffer see |getbufline()| |
3616 | |
647 | 3617 getloclist({nr}) *getloclist()* |
3618 Returns a list with all the entries in the location list for | |
3619 window {nr}. When {nr} is zero the current window is used. | |
3620 For a location list window, the displayed location list is | |
648 | 3621 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
|
3622 returned. Otherwise, same as |getqflist()|. |
82 | 3623 |
1326 | 3624 getmatches() *getmatches()* |
3625 Returns a |List| with all matches previously defined by | |
3626 |matchadd()| and the |:match| commands. |getmatches()| is | |
3627 useful in combination with |setmatches()|, as |setmatches()| | |
3628 can restore a list of matches saved by |getmatches()|. | |
3629 Example: > | |
3630 :echo getmatches() | |
3631 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3632 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3633 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3634 :let m = getmatches() | |
3635 :call clearmatches() | |
3636 :echo getmatches() | |
3637 < [] > | |
3638 :call setmatches(m) | |
3639 :echo getmatches() | |
3640 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
3641 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
3642 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
3643 :unlet m | |
3644 < | |
5968 | 3645 *getpid()* |
3646 getpid() Return a Number which is the process ID of the Vim process. | |
3647 On Unix and MS-Windows this is a unique number, until Vim | |
3648 exits. On MS-DOS it's always zero. | |
3649 | |
3650 *getpos()* | |
3651 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
3652 see |line()|. For getting the cursor position see | |
3653 |getcurpos()|. | |
3654 The result is a |List| with four numbers: | |
3655 [bufnum, lnum, col, off] | |
3656 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
3657 is the buffer number of the mark. | |
3658 "lnum" and "col" are the position in the buffer. The first | |
3659 column is 1. | |
3660 The "off" number is zero, unless 'virtualedit' is used. Then | |
3661 it is the offset in screen columns from the start of the | |
3662 character. E.g., a position within a <Tab> or after the last | |
3663 character. | |
3664 Note that for '< and '> Visual mode matters: when it is "V" | |
3665 (visual line mode) the column of '< is zero and the column of | |
3666 '> is a large number. | |
3667 This can be used to save and restore the position of a mark: > | |
3668 let save_a_mark = getpos("'a") | |
3669 ... | |
6421 | 3670 call setpos("'a", save_a_mark) |
5968 | 3671 < Also see |getcurpos()| and |setpos()|. |
3672 | |
1326 | 3673 |
230 | 3674 getqflist() *getqflist()* |
3675 Returns a list with all the current quickfix errors. Each | |
3676 list item is a dictionary with these entries: | |
3677 bufnr number of buffer that has the file name, use | |
3678 bufname() to get the name | |
3679 lnum line number in the buffer (first line is 1) | |
3680 col column number (first column is 1) | |
233 | 3681 vcol non-zero: "col" is visual column |
3682 zero: "col" is byte index | |
230 | 3683 nr error number |
1065 | 3684 pattern search pattern used to locate the error |
230 | 3685 text description of the error |
3686 type type of the error, 'E', '1', etc. | |
3687 valid non-zero: recognized error message | |
3688 | |
515 | 3689 When there is no error list or it's empty an empty list is |
1065 | 3690 returned. Quickfix list entries with non-existing buffer |
3691 number are returned with "bufnr" set to zero. | |
515 | 3692 |
230 | 3693 Useful application: Find pattern matches in multiple files and |
3694 do something with them: > | |
3695 :vimgrep /theword/jg *.c | |
3696 :for d in getqflist() | |
3697 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
3698 :endfor | |
3699 | |
3700 | |
5796 | 3701 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
7 | 3702 The result is a String, which is the contents of register |
236 | 3703 {regname}. Example: > |
7 | 3704 :let cliptext = getreg('*') |
3705 < getreg('=') returns the last evaluated value of the expression | |
236 | 3706 register. (For use in maps.) |
282 | 3707 getreg('=', 1) returns the expression itself, so that it can |
3708 be restored with |setreg()|. For other registers the extra | |
3709 argument is ignored, thus you can always give it. | |
5796 | 3710 If {list} is present and non-zero result type is changed to |
3711 |List|. Each list item is one text line. Use it if you care | |
3712 about zero bytes possibly present inside register: without | |
3713 third argument both NLs and zero bytes are represented as NLs | |
3714 (see |NL-used-for-Nul|). | |
7 | 3715 If {regname} is not specified, |v:register| is used. |
3716 | |
82 | 3717 |
7 | 3718 getregtype([{regname}]) *getregtype()* |
3719 The result is a String, which is type of register {regname}. | |
3720 The value will be one of: | |
3721 "v" for |characterwise| text | |
3722 "V" for |linewise| text | |
3723 "<CTRL-V>{width}" for |blockwise-visual| text | |
5596 | 3724 "" for an empty or unknown register |
7 | 3725 <CTRL-V> is one character with value 0x16. |
3726 If {regname} is not specified, |v:register| is used. | |
3727 | |
4157 | 3728 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3729 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
|
3730 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3731 Tabs are numbered starting with one. |
6197 | 3732 When {varname} is empty a dictionary with all tab-local |
3733 variables is returned. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3734 Note that the name without "t:" must be used. |
4157 | 3735 When the tab or variable doesn't exist {def} or an empty |
3736 string is returned, there is no error message. | |
3737 | |
3738 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
1156 | 3739 Get the value of window-local variable {varname} in window |
3740 {winnr} in tab page {tabnr}. | |
3741 When {varname} starts with "&" get the value of a window-local | |
3742 option. | |
4157 | 3743 When {varname} is empty a dictionary with all window-local |
3744 variables is returned. | |
3745 Note that {varname} must be the name without "w:". | |
831 | 3746 Tabs are numbered starting with one. For the current tabpage |
3747 use |getwinvar()|. | |
3748 When {winnr} is zero the current window is used. | |
3749 This also works for a global option, buffer-local option and | |
3750 window-local option, but it doesn't work for a global variable | |
3751 or buffer-local variable. | |
4157 | 3752 When the tab, window or variable doesn't exist {def} or an |
3753 empty string is returned, there is no error message. | |
831 | 3754 Examples: > |
3755 :let list_is_on = gettabwinvar(1, 2, '&list') | |
3756 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 3757 < |
7 | 3758 *getwinposx()* |
3759 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
3760 the left hand side of the GUI Vim window. The result will be | |
3761 -1 if the information is not available. | |
3762 | |
3763 *getwinposy()* | |
3764 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 3765 the top of the GUI Vim window. The result will be -1 if the |
7 | 3766 information is not available. |
3767 | |
4157 | 3768 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
831 | 3769 Like |gettabwinvar()| for the current tabpage. |
7 | 3770 Examples: > |
3771 :let list_is_on = getwinvar(2, '&list') | |
3772 :echo "myvar = " . getwinvar(1, 'myvar') | |
3773 < | |
6663 | 3774 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
1754 | 3775 Expand the file wildcards in {expr}. See |wildcards| for the |
1156 | 3776 use of special characters. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3777 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3778 Unless the optional {nosuf} argument is given and is non-zero, |
1754 | 3779 the 'suffixes' and 'wildignore' options apply: Names matching |
3780 one of the patterns in 'wildignore' will be skipped and | |
3781 'suffixes' affect the ordering of matches. | |
2662 | 3782 'wildignorecase' always applies. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3783 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3784 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
|
3785 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
|
3786 you also get filenames containing newlines correctly. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3787 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
|
3788 matches, they are separated by <NL> characters. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3789 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3790 If the expansion fails, the result is an empty String or List. |
6663 | 3791 |
3445 | 3792 A name for a non-existing file is not included. A symbolic |
3793 link is only included if it points to an existing file. | |
6663 | 3794 However, when the {alllinks} argument is present and it is |
3795 non-zero then all symbolic links are included. | |
7 | 3796 |
3797 For most systems backticks can be used to get files names from | |
3798 any external command. Example: > | |
3799 :let tagfiles = glob("`find . -name tags -print`") | |
3800 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
3801 < The result of the program inside the backticks should be one | |
1621 | 3802 item per line. Spaces inside an item are allowed. |
7 | 3803 |
3804 See |expand()| for expanding special Vim variables. See | |
3805 |system()| for getting the raw output of an external command. | |
3806 | |
6697 | 3807 glob2regpat({expr}) *glob2regpat()* |
3808 Convert a file pattern, as used by glob(), into a search | |
3809 pattern. The result can be used to match with a string that | |
3810 is a file name. E.g. > | |
3811 if filename =~ glob2regpat('Make*.mak') | |
3812 < This is equivalent to: > | |
3813 if filename =~ '^Make.*\.mak$' | |
3814 < | |
6663 | 3815 *globpath()* |
3816 globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) | |
7 | 3817 Perform glob() on all directories in {path} and concatenate |
3818 the results. Example: > | |
3819 :echo globpath(&rtp, "syntax/c.vim") | |
5873 | 3820 < |
3821 {path} is a comma-separated list of directory names. Each | |
7 | 3822 directory name is prepended to {expr} and expanded like with |
1754 | 3823 |glob()|. A path separator is inserted when needed. |
7 | 3824 To add a comma inside a directory name escape it with a |
3825 backslash. Note that on MS-Windows a directory may have a | |
3826 trailing backslash, remove it if you put a comma after it. | |
3827 If the expansion fails for one of the directories, there is no | |
3828 error message. | |
5873 | 3829 |
3830 Unless the optional {nosuf} argument is given and is non-zero, | |
1754 | 3831 the 'suffixes' and 'wildignore' options apply: Names matching |
3832 one of the patterns in 'wildignore' will be skipped and | |
3833 'suffixes' affect the ordering of matches. | |
7 | 3834 |
5873 | 3835 When {list} is present and it is non-zero the result is a List |
3836 with all matching files. The advantage of using a List is, you | |
3837 also get filenames containing newlines correctly. Otherwise | |
3838 the result is a String and when there are several matches, | |
3839 they are separated by <NL> characters. Example: > | |
3840 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
3841 < | |
6663 | 3842 {allinks} is used as with |glob()|. |
3843 | |
444 | 3844 The "**" item can be used to search in a directory tree. |
3845 For example, to find all "README.txt" files in the directories | |
3846 in 'runtimepath' and below: > | |
3847 :echo globpath(&rtp, "**/README.txt") | |
1668 | 3848 < Upwards search and limiting the depth of "**" is not |
3849 supported, thus using 'path' will not always work properly. | |
3850 | |
7 | 3851 *has()* |
3852 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
3853 supported, zero otherwise. The {feature} argument is a | |
3854 string. See |feature-list| below. | |
3855 Also see |exists()|. | |
3856 | |
102 | 3857 |
3858 has_key({dict}, {key}) *has_key()* | |
685 | 3859 The result is a Number, which is 1 if |Dictionary| {dict} has |
3860 an entry with key {key}. Zero otherwise. | |
102 | 3861 |
1104 | 3862 haslocaldir() *haslocaldir()* |
3863 The result is a Number, which is 1 when the current | |
1621 | 3864 window has set a local path via |:lcd|, and 0 otherwise. |
102 | 3865 |
782 | 3866 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 3867 The result is a Number, which is 1 if there is a mapping that |
3868 contains {what} in somewhere in the rhs (what it is mapped to) | |
3869 and this mapping exists in one of the modes indicated by | |
3870 {mode}. | |
782 | 3871 When {abbr} is there and it is non-zero use abbreviations |
786 | 3872 instead of mappings. Don't forget to specify Insert and/or |
3873 Command-line mode. | |
7 | 3874 Both the global mappings and the mappings local to the current |
3875 buffer are checked for a match. | |
3876 If no matching mapping is found 0 is returned. | |
3877 The following characters are recognized in {mode}: | |
3878 n Normal mode | |
3879 v Visual mode | |
3880 o Operator-pending mode | |
3881 i Insert mode | |
3882 l Language-Argument ("r", "f", "t", etc.) | |
3883 c Command-line mode | |
3884 When {mode} is omitted, "nvo" is used. | |
3885 | |
3886 This function is useful to check if a mapping already exists | |
1621 | 3887 to a function in a Vim script. Example: > |
7 | 3888 :if !hasmapto('\ABCdoit') |
3889 : map <Leader>d \ABCdoit | |
3890 :endif | |
3891 < This installs the mapping to "\ABCdoit" only if there isn't | |
3892 already a mapping to "\ABCdoit". | |
3893 | |
3894 histadd({history}, {item}) *histadd()* | |
3895 Add the String {item} to the history {history} which can be | |
3896 one of: *hist-names* | |
3897 "cmd" or ":" command line history | |
3898 "search" or "/" search pattern history | |
1621 | 3899 "expr" or "=" typed expression history |
7 | 3900 "input" or "@" input line history |
3682 | 3901 "debug" or ">" debug command history |
3902 The {history} string does not need to be the whole name, one | |
3903 character is sufficient. | |
7 | 3904 If {item} does already exist in the history, it will be |
3905 shifted to become the newest entry. | |
3906 The result is a Number: 1 if the operation was successful, | |
3907 otherwise 0 is returned. | |
3908 | |
3909 Example: > | |
3910 :call histadd("input", strftime("%Y %b %d")) | |
3911 :let date=input("Enter date: ") | |
3912 < This function is not available in the |sandbox|. | |
3913 | |
3914 histdel({history} [, {item}]) *histdel()* | |
236 | 3915 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 3916 for the possible values of {history}. |
3917 | |
1668 | 3918 If the parameter {item} evaluates to a String, it is used as a |
3919 regular expression. All entries matching that expression will | |
3920 be removed from the history (if there are any). | |
7 | 3921 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 3922 If {item} evaluates to a Number, it will be interpreted as |
3923 an index, see |:history-indexing|. The respective entry will | |
3924 be removed if it exists. | |
7 | 3925 |
3926 The result is a Number: 1 for a successful operation, | |
3927 otherwise 0 is returned. | |
3928 | |
3929 Examples: | |
3930 Clear expression register history: > | |
3931 :call histdel("expr") | |
3932 < | |
3933 Remove all entries starting with "*" from the search history: > | |
3934 :call histdel("/", '^\*') | |
3935 < | |
3936 The following three are equivalent: > | |
3937 :call histdel("search", histnr("search")) | |
3938 :call histdel("search", -1) | |
3939 :call histdel("search", '^'.histget("search", -1).'$') | |
3940 < | |
3941 To delete the last search pattern and use the last-but-one for | |
3942 the "n" command and 'hlsearch': > | |
3943 :call histdel("search", -1) | |
3944 :let @/ = histget("search", -1) | |
3945 | |
3946 histget({history} [, {index}]) *histget()* | |
3947 The result is a String, the entry with Number {index} from | |
3948 {history}. See |hist-names| for the possible values of | |
3949 {history}, and |:history-indexing| for {index}. If there is | |
3950 no such entry, an empty String is returned. When {index} is | |
3951 omitted, the most recent item from the history is used. | |
3952 | |
3953 Examples: | |
3954 Redo the second last search from history. > | |
3955 :execute '/' . histget("search", -2) | |
3956 | |
3957 < Define an Ex command ":H {num}" that supports re-execution of | |
3958 the {num}th entry from the output of |:history|. > | |
3959 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
3960 < | |
3961 histnr({history}) *histnr()* | |
3962 The result is the Number of the current entry in {history}. | |
3963 See |hist-names| for the possible values of {history}. | |
3964 If an error occurred, -1 is returned. | |
3965 | |
3966 Example: > | |
3967 :let inp_index = histnr("expr") | |
3968 < | |
3969 hlexists({name}) *hlexists()* | |
3970 The result is a Number, which is non-zero if a highlight group | |
3971 called {name} exists. This is when the group has been | |
3972 defined in some way. Not necessarily when highlighting has | |
3973 been defined for it, it may also have been used for a syntax | |
3974 item. | |
3975 *highlight_exists()* | |
3976 Obsolete name: highlight_exists(). | |
3977 | |
3978 *hlID()* | |
3979 hlID({name}) The result is a Number, which is the ID of the highlight group | |
3980 with name {name}. When the highlight group doesn't exist, | |
3981 zero is returned. | |
3982 This can be used to retrieve information about the highlight | |
1621 | 3983 group. For example, to get the background color of the |
7 | 3984 "Comment" group: > |
3985 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
3986 < *highlightID()* | |
3987 Obsolete name: highlightID(). | |
3988 | |
3989 hostname() *hostname()* | |
3990 The result is a String, which is the name of the machine on | |
236 | 3991 which Vim is currently running. Machine names greater than |
7 | 3992 256 characters long are truncated. |
3993 | |
3994 iconv({expr}, {from}, {to}) *iconv()* | |
3995 The result is a String, which is the text {expr} converted | |
3996 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3997 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3998 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3999 are replaced with "?". |
7 | 4000 The encoding names are whatever the iconv() library function |
4001 can accept, see ":!man 3 iconv". | |
4002 Most conversions require Vim to be compiled with the |+iconv| | |
4003 feature. Otherwise only UTF-8 to latin1 conversion and back | |
4004 can be done. | |
4005 This can be used to display messages with special characters, | |
4006 no matter what 'encoding' is set to. Write the message in | |
4007 UTF-8 and use: > | |
4008 echo iconv(utf8_str, "utf-8", &enc) | |
4009 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
4010 from/to UCS-2 is automatically changed to use UTF-8. You | |
4011 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
|
4012 {only available when compiled with the |+multi_byte| feature} |
7 | 4013 |
4014 *indent()* | |
4015 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
4016 current buffer. The indent is counted in spaces, the value | |
4017 of 'tabstop' is relevant. {lnum} is used just like in | |
4018 |getline()|. | |
4019 When {lnum} is invalid -1 is returned. | |
4020 | |
79 | 4021 |
95 | 4022 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 4023 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
|
4024 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4025 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
|
4026 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
|
4027 is not used here, case always matters. |
153 | 4028 If {start} is given then start looking at the item with index |
4029 {start} (may be negative for an item relative to the end). | |
79 | 4030 When {ic} is given and it is non-zero, ignore case. Otherwise |
4031 case must match. | |
4032 -1 is returned when {expr} is not found in {list}. | |
4033 Example: > | |
4034 :let idx = index(words, "the") | |
87 | 4035 :if index(numbers, 123) >= 0 |
79 | 4036 |
4037 | |
531 | 4038 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 4039 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
|
4040 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4041 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
|
4042 in the prompt to start a new line. |
531 | 4043 The highlighting set with |:echohl| is used for the prompt. |
4044 The input is entered just like a command-line, with the same | |
1621 | 4045 editing commands and mappings. There is a separate history |
531 | 4046 for lines typed for input(). |
4047 Example: > | |
4048 :if input("Coffee or beer? ") == "beer" | |
4049 : echo "Cheers!" | |
4050 :endif | |
4051 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4052 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4053 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
|
4054 Example: > |
531 | 4055 :let color = input("Color? ", "white") |
4056 | |
4057 < The optional {completion} argument specifies the type of | |
4058 completion supported for the input. Without it completion is | |
1621 | 4059 not performed. The supported completion types are the same as |
531 | 4060 that can be supplied to a user-defined command using the |
1621 | 4061 "-complete=" argument. Refer to |:command-completion| for |
531 | 4062 more information. Example: > |
4063 let fname = input("File: ", "", "file") | |
4064 < | |
4065 NOTE: This function must not be used in a startup file, for | |
4066 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 4067 Note: When input() is called from within a mapping it will |
4068 consume remaining characters from that mapping, because a | |
4069 mapping is handled like the characters were typed. | |
4070 Use |inputsave()| before input() and |inputrestore()| | |
4071 after input() to avoid that. Another solution is to avoid | |
4072 that further characters follow in the mapping, e.g., by using | |
4073 |:execute| or |:normal|. | |
4074 | |
531 | 4075 Example with a mapping: > |
7 | 4076 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
4077 :function GetFoo() | |
4078 : call inputsave() | |
4079 : let g:Foo = input("enter search pattern: ") | |
4080 : call inputrestore() | |
4081 :endfunction | |
4082 | |
4083 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4084 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4085 are supported, a dialog window pops up to input the text. |
7 | 4086 Example: > |
3875 | 4087 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
4088 :if n != "" | |
4089 : let &sw = n | |
4090 :endif | |
7 | 4091 < When the dialog is cancelled {cancelreturn} is returned. When |
4092 omitted an empty string is returned. | |
4093 Hitting <Enter> works like pressing the OK button. Hitting | |
4094 <Esc> works like pressing the Cancel button. | |
531 | 4095 NOTE: Command-line completion is not supported. |
7 | 4096 |
519 | 4097 inputlist({textlist}) *inputlist()* |
819 | 4098 {textlist} must be a |List| of strings. This |List| is |
4099 displayed, one string per line. The user will be prompted to | |
4100 enter a number, which is returned. | |
519 | 4101 The user can also select an item by clicking on it with the |
1621 | 4102 mouse. For the first string 0 is returned. When clicking |
519 | 4103 above the first item a negative number is returned. When |
4104 clicking on the prompt one more than the length of {textlist} | |
4105 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4106 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 4107 it won't work. It's a good idea to put the entry number at |
1156 | 4108 the start of the string. And put a prompt in the first item. |
4109 Example: > | |
519 | 4110 let color = inputlist(['Select color:', '1. red', |
4111 \ '2. green', '3. blue']) | |
4112 | |
7 | 4113 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4114 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 4115 Should be called the same number of times inputsave() is |
4116 called. Calling it more often is harmless though. | |
4117 Returns 1 when there is nothing to restore, 0 otherwise. | |
4118 | |
4119 inputsave() *inputsave()* | |
4120 Preserve typeahead (also from mappings) and clear it, so that | |
4121 a following prompt gets input from the user. Should be | |
4122 followed by a matching inputrestore() after the prompt. Can | |
4123 be used several times, in which case there must be just as | |
4124 many inputrestore() calls. | |
4125 Returns 1 when out of memory, 0 otherwise. | |
4126 | |
4127 inputsecret({prompt} [, {text}]) *inputsecret()* | |
4128 This function acts much like the |input()| function with but | |
4129 two exceptions: | |
4130 a) the user's response will be displayed as a sequence of | |
4131 asterisks ("*") thereby keeping the entry secret, and | |
4132 b) the user's response will not be recorded on the input | |
4133 |history| stack. | |
4134 The result is a String, which is whatever the user actually | |
4135 typed on the command-line in response to the issued prompt. | |
531 | 4136 NOTE: Command-line completion is not supported. |
7 | 4137 |
55 | 4138 insert({list}, {item} [, {idx}]) *insert()* |
685 | 4139 Insert {item} at the start of |List| {list}. |
55 | 4140 If {idx} is specified insert {item} before the item with index |
1621 | 4141 {idx}. If {idx} is zero it goes before the first item, just |
55 | 4142 like omitting {idx}. A negative {idx} is also possible, see |
4143 |list-index|. -1 inserts just before the last item. | |
685 | 4144 Returns the resulting |List|. Examples: > |
55 | 4145 :let mylist = insert([2, 3, 5], 1) |
4146 :call insert(mylist, 4, -1) | |
4147 :call insert(mylist, 6, len(mylist)) | |
82 | 4148 < The last example can be done simpler with |add()|. |
685 | 4149 Note that when {item} is a |List| it is inserted as a single |
692 | 4150 item. Use |extend()| to concatenate |Lists|. |
55 | 4151 |
3214 | 4152 invert({expr}) *invert()* |
4153 Bitwise invert. The argument is converted to a number. A | |
4154 List, Dict or Float argument causes an error. Example: > | |
4155 :let bits = invert(bits) | |
4156 | |
7 | 4157 isdirectory({directory}) *isdirectory()* |
4158 The result is a Number, which is non-zero when a directory | |
4159 with the name {directory} exists. If {directory} doesn't | |
4160 exist, or isn't a directory, the result is FALSE. {directory} | |
4161 is any expression, which is used as a String. | |
4162 | |
819 | 4163 islocked({expr}) *islocked()* *E786* |
148 | 4164 The result is a Number, which is non-zero when {expr} is the |
4165 name of a locked variable. | |
685 | 4166 {expr} must be the name of a variable, |List| item or |
4167 |Dictionary| entry, not the variable itself! Example: > | |
148 | 4168 :let alist = [0, ['a', 'b'], 2, 3] |
4169 :lockvar 1 alist | |
4170 :echo islocked('alist') " 1 | |
4171 :echo islocked('alist[1]') " 0 | |
4172 | |
4173 < When {expr} is a variable that does not exist you get an error | |
843 | 4174 message. Use |exists()| to check for existence. |
148 | 4175 |
140 | 4176 items({dict}) *items()* |
685 | 4177 Return a |List| with all the key-value pairs of {dict}. Each |
4178 |List| item is a list with two items: the key of a {dict} | |
4179 entry and the value of this entry. The |List| is in arbitrary | |
4180 order. | |
140 | 4181 |
95 | 4182 |
4183 join({list} [, {sep}]) *join()* | |
4184 Join the items in {list} together into one String. | |
4185 When {sep} is specified it is put in between the items. If | |
4186 {sep} is omitted a single space is used. | |
4187 Note that {sep} is not added at the end. You might want to | |
4188 add it there too: > | |
4189 let lines = join(mylist, "\n") . "\n" | |
692 | 4190 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 4191 converted into a string like with |string()|. |
4192 The opposite function is |split()|. | |
4193 | |
99 | 4194 keys({dict}) *keys()* |
685 | 4195 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 4196 arbitrary order. |
4197 | |
85 | 4198 *len()* *E701* |
55 | 4199 len({expr}) The result is a Number, which is the length of the argument. |
4200 When {expr} is a String or a Number the length in bytes is | |
4201 used, as with |strlen()|. | |
685 | 4202 When {expr} is a |List| the number of items in the |List| is |
55 | 4203 returned. |
685 | 4204 When {expr} is a |Dictionary| the number of entries in the |
4205 |Dictionary| is returned. | |
55 | 4206 Otherwise an error is given. |
4207 | |
7 | 4208 *libcall()* *E364* *E368* |
4209 libcall({libname}, {funcname}, {argument}) | |
4210 Call function {funcname} in the run-time library {libname} | |
4211 with single argument {argument}. | |
4212 This is useful to call functions in a library that you | |
4213 especially made to be used with Vim. Since only one argument | |
4214 is possible, calling standard library functions is rather | |
4215 limited. | |
4216 The result is the String returned by the function. If the | |
4217 function returns NULL, this will appear as an empty string "" | |
4218 to Vim. | |
4219 If the function returns a number, use libcallnr()! | |
4220 If {argument} is a number, it is passed to the function as an | |
4221 int; if {argument} is a string, it is passed as a | |
4222 null-terminated string. | |
4223 This function will fail in |restricted-mode|. | |
4224 | |
4225 libcall() allows you to write your own 'plug-in' extensions to | |
4226 Vim without having to recompile the program. It is NOT a | |
4227 means to call system functions! If you try to do so Vim will | |
4228 very probably crash. | |
4229 | |
4230 For Win32, the functions you write must be placed in a DLL | |
4231 and use the normal C calling convention (NOT Pascal which is | |
4232 used in Windows System DLLs). The function must take exactly | |
4233 one parameter, either a character pointer or a long integer, | |
4234 and must return a character pointer or NULL. The character | |
4235 pointer returned must point to memory that will remain valid | |
4236 after the function has returned (e.g. in static data in the | |
4237 DLL). If it points to allocated memory, that memory will | |
4238 leak away. Using a static buffer in the function should work, | |
4239 it's then freed when the DLL is unloaded. | |
4240 | |
4241 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 4242 crash! This also happens if the function returns a number, |
7 | 4243 because Vim thinks it's a pointer. |
4244 For Win32 systems, {libname} should be the filename of the DLL | |
4245 without the ".DLL" suffix. A full path is only required if | |
4246 the DLL is not in the usual places. | |
4247 For Unix: When compiling your own plugins, remember that the | |
4248 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4249 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 4250 feature is present} |
4251 Examples: > | |
4252 :echo libcall("libc.so", "getenv", "HOME") | |
4253 < | |
4254 *libcallnr()* | |
4255 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4256 Just like |libcall()|, but used for a function that returns an |
7 | 4257 int instead of a string. |
4258 {only in Win32 on some Unix versions, when the |+libcall| | |
4259 feature is present} | |
1621 | 4260 Examples: > |
4261 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 4262 :call libcallnr("libc.so", "printf", "Hello World!\n") |
4263 :call libcallnr("libc.so", "sleep", 10) | |
4264 < | |
4265 *line()* | |
4266 line({expr}) The result is a Number, which is the line number of the file | |
4267 position given with {expr}. The accepted positions are: | |
4268 . the cursor position | |
4269 $ the last line in the current buffer | |
4270 'x position of mark x (if the mark is not set, 0 is | |
4271 returned) | |
665 | 4272 w0 first line visible in current window |
4273 w$ last line visible in current window | |
1609 | 4274 v In Visual mode: the start of the Visual area (the |
4275 cursor is the end). When not in Visual mode | |
4276 returns the cursor position. Differs from |'<| in | |
4277 that it's updated right away. | |
1156 | 4278 Note that a mark in another file can be used. The line number |
4279 then applies to another buffer. | |
703 | 4280 To get the column number use |col()|. To get both use |
4281 |getpos()|. | |
7 | 4282 Examples: > |
4283 line(".") line number of the cursor | |
4284 line("'t") line number of mark t | |
4285 line("'" . marker) line number of mark marker | |
4286 < *last-position-jump* | |
4287 This autocommand jumps to the last known position in a file | |
4288 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4289 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 4290 |
7 | 4291 line2byte({lnum}) *line2byte()* |
4292 Return the byte count from the start of the buffer for line | |
4293 {lnum}. This includes the end-of-line character, depending on | |
4294 the 'fileformat' option for the current buffer. The first | |
3237 | 4295 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 4296 This can also be used to get the byte count for the line just |
4297 below the last line: > | |
4298 line2byte(line("$") + 1) | |
3237 | 4299 < This is the buffer size plus one. If 'fileencoding' is empty |
4300 it is the file size plus one. | |
7 | 4301 When {lnum} is invalid, or the |+byte_offset| feature has been |
4302 disabled at compile time, -1 is returned. | |
4303 Also see |byte2line()|, |go| and |:goto|. | |
4304 | |
4305 lispindent({lnum}) *lispindent()* | |
4306 Get the amount of indent for line {lnum} according the lisp | |
4307 indenting rules, as with 'lisp'. | |
4308 The indent is counted in spaces, the value of 'tabstop' is | |
4309 relevant. {lnum} is used just like in |getline()|. | |
4310 When {lnum} is invalid or Vim was not compiled the | |
4311 |+lispindent| feature, -1 is returned. | |
4312 | |
4313 localtime() *localtime()* | |
4314 Return the current time, measured as seconds since 1st Jan | |
4315 1970. See also |strftime()| and |getftime()|. | |
4316 | |
95 | 4317 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4318 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4319 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
|
4320 {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
|
4321 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4322 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4323 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4324 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4325 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4326 < 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
|
4327 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4328 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4329 |
1621 | 4330 log10({expr}) *log10()* |
4331 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
4332 {expr} must evaluate to a |Float| or a |Number|. | |
4333 Examples: > | |
4334 :echo log10(1000) | |
4335 < 3.0 > | |
4336 :echo log10(0.01) | |
4337 < -2.0 | |
4338 {only available when compiled with the |+float| feature} | |
4339 | |
3492 | 4340 luaeval({expr}[, {expr}]) *luaeval()* |
4341 Evaluate Lua expression {expr} and return its result converted | |
4342 to Vim data structures. Second {expr} may hold additional | |
4343 argument accessible as _A inside first {expr}. | |
4344 Strings are returned as they are. | |
4345 Boolean objects are converted to numbers. | |
4346 Numbers are converted to |Float| values if vim was compiled | |
4347 with |+float| and to numbers otherwise. | |
4348 Dictionaries and lists obtained by vim.eval() are returned | |
4349 as-is. | |
4350 Other objects are returned as zero without any errors. | |
4351 See |lua-luaeval| for more details. | |
4352 {only available when compiled with the |+lua| feature} | |
4353 | |
102 | 4354 map({expr}, {string}) *map()* |
685 | 4355 {expr} must be a |List| or a |Dictionary|. |
102 | 4356 Replace each item in {expr} with the result of evaluating |
4357 {string}. | |
4358 Inside {string} |v:val| has the value of the current item. | |
1998 | 4359 For a |Dictionary| |v:key| has the key of the current item |
4360 and for a |List| |v:key| has the index of the current item. | |
102 | 4361 Example: > |
4362 :call map(mylist, '"> " . v:val . " <"') | |
95 | 4363 < This puts "> " before and " <" after each item in "mylist". |
102 | 4364 |
158 | 4365 Note that {string} is the result of an expression and is then |
102 | 4366 used as an expression again. Often it is good to use a |
158 | 4367 |literal-string| to avoid having to double backslashes. You |
4368 still have to double ' quotes | |
102 | 4369 |
685 | 4370 The operation is done in-place. If you want a |List| or |
4371 |Dictionary| to remain unmodified make a copy first: > | |
3682 | 4372 :let tlist = map(copy(mylist), ' v:val . "\t"') |
102 | 4373 |
685 | 4374 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4375 When an error is encountered while evaluating {string} no |
4376 further items in {expr} are processed. | |
95 | 4377 |
4378 | |
2610 | 4379 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4380 When {dict} is omitted or zero: Return the rhs of mapping | |
4381 {name} in mode {mode}. The returned String has special | |
4382 characters translated like in the output of the ":map" command | |
4383 listing. | |
4384 | |
4385 When there is no mapping for {name}, an empty String is | |
4386 returned. | |
4387 | |
4388 The {name} can have special key names, like in the ":map" | |
4389 command. | |
4390 | |
644 | 4391 {mode} can be one of these strings: |
7 | 4392 "n" Normal |
2610 | 4393 "v" Visual (including Select) |
7 | 4394 "o" Operator-pending |
4395 "i" Insert | |
4396 "c" Cmd-line | |
2610 | 4397 "s" Select |
4398 "x" Visual | |
7 | 4399 "l" langmap |language-mapping| |
4400 "" Normal, Visual and Operator-pending | |
644 | 4401 When {mode} is omitted, the modes for "" are used. |
2610 | 4402 |
782 | 4403 When {abbr} is there and it is non-zero use abbreviations |
4404 instead of mappings. | |
2610 | 4405 |
4406 When {dict} is there and it is non-zero return a dictionary | |
4407 containing all the information of the mapping with the | |
4408 following items: | |
4409 "lhs" The {lhs} of the mapping. | |
4410 "rhs" The {rhs} of the mapping as typed. | |
4411 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 4412 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 4413 "expr" 1 for an expression mapping (|:map-<expr>|). |
4414 "buffer" 1 for a buffer local mapping (|:map-local|). | |
4415 "mode" Modes for which the mapping is defined. In | |
4416 addition to the modes mentioned above, these | |
4417 characters will be used: | |
4418 " " Normal, Visual and Operator-pending | |
4419 "!" Insert and Commandline mode | |
2642 | 4420 (|mapmode-ic|) |
2625 | 4421 "sid" The script local ID, used for <sid> mappings |
4422 (|<SID>|). | |
5555 | 4423 "nowait" Do not wait for other, longer mappings. |
4424 (|:map-<nowait>|). | |
2610 | 4425 |
7 | 4426 The mappings local to the current buffer are checked first, |
4427 then the global mappings. | |
626 | 4428 This function can be used to map a key even when it's already |
4429 mapped, and have it do the original mapping too. Sketch: > | |
4430 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
4431 | |
7 | 4432 |
782 | 4433 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 4434 Check if there is a mapping that matches with {name} in mode |
4435 {mode}. See |maparg()| for {mode} and special names in | |
4436 {name}. | |
782 | 4437 When {abbr} is there and it is non-zero use abbreviations |
4438 instead of mappings. | |
7 | 4439 A match happens with a mapping that starts with {name} and |
4440 with a mapping which is equal to the start of {name}. | |
4441 | |
1621 | 4442 matches mapping "a" "ab" "abc" ~ |
7 | 4443 mapcheck("a") yes yes yes |
4444 mapcheck("abc") yes yes yes | |
4445 mapcheck("ax") yes no no | |
4446 mapcheck("b") no no no | |
4447 | |
4448 The difference with maparg() is that mapcheck() finds a | |
4449 mapping that matches with {name}, while maparg() only finds a | |
4450 mapping for {name} exactly. | |
4451 When there is no mapping that starts with {name}, an empty | |
4452 String is returned. If there is one, the rhs of that mapping | |
4453 is returned. If there are several mappings that start with | |
4454 {name}, the rhs of one of them is returned. | |
4455 The mappings local to the current buffer are checked first, | |
4456 then the global mappings. | |
4457 This function can be used to check if a mapping can be added | |
4458 without being ambiguous. Example: > | |
4459 :if mapcheck("_vv") == "" | |
4460 : map _vv :set guifont=7x13<CR> | |
4461 :endif | |
4462 < This avoids adding the "_vv" mapping when there already is a | |
4463 mapping for "_v" or for "_vvv". | |
4464 | |
19 | 4465 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 4466 When {expr} is a |List| then this returns the index of the |
4467 first item where {pat} matches. Each item is used as a | |
692 | 4468 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 4469 Otherwise, {expr} is used as a String. The result is a |
95 | 4470 Number, which gives the index (byte offset) in {expr} where |
4471 {pat} matches. | |
685 | 4472 A match at the first character or |List| item returns zero. |
19 | 4473 If there is no match -1 is returned. |
2833 | 4474 For getting submatches see |matchlist()|. |
19 | 4475 Example: > |
95 | 4476 :echo match("testing", "ing") " results in 4 |
714 | 4477 :echo match([1, 'x'], '\a') " results in 1 |
95 | 4478 < See |string-match| for how {pat} is used. |
170 | 4479 *strpbrk()* |
1621 | 4480 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 4481 :let sepidx = match(line, '[.,;: \t]') |
4482 < *strcasestr()* | |
4483 Vim doesn't have a strcasestr() function. But you can add | |
4484 "\c" to the pattern to ignore case: > | |
4485 :let idx = match(haystack, '\cneedle') | |
4486 < | |
95 | 4487 If {start} is given, the search starts from byte index |
685 | 4488 {start} in a String or item {start} in a |List|. |
7 | 4489 The result, however, is still the index counted from the |
236 | 4490 first character/item. Example: > |
7 | 4491 :echo match("testing", "ing", 2) |
4492 < result is again "4". > | |
4493 :echo match("testing", "ing", 4) | |
4494 < result is again "4". > | |
4495 :echo match("testing", "t", 2) | |
4496 < result is "3". | |
694 | 4497 For a String, if {start} > 0 then it is like the string starts |
703 | 4498 {start} bytes later, thus "^" will match at {start}. Except |
4499 when {count} is given, then it's like matches before the | |
4500 {start} byte are ignored (this is a bit complicated to keep it | |
4501 backwards compatible). | |
95 | 4502 For a String, if {start} < 0, it will be set to 0. For a list |
4503 the index is counted from the end. | |
697 | 4504 If {start} is out of range ({start} > strlen({expr}) for a |
4505 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 4506 |
694 | 4507 When {count} is given use the {count}'th match. When a match |
697 | 4508 is found in a String the search for the next one starts one |
694 | 4509 character further. Thus this example results in 1: > |
4510 echo match("testing", "..", 0, 2) | |
4511 < In a |List| the search continues in the next item. | |
703 | 4512 Note that when {count} is added the way {start} works changes, |
4513 see above. | |
694 | 4514 |
7 | 4515 See |pattern| for the patterns that are accepted. |
4516 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 4517 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 4518 done like 'magic' is set and 'cpoptions' is empty. |
4519 | |
1326 | 4520 *matchadd()* *E798* *E799* *E801* |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4521 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
1326 | 4522 Defines a pattern to be highlighted in the current window (a |
4523 "match"). It will be highlighted with {group}. Returns an | |
4524 identification number (ID), which can be used to delete the | |
4525 match using |matchdelete()|. | |
5466 | 4526 Matching is case sensitive and magic, unless case sensitivity |
4527 or magicness are explicitly overridden in {pattern}. The | |
4528 'magic', 'smartcase' and 'ignorecase' options are not used. | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4529 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
|
4530 concealed. |
1326 | 4531 |
4532 The optional {priority} argument assigns a priority to the | |
1621 | 4533 match. A match with a high priority will have its |
1326 | 4534 highlighting overrule that of a match with a lower priority. |
4535 A priority is specified as an integer (negative numbers are no | |
4536 exception). If the {priority} argument is not specified, the | |
4537 default priority is 10. The priority of 'hlsearch' is zero, | |
4538 hence all matches with a priority greater than zero will | |
4539 overrule it. Syntax highlighting (see 'syntax') is a separate | |
4540 mechanism, and regardless of the chosen priority a match will | |
4541 always overrule syntax highlighting. | |
4542 | |
4543 The optional {id} argument allows the request for a specific | |
4544 match ID. If a specified ID is already taken, an error | |
4545 message will appear and the match will not be added. An ID | |
4546 is specified as a positive integer (zero excluded). IDs 1, 2 | |
4547 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
6947 | 4548 respectively. If the {id} argument is not specified or -1, |
1326 | 4549 |matchadd()| automatically chooses a free ID. |
4550 | |
6947 | 4551 The optional {dict} argmument allows for further custom |
4552 values. Currently this is used to specify a match specifc | |
4553 conceal character that will be shown for |hl-Conceal| | |
4554 highlighted matches. The dict can have the following members: | |
4555 | |
4556 conceal Special character to show instead of the | |
4557 match (only for |hl-Conceal| highlighed | |
4558 matches, see |:syn-cchar|) | |
4559 | |
1326 | 4560 The number of matches is not limited, as it is the case with |
4561 the |:match| commands. | |
4562 | |
4563 Example: > | |
4564 :highlight MyGroup ctermbg=green guibg=green | |
4565 :let m = matchadd("MyGroup", "TODO") | |
4566 < Deletion of the pattern: > | |
4567 :call matchdelete(m) | |
4568 | |
4569 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 4570 available from |getmatches()|. All matches can be deleted in |
1326 | 4571 one operation by |clearmatches()|. |
819 | 4572 |
6947 | 4573 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
5979 | 4574 Same as |matchadd()|, but requires a list of positions {pos} |
4575 instead of a pattern. This command is faster than |matchadd()| | |
4576 because it does not require to handle regular expressions and | |
4577 sets buffer line boundaries to redraw screen. It is supposed | |
4578 to be used when fast match additions and deletions are | |
4579 required, for example to highlight matching parentheses. | |
4580 | |
4581 The list {pos} can contain one of these items: | |
6007 | 4582 - A number. This whole line will be highlighted. The first |
5979 | 4583 line has number 1. |
4584 - A list with one number, e.g., [23]. The whole line with this | |
4585 number will be highlighted. | |
4586 - A list with two numbers, e.g., [23, 11]. The first number is | |
6007 | 4587 the line number, the second one is the column number (first |
4588 column is 1, the value must correspond to the byte index as | |
4589 |col()| would return). The character at this position will | |
4590 be highlighted. | |
5979 | 4591 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
6007 | 4592 the third number gives the length of the highlight in bytes. |
5979 | 4593 |
4594 The maximum number of positions is 8. | |
4595 | |
4596 Example: > | |
4597 :highlight MyGroup ctermbg=green guibg=green | |
4598 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
4599 < Deletion of the pattern: > | |
4600 :call matchdelete(m) | |
4601 | |
4602 < Matches added by |matchaddpos()| are returned by | |
4603 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
4604 value a list like the {pos} item. | |
4605 These matches cannot be set via |setmatches()|, however they | |
4606 can still be deleted by |clearmatches()|. | |
4607 | |
819 | 4608 matcharg({nr}) *matcharg()* |
856 | 4609 Selects the {nr} match item, as set with a |:match|, |
819 | 4610 |:2match| or |:3match| command. |
4611 Return a |List| with two elements: | |
4612 The name of the highlight group used | |
4613 The pattern used. | |
4614 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
4615 When there is no match item set returns ['', '']. | |
1326 | 4616 This is useful to save and restore a |:match|. |
4617 Highlighting matches using the |:match| commands are limited | |
4618 to three matches. |matchadd()| does not have this limitation. | |
4619 | |
4620 matchdelete({id}) *matchdelete()* *E802* *E803* | |
4621 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 4622 or one of the |:match| commands. Returns 0 if successful, |
1326 | 4623 otherwise -1. See example for |matchadd()|. All matches can |
4624 be deleted in one operation by |clearmatches()|. | |
819 | 4625 |
19 | 4626 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4627 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4628 after the match. Example: > |
7 | 4629 :echo matchend("testing", "ing") |
4630 < results in "7". | |
170 | 4631 *strspn()* *strcspn()* |
4632 Vim doesn't have a strspn() or strcspn() function, but you can | |
4633 do it with matchend(): > | |
4634 :let span = matchend(line, '[a-zA-Z]') | |
4635 :let span = matchend(line, '[^a-zA-Z]') | |
4636 < Except that -1 is returned when there are no matches. | |
4637 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4638 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4639 :echo matchend("testing", "ing", 2) |
4640 < results in "7". > | |
4641 :echo matchend("testing", "ing", 5) | |
4642 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4643 When {expr} is a |List| the result is equal to |match()|. |
7 | 4644 |
158 | 4645 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4646 Same as |match()|, but return a |List|. The first item in the |
158 | 4647 list is the matched string, same as what matchstr() would |
4648 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 4649 in |:substitute|. When an optional submatch didn't match an |
4650 empty string is used. Example: > | |
4651 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
4652 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 4653 When there is no match an empty list is returned. |
4654 | |
19 | 4655 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 4656 Same as |match()|, but return the matched string. Example: > |
7 | 4657 :echo matchstr("testing", "ing") |
4658 < results in "ing". | |
4659 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4660 The {start}, if given, has the same meaning as for |match()|. > |
7 | 4661 :echo matchstr("testing", "ing", 2) |
4662 < results in "ing". > | |
4663 :echo matchstr("testing", "ing", 5) | |
4664 < result is "". | |
685 | 4665 When {expr} is a |List| then the matching item is returned. |
95 | 4666 The type isn't changed, it's not necessarily a String. |
7 | 4667 |
87 | 4668 *max()* |
4669 max({list}) Return the maximum value of all items in {list}. | |
4670 If {list} is not a list or one of the items in {list} cannot | |
4671 be used as a Number this results in an error. | |
685 | 4672 An empty |List| results in zero. |
87 | 4673 |
4674 *min()* | |
1215 | 4675 min({list}) Return the minimum value of all items in {list}. |
87 | 4676 If {list} is not a list or one of the items in {list} cannot |
4677 be used as a Number this results in an error. | |
685 | 4678 An empty |List| results in zero. |
87 | 4679 |
843 | 4680 *mkdir()* *E739* |
168 | 4681 mkdir({name} [, {path} [, {prot}]]) |
4682 Create directory {name}. | |
4683 If {path} is "p" then intermediate directories are created as | |
4684 necessary. Otherwise it must be "". | |
4685 If {prot} is given it is used to set the protection bits of | |
4686 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 4687 the user readable for others). Use 0700 to make it unreadable |
1702 | 4688 for others. This is only used for the last part of {name}. |
4689 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
4690 with 0755. | |
4691 Example: > | |
4692 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
4693 < This function is not available in the |sandbox|. | |
168 | 4694 Not available on all systems. To check use: > |
4695 :if exists("*mkdir") | |
4696 < | |
7 | 4697 *mode()* |
1621 | 4698 mode([expr]) Return a string that indicates the current mode. |
1661 | 4699 If [expr] is supplied and it evaluates to a non-zero Number or |
4700 a non-empty String (|non-zero-arg|), then the full mode is | |
4701 returned, otherwise only the first letter is returned. Note | |
4702 that " " and "0" are also non-empty strings. | |
1621 | 4703 |
7 | 4704 n Normal |
1621 | 4705 no Operator-pending |
7 | 4706 v Visual by character |
4707 V Visual by line | |
4708 CTRL-V Visual blockwise | |
4709 s Select by character | |
4710 S Select by line | |
4711 CTRL-S Select blockwise | |
4712 i Insert | |
1621 | 4713 R Replace |R| |
4714 Rv Virtual Replace |gR| | |
7 | 4715 c Command-line |
1621 | 4716 cv Vim Ex mode |gQ| |
4717 ce Normal Ex mode |Q| | |
7 | 4718 r Hit-enter prompt |
1621 | 4719 rm The -- more -- prompt |
4720 r? A |:confirm| query of some sort | |
4721 ! Shell or external command is executing | |
4722 This is useful in the 'statusline' option or when used | |
4723 with |remote_expr()| In most other places it always returns | |
4724 "c" or "n". | |
4725 Also see |visualmode()|. | |
7 | 4726 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4727 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4728 Evaluate MzScheme expression {expr} and return its result |
3492 | 4729 converted to Vim data structures. |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4730 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4731 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
|
4732 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4733 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
|
4734 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4735 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
|
4736 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4737 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4738 :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
|
4739 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4740 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4741 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4742 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4743 |
7 | 4744 nextnonblank({lnum}) *nextnonblank()* |
4745 Return the line number of the first line at or below {lnum} | |
4746 that is not blank. Example: > | |
4747 if getline(nextnonblank(1)) =~ "Java" | |
4748 < When {lnum} is invalid or there is no non-blank line at or | |
4749 below it, zero is returned. | |
4750 See also |prevnonblank()|. | |
4751 | |
4051 | 4752 nr2char({expr}[, {utf8}]) *nr2char()* |
7 | 4753 Return a string with a single character, which has the number |
4754 value {expr}. Examples: > | |
4755 nr2char(64) returns "@" | |
4756 nr2char(32) returns " " | |
4051 | 4757 < When {utf8} is omitted or zero, the current 'encoding' is used. |
4758 Example for "utf-8": > | |
7 | 4759 nr2char(300) returns I with bow character |
4051 | 4760 < With {utf8} set to 1, always return utf-8 characters. |
4761 Note that a NUL character in the file is specified with | |
7 | 4762 nr2char(10), because NULs are represented with newline |
4763 characters. nr2char(0) is a real NUL and terminates the | |
119 | 4764 string, thus results in an empty string. |
7 | 4765 |
3214 | 4766 or({expr}, {expr}) *or()* |
4767 Bitwise OR on the two arguments. The arguments are converted | |
4768 to a number. A List, Dict or Float argument causes an error. | |
4769 Example: > | |
4770 :let bits = or(bits, 0x80) | |
4771 | |
4772 | |
819 | 4773 pathshorten({expr}) *pathshorten()* |
4774 Shorten directory names in the path {expr} and return the | |
4775 result. The tail, the file name, is kept as-is. The other | |
4776 components in the path are reduced to single letters. Leading | |
4777 '~' and '.' characters are kept. Example: > | |
4778 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
4779 < ~/.v/a/myfile.vim ~ | |
4780 It doesn't matter if the path exists or not. | |
4781 | |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4782 perleval({expr}) *perleval()* |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4783 Evaluate Perl expression {expr} in scalar context and return |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4784 its result converted to Vim data structures. If value can't be |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4785 converted, it returned as string Perl representation. |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4786 Note: If you want a array or hash, {expr} must returns an |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4787 reference of it. |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4788 Example: > |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4789 :echo perleval('[1 .. 4]') |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4790 < [1, 2, 3, 4] |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4791 {only available when compiled with the |+perl| feature} |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4792 |
1621 | 4793 pow({x}, {y}) *pow()* |
4794 Return the power of {x} to the exponent {y} as a |Float|. | |
4795 {x} and {y} must evaluate to a |Float| or a |Number|. | |
4796 Examples: > | |
4797 :echo pow(3, 3) | |
4798 < 27.0 > | |
4799 :echo pow(2, 16) | |
4800 < 65536.0 > | |
4801 :echo pow(32, 0.20) | |
4802 < 2.0 | |
4803 {only available when compiled with the |+float| feature} | |
4804 | |
667 | 4805 prevnonblank({lnum}) *prevnonblank()* |
4806 Return the line number of the first line at or above {lnum} | |
4807 that is not blank. Example: > | |
4808 let ind = indent(prevnonblank(v:lnum - 1)) | |
4809 < When {lnum} is invalid or there is no non-blank line at or | |
4810 above it, zero is returned. | |
4811 Also see |nextnonblank()|. | |
4812 | |
4813 | |
449 | 4814 printf({fmt}, {expr1} ...) *printf()* |
4815 Return a String with {fmt}, where "%" items are replaced by | |
4816 the formatted form of their respective arguments. Example: > | |
452 | 4817 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 4818 < May result in: |
452 | 4819 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 4820 |
4821 Often used items are: | |
856 | 4822 %s string |
3914 | 4823 %6S string right-aligned in 6 display cells |
653 | 4824 %6s string right-aligned in 6 bytes |
1621 | 4825 %.9s string truncated to 9 bytes |
4826 %c single byte | |
4827 %d decimal number | |
4828 %5d decimal number padded with spaces to 5 characters | |
4829 %x hex number | |
4830 %04x hex number padded with zeros to at least 4 characters | |
4831 %X hex number using upper case letters | |
4832 %o octal number | |
4833 %f floating point number in the form 123.456 | |
4834 %e floating point number in the form 1.234e3 | |
4835 %E floating point number in the form 1.234E3 | |
4836 %g floating point number, as %f or %e depending on value | |
4837 %G floating point number, as %f or %E depending on value | |
4838 %% the % character itself | |
449 | 4839 |
4840 Conversion specifications start with '%' and end with the | |
4841 conversion type. All other characters are copied unchanged to | |
4842 the result. | |
4843 | |
4844 The "%" starts a conversion specification. The following | |
452 | 4845 arguments appear in sequence: |
4846 | |
4847 % [flags] [field-width] [.precision] type | |
4848 | |
856 | 4849 flags |
452 | 4850 Zero or more of the following flags: |
4851 | |
449 | 4852 # The value should be converted to an "alternate |
4853 form". For c, d, and s conversions, this option | |
4854 has no effect. For o conversions, the precision | |
4855 of the number is increased to force the first | |
4856 character of the output string to a zero (except | |
4857 if a zero value is printed with an explicit | |
4858 precision of zero). | |
4859 For x and X conversions, a non-zero result has | |
4860 the string "0x" (or "0X" for X conversions) | |
4861 prepended to it. | |
452 | 4862 |
449 | 4863 0 (zero) Zero padding. For all conversions the converted |
4864 value is padded on the left with zeros rather | |
4865 than blanks. If a precision is given with a | |
4866 numeric conversion (d, o, x, and X), the 0 flag | |
4867 is ignored. | |
452 | 4868 |
449 | 4869 - A negative field width flag; the converted value |
4870 is to be left adjusted on the field boundary. | |
4871 The converted value is padded on the right with | |
4872 blanks, rather than on the left with blanks or | |
4873 zeros. A - overrides a 0 if both are given. | |
452 | 4874 |
449 | 4875 ' ' (space) A blank should be left before a positive |
4876 number produced by a signed conversion (d). | |
452 | 4877 |
449 | 4878 + A sign must always be placed before a number |
1621 | 4879 produced by a signed conversion. A + overrides |
449 | 4880 a space if both are used. |
452 | 4881 |
4882 field-width | |
4883 An optional decimal digit string specifying a minimum | |
653 | 4884 field width. If the converted value has fewer bytes |
4885 than the field width, it will be padded with spaces on | |
4886 the left (or right, if the left-adjustment flag has | |
4887 been given) to fill out the field width. | |
452 | 4888 |
4889 .precision | |
4890 An optional precision, in the form of a period '.' | |
4891 followed by an optional digit string. If the digit | |
4892 string is omitted, the precision is taken as zero. | |
4893 This gives the minimum number of digits to appear for | |
4894 d, o, x, and X conversions, or the maximum number of | |
653 | 4895 bytes to be printed from a string for s conversions. |
1621 | 4896 For floating point it is the number of digits after |
4897 the decimal point. | |
452 | 4898 |
4899 type | |
4900 A character that specifies the type of conversion to | |
4901 be applied, see below. | |
4902 | |
449 | 4903 A field width or precision, or both, may be indicated by an |
4904 asterisk '*' instead of a digit string. In this case, a | |
1621 | 4905 Number argument supplies the field width or precision. A |
449 | 4906 negative field width is treated as a left adjustment flag |
4907 followed by a positive field width; a negative precision is | |
4908 treated as though it were missing. Example: > | |
452 | 4909 :echo printf("%d: %.*s", nr, width, line) |
449 | 4910 < This limits the length of the text used from "line" to |
452 | 4911 "width" bytes. |
449 | 4912 |
856 | 4913 The conversion specifiers and their meanings are: |
452 | 4914 |
1621 | 4915 *printf-d* *printf-o* *printf-x* *printf-X* |
4916 doxX The Number argument is converted to signed decimal | |
449 | 4917 (d), unsigned octal (o), or unsigned hexadecimal (x |
4918 and X) notation. The letters "abcdef" are used for | |
4919 x conversions; the letters "ABCDEF" are used for X | |
452 | 4920 conversions. |
4921 The precision, if any, gives the minimum number of | |
4922 digits that must appear; if the converted value | |
4923 requires fewer digits, it is padded on the left with | |
4924 zeros. | |
4925 In no case does a non-existent or small field width | |
4926 cause truncation of a numeric field; if the result of | |
4927 a conversion is wider than the field width, the field | |
4928 is expanded to contain the conversion result. | |
4929 | |
1621 | 4930 *printf-c* |
452 | 4931 c The Number argument is converted to a byte, and the |
4932 resulting character is written. | |
4933 | |
1621 | 4934 *printf-s* |
452 | 4935 s The text of the String argument is used. If a |
4936 precision is specified, no more bytes than the number | |
4937 specified are used. | |
6583 | 4938 *printf-S* |
3914 | 4939 S The text of the String argument is used. If a |
4940 precision is specified, no more display cells than the | |
4941 number specified are used. Without the |+multi_byte| | |
4942 feature works just like 's'. | |
452 | 4943 |
1621 | 4944 *printf-f* *E807* |
4945 f The Float argument is converted into a string of the | |
4946 form 123.456. The precision specifies the number of | |
4947 digits after the decimal point. When the precision is | |
4948 zero the decimal point is omitted. When the precision | |
4949 is not specified 6 is used. A really big number | |
4950 (out of range or dividing by zero) results in "inf". | |
4951 "0.0 / 0.0" results in "nan". | |
4952 Example: > | |
4953 echo printf("%.2f", 12.115) | |
4954 < 12.12 | |
4955 Note that roundoff depends on the system libraries. | |
4956 Use |round()| when in doubt. | |
4957 | |
4958 *printf-e* *printf-E* | |
4959 e E The Float argument is converted into a string of the | |
4960 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
4961 precision specifies the number of digits after the | |
4962 decimal point, like with 'f'. | |
4963 | |
4964 *printf-g* *printf-G* | |
4965 g G The Float argument is converted like with 'f' if the | |
4966 value is between 0.001 (inclusive) and 10000000.0 | |
4967 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
4968 for 'G'. When no precision is specified superfluous | |
4969 zeroes and '+' signs are removed, except for the zero | |
4970 immediately after the decimal point. Thus 10000000.0 | |
4971 results in 1.0e7. | |
4972 | |
4973 *printf-%* | |
449 | 4974 % A '%' is written. No argument is converted. The |
4975 complete conversion specification is "%%". | |
452 | 4976 |
1668 | 4977 When a Number argument is expected a String argument is also |
4978 accepted and automatically converted. | |
4979 When a Float or String argument is expected a Number argument | |
4980 is also accepted and automatically converted. | |
4981 Any other argument type results in an error message. | |
449 | 4982 |
459 | 4983 *E766* *E767* |
449 | 4984 The number of {exprN} arguments must exactly match the number |
4985 of "%" items. If there are not sufficient or too many | |
452 | 4986 arguments an error is given. Up to 18 arguments can be used. |
449 | 4987 |
4988 | |
667 | 4989 pumvisible() *pumvisible()* |
4990 Returns non-zero when the popup menu is visible, zero | |
4991 otherwise. See |ins-completion-menu|. | |
712 | 4992 This can be used to avoid some things that would remove the |
4993 popup menu. | |
7 | 4994 |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
4995 *E860* |
3682 | 4996 py3eval({expr}) *py3eval()* |
4997 Evaluate Python expression {expr} and return its result | |
4998 converted to Vim data structures. | |
4999 Numbers and strings are returned as they are (strings are | |
6647 | 5000 copied though, Unicode strings are additionally converted to |
3682 | 5001 'encoding'). |
5002 Lists are represented as Vim |List| type. | |
5003 Dictionaries are represented as Vim |Dictionary| type with | |
5004 keys converted to strings. | |
5005 {only available when compiled with the |+python3| feature} | |
5006 | |
5007 *E858* *E859* | |
5008 pyeval({expr}) *pyeval()* | |
5009 Evaluate Python expression {expr} and return its result | |
5010 converted to Vim data structures. | |
5011 Numbers and strings are returned as they are (strings are | |
5012 copied though). | |
5013 Lists are represented as Vim |List| type. | |
3830 | 5014 Dictionaries are represented as Vim |Dictionary| type, |
5015 non-string keys result in error. | |
3682 | 5016 {only available when compiled with the |+python| feature} |
5017 | |
114 | 5018 *E726* *E727* |
99 | 5019 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 5020 Returns a |List| with Numbers: |
99 | 5021 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
5022 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
5023 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
5024 {max}] (increasing {expr} with {stride} each time, not | |
5025 producing a value past {max}). | |
336 | 5026 When the maximum is one before the start the result is an |
5027 empty list. When the maximum is more than one before the | |
5028 start this is an error. | |
99 | 5029 Examples: > |
856 | 5030 range(4) " [0, 1, 2, 3] |
99 | 5031 range(2, 4) " [2, 3, 4] |
5032 range(2, 9, 3) " [2, 5, 8] | |
856 | 5033 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 5034 range(0) " [] |
5035 range(2, 0) " error! | |
99 | 5036 < |
158 | 5037 *readfile()* |
168 | 5038 readfile({fname} [, {binary} [, {max}]]) |
685 | 5039 Read file {fname} and return a |List|, each line of the file |
5040 as an item. Lines broken at NL characters. Macintosh files | |
158 | 5041 separated with CR will result in a single long line (unless a |
5042 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
|
5043 All NUL characters are replaced with a NL character. |
6918 | 5044 When {binary} contains "b" binary mode is used: |
158 | 5045 - When the last line ends in a NL an extra empty list item is |
5046 added. | |
5047 - No CR characters are removed. | |
5048 Otherwise: | |
5049 - CR characters that appear before a NL are removed. | |
5050 - 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
|
5051 - 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
|
5052 removed from the text. |
168 | 5053 When {max} is given this specifies the maximum number of lines |
5054 to be read. Useful if you only want to check the first ten | |
5055 lines of a file: > | |
5056 :for line in readfile(fname, '', 10) | |
5057 : if line =~ 'Date' | echo line | endif | |
5058 :endfor | |
233 | 5059 < When {max} is negative -{max} lines from the end of the file |
5060 are returned, or as many as there are. | |
5061 When {max} is zero the result is an empty list. | |
168 | 5062 Note that without {max} the whole file is read into memory. |
5063 Also note that there is no recognition of encoding. Read a | |
5064 file into a buffer if you need to. | |
158 | 5065 When the file can't be opened an error message is given and |
5066 the result is an empty list. | |
5067 Also see |writefile()|. | |
5068 | |
794 | 5069 reltime([{start} [, {end}]]) *reltime()* |
5070 Return an item that represents a time value. The format of | |
5071 the item depends on the system. It can be passed to | |
5072 |reltimestr()| to convert it to a string. | |
5073 Without an argument it returns the current time. | |
5074 With one argument is returns the time passed since the time | |
5075 specified in the argument. | |
843 | 5076 With two arguments it returns the time passed between {start} |
794 | 5077 and {end}. |
5078 The {start} and {end} arguments must be values returned by | |
5079 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5080 {only available when compiled with the |+reltime| feature} |
794 | 5081 |
5082 reltimestr({time}) *reltimestr()* | |
5083 Return a String that represents the time value of {time}. | |
5084 This is the number of seconds, a dot and the number of | |
5085 microseconds. Example: > | |
5086 let start = reltime() | |
5087 call MyFunction() | |
5088 echo reltimestr(reltime(start)) | |
5089 < Note that overhead for the commands will be added to the time. | |
5090 The accuracy depends on the system. | |
1156 | 5091 Leading spaces are used to make the string align nicely. You |
5092 can use split() to remove it. > | |
5093 echo split(reltimestr(reltime(start)))[0] | |
5094 < 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
|
5095 {only available when compiled with the |+reltime| feature} |
794 | 5096 |
7 | 5097 *remote_expr()* *E449* |
5098 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 5099 Send the {string} to {server}. The string is sent as an |
7 | 5100 expression and the result is returned after evaluation. |
714 | 5101 The result must be a String or a |List|. A |List| is turned |
5102 into a String by joining the items with a line break in | |
5103 between (not at the end), like with join(expr, "\n"). | |
7 | 5104 If {idvar} is present, it is taken as the name of a |
5105 variable and a {serverid} for later use with | |
5106 remote_read() is stored there. | |
5107 See also |clientserver| |RemoteReply|. | |
5108 This function is not available in the |sandbox|. | |
5109 {only available when compiled with the |+clientserver| feature} | |
5110 Note: Any errors will cause a local error message to be issued | |
5111 and the result will be the empty string. | |
5112 Examples: > | |
5113 :echo remote_expr("gvim", "2+2") | |
5114 :echo remote_expr("gvim1", "b:current_syntax") | |
5115 < | |
5116 | |
5117 remote_foreground({server}) *remote_foreground()* | |
5118 Move the Vim server with the name {server} to the foreground. | |
5119 This works like: > | |
5120 remote_expr({server}, "foreground()") | |
5121 < Except that on Win32 systems the client does the work, to work | |
5122 around the problem that the OS doesn't always allow the server | |
5123 to bring itself to the foreground. | |
574 | 5124 Note: This does not restore the window if it was minimized, |
5125 like foreground() does. | |
7 | 5126 This function is not available in the |sandbox|. |
5127 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
5128 Win32 console version} | |
5129 | |
5130 | |
5131 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
5132 Returns a positive number if there are available strings | |
5133 from {serverid}. Copies any reply string into the variable | |
1621 | 5134 {retvar} if specified. {retvar} must be a string with the |
7 | 5135 name of a variable. |
5136 Returns zero if none are available. | |
5137 Returns -1 if something is wrong. | |
5138 See also |clientserver|. | |
5139 This function is not available in the |sandbox|. | |
5140 {only available when compiled with the |+clientserver| feature} | |
5141 Examples: > | |
5142 :let repl = "" | |
5143 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
5144 | |
5145 remote_read({serverid}) *remote_read()* | |
5146 Return the oldest available reply from {serverid} and consume | |
5147 it. It blocks until a reply is available. | |
5148 See also |clientserver|. | |
5149 This function is not available in the |sandbox|. | |
5150 {only available when compiled with the |+clientserver| feature} | |
5151 Example: > | |
5152 :echo remote_read(id) | |
5153 < | |
5154 *remote_send()* *E241* | |
5155 remote_send({server}, {string} [, {idvar}]) | |
1621 | 5156 Send the {string} to {server}. The string is sent as input |
22 | 5157 keys and the function returns immediately. At the Vim server |
5158 the keys are not mapped |:map|. | |
667 | 5159 If {idvar} is present, it is taken as the name of a variable |
5160 and a {serverid} for later use with remote_read() is stored | |
5161 there. | |
7 | 5162 See also |clientserver| |RemoteReply|. |
5163 This function is not available in the |sandbox|. | |
5164 {only available when compiled with the |+clientserver| feature} | |
5165 Note: Any errors will be reported in the server and may mess | |
5166 up the display. | |
5167 Examples: > | |
5168 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
5169 \ remote_read(serverid) | |
5170 | |
5171 :autocmd NONE RemoteReply * | |
5172 \ echo remote_read(expand("<amatch>")) | |
5173 :echo remote_send("gvim", ":sleep 10 | echo ". | |
5174 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 5175 < |
79 | 5176 remove({list}, {idx} [, {end}]) *remove()* |
685 | 5177 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
|
5178 return the item. |
79 | 5179 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5180 return a List with these items. When {idx} points to the same |
79 | 5181 item as {end} a list with one item is returned. When {end} |
5182 points to an item before {idx} this is an error. | |
5183 See |list-index| for possible values of {idx} and {end}. | |
55 | 5184 Example: > |
5185 :echo "last item: " . remove(mylist, -1) | |
79 | 5186 :call remove(mylist, 0, 9) |
99 | 5187 remove({dict}, {key}) |
5188 Remove the entry from {dict} with key {key}. Example: > | |
5189 :echo "removed " . remove(dict, "one") | |
5190 < If there is no {key} in {dict} this is an error. | |
5191 | |
5192 Use |delete()| to remove a file. | |
55 | 5193 |
7 | 5194 rename({from}, {to}) *rename()* |
5195 Rename the file by the name {from} to the name {to}. This | |
5196 should also work to move files across file systems. The | |
5197 result is a Number, which is 0 if the file was renamed | |
5198 successfully, and non-zero when the renaming failed. | |
1851 | 5199 NOTE: If {to} exists it is overwritten without warning. |
7 | 5200 This function is not available in the |sandbox|. |
5201 | |
18 | 5202 repeat({expr}, {count}) *repeat()* |
5203 Repeat {expr} {count} times and return the concatenated | |
5204 result. Example: > | |
843 | 5205 :let separator = repeat('-', 80) |
18 | 5206 < When {count} is zero or negative the result is empty. |
685 | 5207 When {expr} is a |List| the result is {expr} concatenated |
1621 | 5208 {count} times. Example: > |
79 | 5209 :let longlist = repeat(['a', 'b'], 3) |
5210 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 5211 |
82 | 5212 |
7 | 5213 resolve({filename}) *resolve()* *E655* |
5214 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
5215 returns the path the shortcut points to in a simplified form. | |
5216 On Unix, repeat resolving symbolic links in all path | |
5217 components of {filename} and return the simplified result. | |
5218 To cope with link cycles, resolving of symbolic links is | |
5219 stopped after 100 iterations. | |
5220 On other systems, return the simplified {filename}. | |
5221 The simplification step is done as by |simplify()|. | |
5222 resolve() keeps a leading path component specifying the | |
5223 current directory (provided the result is still a relative | |
5224 path name) and also keeps a trailing path separator. | |
5225 | |
82 | 5226 *reverse()* |
1621 | 5227 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 5228 {list}. |
5229 If you want a list to remain unmodified make a copy first: > | |
5230 :let revlist = reverse(copy(mylist)) | |
5231 | |
1621 | 5232 round({expr}) *round()* |
1668 | 5233 Round off {expr} to the nearest integral value and return it |
1621 | 5234 as a |Float|. If {expr} lies halfway between two integral |
5235 values, then use the larger one (away from zero). | |
5236 {expr} must evaluate to a |Float| or a |Number|. | |
5237 Examples: > | |
5238 echo round(0.456) | |
5239 < 0.0 > | |
5240 echo round(4.5) | |
5241 < 5.0 > | |
5242 echo round(-4.5) | |
5243 < -5.0 | |
5244 {only available when compiled with the |+float| feature} | |
3996 | 5245 |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5246 screenattr(row, col) *screenattr()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5247 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
|
5248 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
|
5249 attribute at other positions. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5250 |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5251 screenchar(row, col) *screenchar()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5252 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
|
5253 [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
|
5254 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
|
5255 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
|
5256 The character excludes composing characters. For double-byte |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5257 encodings it may only be the first byte. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5258 This is mainly to be used for testing. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5259 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
|
5260 |
3996 | 5261 screencol() *screencol()* |
5262 The result is a Number, which is the current screen column of | |
5263 the cursor. The leftmost column has number 1. | |
5264 This function is mainly used for testing. | |
5265 | |
5266 Note: Always returns the current screen column, thus if used | |
5267 in a command (e.g. ":echo screencol()") it will return the | |
5268 column inside the command line, which is 1 when the command is | |
5269 executed. To get the cursor position in the file use one of | |
5270 the following mappings: > | |
5271 nnoremap <expr> GG ":echom ".screencol()."\n" | |
5272 nnoremap <silent> GG :echom screencol()<CR> | |
5273 < | |
5274 screenrow() *screenrow()* | |
5275 The result is a Number, which is the current screen row of the | |
5276 cursor. The top line has number one. | |
5277 This function is mainly used for testing. | |
5278 | |
5279 Note: Same restrictions as with |screencol()|. | |
5280 | |
1496 | 5281 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 5282 Search for regexp pattern {pattern}. The search starts at the |
119 | 5283 cursor position (you can use |cursor()| to set it). |
707 | 5284 |
3967 | 5285 When a match has been found its line number is returned. |
3312 | 5286 If there is no match a 0 is returned and the cursor doesn't |
5287 move. No error message is given. | |
5288 | |
7 | 5289 {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
|
5290 'b' search Backward instead of forward |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5291 'c' accept a match at the Cursor position |
712 | 5292 'e' move to the End of the match |
20 | 5293 '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
|
5294 '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
|
5295 '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
|
5296 '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
|
5297 '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
|
5298 'z' start searching at the cursor column instead of zero |
7 | 5299 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
5300 | |
444 | 5301 If the 's' flag is supplied, the ' mark is set, only if the |
5302 cursor is moved. The 's' flag cannot be combined with the 'n' | |
5303 flag. | |
5304 | |
1156 | 5305 '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
|
5306 |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5307 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
|
5308 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
|
5309 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
|
5310 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
|
5311 one column further. |
1156 | 5312 |
692 | 5313 When the {stopline} argument is given then the search stops |
5314 after searching this line. This is useful to restrict the | |
5315 search to a range of lines. Examples: > | |
5316 let match = search('(', 'b', line("w0")) | |
5317 let end = search('END', '', line("w$")) | |
5318 < When {stopline} is used and it is not zero this also implies | |
5319 that the search does not wrap around the end of the file. | |
1496 | 5320 A zero value is equal to not giving the argument. |
5321 | |
5322 When the {timeout} argument is given the search stops when | |
3513 | 5323 more than this many milliseconds have passed. Thus when |
1496 | 5324 {timeout} is 500 the search stops after half a second. |
5325 The value must not be negative. A zero value is like not | |
5326 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
|
5327 {only available when compiled with the |+reltime| feature} |
692 | 5328 |
714 | 5329 *search()-sub-match* |
5330 With the 'p' flag the returned value is one more than the | |
5331 first sub-match in \(\). One if none of them matched but the | |
5332 whole pattern did match. | |
712 | 5333 To get the column number too use |searchpos()|. |
5334 | |
20 | 5335 The cursor will be positioned at the match, unless the 'n' |
707 | 5336 flag is used. |
7 | 5337 |
5338 Example (goes over all files in the argument list): > | |
5339 :let n = 1 | |
5340 :while n <= argc() " loop over all files in arglist | |
5341 : exe "argument " . n | |
5342 : " start at the last char in the file and wrap for the | |
5343 : " first search to find match at start of file | |
5344 : normal G$ | |
5345 : let flags = "w" | |
5346 : while search("foo", flags) > 0 | |
1621 | 5347 : s/foo/bar/g |
7 | 5348 : let flags = "W" |
5349 : endwhile | |
5350 : update " write the file if modified | |
5351 : let n = n + 1 | |
5352 :endwhile | |
5353 < | |
712 | 5354 Example for using some flags: > |
5355 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
5356 < This will search for the keywords "if", "else", and "endif" | |
5357 under or after the cursor. Because of the 'p' flag, it | |
5358 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
5359 if the search fails. With the cursor on the first word of the | |
5360 line: | |
5361 if (foo == 0) | let foo = foo + 1 | endif ~ | |
5362 the function returns 1. Without the 'c' flag, the function | |
5363 finds the "endif" and returns 3. The same thing happens | |
5364 without the 'e' flag if the cursor is on the "f" of "if". | |
5365 The 'n' flag tells the function not to move the cursor. | |
5366 | |
504 | 5367 |
523 | 5368 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
5369 Search for the declaration of {name}. | |
856 | 5370 |
523 | 5371 With a non-zero {global} argument it works like |gD|, find |
5372 first match in the file. Otherwise it works like |gd|, find | |
5373 first match in the function. | |
5374 | |
5375 With a non-zero {thisblock} argument matches in a {} block | |
5376 that ends before the cursor position are ignored. Avoids | |
5377 finding variable declarations only valid in another scope. | |
5378 | |
504 | 5379 Moves the cursor to the found match. |
5380 Returns zero for success, non-zero for failure. | |
5381 Example: > | |
5382 if searchdecl('myvar') == 0 | |
5383 echo getline('.') | |
5384 endif | |
5385 < | |
7 | 5386 *searchpair()* |
1496 | 5387 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
5388 [, {stopline} [, {timeout}]]]]) | |
7 | 5389 Search for the match of a nested start-end pair. This can be |
5390 used to find the "endif" that matches an "if", while other | |
5391 if/endif pairs in between are ignored. | |
677 | 5392 The search starts at the cursor. The default is to search |
5393 forward, include 'b' in {flags} to search backward. | |
5394 If a match is found, the cursor is positioned at it and the | |
5395 line number is returned. If no match is found 0 or -1 is | |
5396 returned and the cursor doesn't move. No error message is | |
5397 given. | |
7 | 5398 |
5399 {start}, {middle} and {end} are patterns, see |pattern|. They | |
5400 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
5401 {middle} is not empty, it is found when searching from either | |
5402 direction, but only when not in a nested start-end pair. A | |
5403 typical use is: > | |
5404 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
5405 < By leaving {middle} empty the "else" is skipped. | |
5406 | |
712 | 5407 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
5408 |search()|. Additionally: | |
7 | 5409 'r' Repeat until no more matches found; will find the |
1621 | 5410 outer pair. Implies the 'W' flag. |
5411 'm' Return number of matches instead of line number with | |
712 | 5412 the match; will be > 1 when 'r' is used. |
1621 | 5413 Note: it's nearly always a good idea to use the 'W' flag, to |
5414 avoid wrapping around the end of the file. | |
7 | 5415 |
5416 When a match for {start}, {middle} or {end} is found, the | |
5417 {skip} expression is evaluated with the cursor positioned on | |
5418 the start of the match. It should return non-zero if this | |
5419 match is to be skipped. E.g., because it is inside a comment | |
5420 or a string. | |
5421 When {skip} is omitted or empty, every match is accepted. | |
5422 When evaluating {skip} causes an error the search is aborted | |
5423 and -1 returned. | |
5424 | |
1496 | 5425 For {stopline} and {timeout} see |search()|. |
692 | 5426 |
7 | 5427 The value of 'ignorecase' is used. 'magic' is ignored, the |
5428 patterns are used like it's on. | |
5429 | |
5430 The search starts exactly at the cursor. A match with | |
5431 {start}, {middle} or {end} at the next character, in the | |
5432 direction of searching, is the first one found. Example: > | |
5433 if 1 | |
5434 if 2 | |
5435 endif 2 | |
5436 endif 1 | |
5437 < When starting at the "if 2", with the cursor on the "i", and | |
5438 searching forwards, the "endif 2" is found. When starting on | |
5439 the character just before the "if 2", the "endif 1" will be | |
1621 | 5440 found. That's because the "if 2" will be found first, and |
7 | 5441 then this is considered to be a nested if/endif from "if 2" to |
5442 "endif 2". | |
5443 When searching backwards and {end} is more than one character, | |
5444 it may be useful to put "\zs" at the end of the pattern, so | |
5445 that when the cursor is inside a match with the end it finds | |
5446 the matching start. | |
5447 | |
5448 Example, to find the "endif" command in a Vim script: > | |
5449 | |
5450 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
5451 \ 'getline(".") =~ "^\\s*\""') | |
5452 | |
5453 < The cursor must be at or after the "if" for which a match is | |
5454 to be found. Note that single-quote strings are used to avoid | |
5455 having to double the backslashes. The skip expression only | |
5456 catches comments at the start of a line, not after a command. | |
5457 Also, a word "en" or "if" halfway a line is considered a | |
5458 match. | |
5459 Another example, to search for the matching "{" of a "}": > | |
5460 | |
5461 :echo searchpair('{', '', '}', 'bW') | |
5462 | |
5463 < This works when the cursor is at or before the "}" for which a | |
5464 match is to be found. To reject matches that syntax | |
5465 highlighting recognized as strings: > | |
5466 | |
5467 :echo searchpair('{', '', '}', 'bW', | |
5468 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
5469 < | |
667 | 5470 *searchpairpos()* |
1496 | 5471 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
5472 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5473 Same as |searchpair()|, but returns a |List| with the line and |
685 | 5474 column position of the match. The first element of the |List| |
5475 is the line number and the second element is the byte index of | |
667 | 5476 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
|
5477 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5478 |
667 | 5479 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
5480 < | |
5481 See |match-parens| for a bigger and more useful example. | |
5482 | |
1496 | 5483 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 5484 Same as |search()|, but returns a |List| with the line and |
685 | 5485 column position of the match. The first element of the |List| |
5486 is the line number and the second element is the byte index of | |
5487 the column position of the match. If no match is found, | |
5488 returns [0, 0]. | |
714 | 5489 Example: > |
5490 :let [lnum, col] = searchpos('mypattern', 'n') | |
5491 | |
5492 < When the 'p' flag is given then there is an extra item with | |
5493 the sub-pattern match number |search()-sub-match|. Example: > | |
5494 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
5495 < In this example "submatch" is 2 when a lowercase letter is | |
5496 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
5497 | |
7 | 5498 server2client( {clientid}, {string}) *server2client()* |
5499 Send a reply string to {clientid}. The most recent {clientid} | |
5500 that sent a string can be retrieved with expand("<client>"). | |
5501 {only available when compiled with the |+clientserver| feature} | |
5502 Note: | |
5503 This id has to be stored before the next command can be | |
236 | 5504 received. I.e. before returning from the received command and |
7 | 5505 before calling any commands that waits for input. |
5506 See also |clientserver|. | |
5507 Example: > | |
5508 :echo server2client(expand("<client>"), "HELLO") | |
5509 < | |
5510 serverlist() *serverlist()* | |
5511 Return a list of available server names, one per line. | |
5512 When there are no servers or the information is not available | |
5513 an empty string is returned. See also |clientserver|. | |
5514 {only available when compiled with the |+clientserver| feature} | |
5515 Example: > | |
5516 :echo serverlist() | |
5517 < | |
5518 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
5519 Set option or local variable {varname} in buffer {expr} to | |
5520 {val}. | |
5521 This also works for a global or local window option, but it | |
5522 doesn't work for a global or local window variable. | |
5523 For a local window option the global value is unchanged. | |
5524 For the use of {expr}, see |bufname()| above. | |
5525 Note that the variable name without "b:" must be used. | |
5526 Examples: > | |
5527 :call setbufvar(1, "&mod", 1) | |
5528 :call setbufvar("todo", "myvar", "foobar") | |
5529 < This function is not available in the |sandbox|. | |
5530 | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
5531 setcharsearch({dict}) *setcharsearch()* |
6991 | 5532 Set the current character search information to {dict}, |
5533 which contains one or more of the following entries: | |
5534 | |
5535 char character which will be used for a subsequent | |
5536 |,| or |;| command; an empty string clears the | |
5537 character search | |
5538 forward direction of character search; 1 for forward, | |
5539 0 for backward | |
5540 until type of character search; 1 for a |t| or |T| | |
5541 character search, 0 for an |f| or |F| | |
5542 character search | |
5543 | |
5544 This can be useful to save/restore a user's character search | |
5545 from a script: > | |
5546 :let prevsearch = getcharsearch() | |
5547 :" Perform a command which clobbers user's search | |
5548 :call setcharsearch(prevsearch) | |
5549 < Also see |getcharsearch()|. | |
5550 | |
7 | 5551 setcmdpos({pos}) *setcmdpos()* |
5552 Set the cursor position in the command line to byte position | |
1621 | 5553 {pos}. The first position is 1. |
7 | 5554 Use |getcmdpos()| to obtain the current position. |
5555 Only works while editing the command line, thus you must use | |
99 | 5556 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
5557 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
5558 set after the command line is set to the expression. For | |
5559 |c_CTRL-R_=| it is set after evaluating the expression but | |
5560 before inserting the resulting text. | |
7 | 5561 When the number is too big the cursor is put at the end of the |
5562 line. A number smaller than one has undefined results. | |
5563 Returns 0 when successful, 1 when not editing the command | |
5564 line. | |
5565 | |
1621 | 5566 setline({lnum}, {text}) *setline()* |
3312 | 5567 Set line {lnum} of the current buffer to {text}. To insert |
5568 lines use |append()|. | |
236 | 5569 {lnum} is used like with |getline()|. |
1621 | 5570 When {lnum} is just below the last line the {text} will be |
282 | 5571 added as a new line. |
236 | 5572 If this succeeds, 0 is returned. If this fails (most likely |
5573 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 5574 :call setline(5, strftime("%c")) |
1621 | 5575 < When {text} is a |List| then line {lnum} and following lines |
282 | 5576 will be set to the items in the list. Example: > |
5577 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
5578 < This is equivalent to: > | |
3465 | 5579 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
282 | 5580 : call setline(n, l) |
5581 :endfor | |
7 | 5582 < Note: The '[ and '] marks are not set. |
5583 | |
647 | 5584 setloclist({nr}, {list} [, {action}]) *setloclist()* |
5585 Create or replace or add to the location list for window {nr}. | |
5586 When {nr} is zero the current window is used. For a location | |
648 | 5587 list window, the displayed location list is modified. For an |
5588 invalid window number {nr}, -1 is returned. | |
1326 | 5589 Otherwise, same as |setqflist()|. |
5590 Also see |location-list|. | |
5591 | |
5592 setmatches({list}) *setmatches()* | |
5593 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 5594 if successful, otherwise -1. All current matches are cleared |
1326 | 5595 before the list is restored. See example for |getmatches()|. |
230 | 5596 |
707 | 5597 *setpos()* |
5598 setpos({expr}, {list}) | |
5599 Set the position for {expr}. Possible values: | |
5600 . the cursor | |
5601 'x mark x | |
5602 | |
5938 | 5603 {list} must be a |List| with four or five numbers: |
707 | 5604 [bufnum, lnum, col, off] |
5938 | 5605 [bufnum, lnum, col, off, curswant] |
707 | 5606 |
1621 | 5607 "bufnum" is the buffer number. Zero can be used for the |
856 | 5608 current buffer. Setting the cursor is only possible for |
707 | 5609 the current buffer. To set a mark in another buffer you can |
5610 use the |bufnr()| function to turn a file name into a buffer | |
5611 number. | |
798 | 5612 Does not change the jumplist. |
707 | 5613 |
5614 "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
|
5615 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
|
5616 smaller than 1 then 1 is used. |
707 | 5617 |
5618 The "off" number is only used when 'virtualedit' is set. Then | |
5619 it is the offset in screen columns from the start of the | |
1266 | 5620 character. E.g., a position within a <Tab> or after the last |
707 | 5621 character. |
5622 | |
5938 | 5623 The "curswant" number is only used when setting the cursor |
5624 position. It sets the preferred column for when moving the | |
5625 cursor vertically. When the "curswant" number is missing the | |
5626 preferred column is not set. When it is present and setting a | |
5627 mark position it is not used. | |
5628 | |
5555 | 5629 Note that for '< and '> changing the line number may result in |
5630 the marks to be effectively be swapped, so that '< is always | |
5631 before '>. | |
5632 | |
1533 | 5633 Returns 0 when the position could be set, -1 otherwise. |
5634 An error message is given if {expr} is invalid. | |
5635 | |
5944 | 5636 Also see |getpos()| and |getcurpos()|. |
707 | 5637 |
1156 | 5638 This does not restore the preferred column for moving |
5938 | 5639 vertically; if you set the cursor position with this, |j| and |
5640 |k| motions will jump to previous columns! Use |cursor()| to | |
5641 also set the preferred column. Also see the "curswant" key in | |
5642 |winrestview()|. | |
1156 | 5643 |
707 | 5644 |
277 | 5645 setqflist({list} [, {action}]) *setqflist()* |
647 | 5646 Create or replace or add to the quickfix list using the items |
5647 in {list}. Each item in {list} is a dictionary. | |
5648 Non-dictionary items in {list} are ignored. Each dictionary | |
5649 item can contain the following entries: | |
230 | 5650 |
1065 | 5651 bufnr buffer number; must be the number of a valid |
1621 | 5652 buffer |
1065 | 5653 filename name of a file; only used when "bufnr" is not |
1621 | 5654 present or it is invalid. |
230 | 5655 lnum line number in the file |
233 | 5656 pattern search pattern used to locate the error |
230 | 5657 col column number |
233 | 5658 vcol when non-zero: "col" is visual column |
856 | 5659 when zero: "col" is byte index |
233 | 5660 nr error number |
230 | 5661 text description of the error |
233 | 5662 type single-character error type, 'E', 'W', etc. |
5663 | |
5664 The "col", "vcol", "nr", "type" and "text" entries are | |
5665 optional. Either "lnum" or "pattern" entry can be used to | |
5666 locate a matching error line. | |
1065 | 5667 If the "filename" and "bufnr" entries are not present or |
5668 neither the "lnum" or "pattern" entries are present, then the | |
5669 item will not be handled as an error line. | |
230 | 5670 If both "pattern" and "lnum" are present then "pattern" will |
5671 be used. | |
2152 | 5672 If you supply an empty {list}, the quickfix list will be |
5673 cleared. | |
1065 | 5674 Note that the list is not exactly the same as what |
5675 |getqflist()| returns. | |
230 | 5676 |
277 | 5677 If {action} is set to 'a', then the items from {list} are |
5678 added to the existing quickfix list. If there is no existing | |
5679 list, then a new list is created. If {action} is set to 'r', | |
5680 then the items from the current quickfix list are replaced | |
5681 with the items from {list}. If {action} is not present or is | |
5682 set to ' ', then a new list is created. | |
5683 | |
230 | 5684 Returns zero for success, -1 for failure. |
5685 | |
5686 This function can be used to create a quickfix list | |
5687 independent of the 'errorformat' setting. Use a command like | |
5688 ":cc 1" to jump to the first position. | |
5689 | |
5690 | |
7 | 5691 *setreg()* |
5692 setreg({regname}, {value} [,{options}]) | |
5693 Set the register {regname} to {value}. | |
5798 | 5694 {value} may be any value returned by |getreg()|, including |
5695 a |List|. | |
7 | 5696 If {options} contains "a" or {regname} is upper case, |
5697 then the value is appended. | |
2423 | 5698 {options} can also contain a register type specification: |
7 | 5699 "c" or "v" |characterwise| mode |
5700 "l" or "V" |linewise| mode | |
5701 "b" or "<CTRL-V>" |blockwise-visual| mode | |
5702 If a number immediately follows "b" or "<CTRL-V>" then this is | |
5703 used as the width of the selection - if it is not specified | |
5704 then the width of the block is set to the number of characters | |
1266 | 5705 in the longest line (counting a <Tab> as 1 character). |
7 | 5706 |
5707 If {options} contains no register settings, then the default | |
5798 | 5708 is to use character mode unless {value} ends in a <NL> for |
5709 string {value} and linewise mode for list {value}. Blockwise | |
5710 mode is never selected automatically. | |
5711 Returns zero for success, non-zero for failure. | |
5712 | |
5713 *E883* | |
6180 | 5714 Note: you may not use |List| containing more than one item to |
5798 | 5715 set search and expression registers. Lists containing no |
5716 items act like empty strings. | |
7 | 5717 |
5718 Examples: > | |
5719 :call setreg(v:register, @*) | |
5720 :call setreg('*', @%, 'ac') | |
5721 :call setreg('a', "1\n2\n3", 'b5') | |
5722 | |
5723 < This example shows using the functions to save and restore a | |
5798 | 5724 register (note: you may not reliably restore register value |
5725 without using the third argument to |getreg()| as without it | |
5726 newlines are represented as newlines AND Nul bytes are | |
5727 represented as newlines as well, see |NL-used-for-Nul|). > | |
5728 :let var_a = getreg('a', 1, 1) | |
7 | 5729 :let var_amode = getregtype('a') |
5730 .... | |
5731 :call setreg('a', var_a, var_amode) | |
5732 | |
5733 < You can also change the type of a register by appending | |
5734 nothing: > | |
5735 :call setreg('a', '', 'al') | |
5736 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5737 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5738 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
|
5739 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5740 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
|
5741 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5742 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5743 |
831 | 5744 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
5745 Set option or local variable {varname} in window {winnr} to | |
5746 {val}. | |
5747 Tabs are numbered starting with one. For the current tabpage | |
5748 use |setwinvar()|. | |
5749 When {winnr} is zero the current window is used. | |
7 | 5750 This also works for a global or local buffer option, but it |
5751 doesn't work for a global or local buffer variable. | |
5752 For a local buffer option the global value is unchanged. | |
5753 Note that the variable name without "w:" must be used. | |
831 | 5754 Examples: > |
5755 :call settabwinvar(1, 1, "&list", 0) | |
5756 :call settabwinvar(3, 2, "myvar", "foobar") | |
5757 < This function is not available in the |sandbox|. | |
5758 | |
5759 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
5760 Like |settabwinvar()| for the current tab page. | |
7 | 5761 Examples: > |
5762 :call setwinvar(1, "&list", 0) | |
5763 :call setwinvar(2, "myvar", "foobar") | |
5764 | |
4126 | 5765 sha256({string}) *sha256()* |
6647 | 5766 Returns a String with 64 hex characters, which is the SHA256 |
4126 | 5767 checksum of {string}. |
5768 {only available when compiled with the |+cryptv| feature} | |
5769 | |
1661 | 5770 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5771 Escape {string} for use as a shell command argument. |
985 | 5772 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 5773 will enclose {string} in double quotes and double all double |
985 | 5774 quotes within {string}. |
5775 For other systems, it will enclose {string} in single quotes | |
5776 and replace all "'" with "'\''". | |
1661 | 5777 When the {special} argument is present and it's a non-zero |
5778 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 5779 items such as "!", "%", "#" and "<cword>" will be preceded by |
5780 a backslash. This backslash will be removed again by the |:!| | |
1661 | 5781 command. |
1698 | 5782 The "!" character will be escaped (again with a |non-zero-arg| |
5783 {special}) when 'shell' contains "csh" in the tail. That is | |
5784 because for csh and tcsh "!" is used for history replacement | |
5785 even when inside single quotes. | |
5786 The <NL> character is also escaped. With a |non-zero-arg| | |
5787 {special} and 'shell' containing "csh" in the tail it's | |
5788 escaped a second time. | |
1661 | 5789 Example of use with a |:!| command: > |
5790 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
5791 < This results in a directory listing for the file under the | |
5792 cursor. Example of use with |system()|: > | |
5793 :call system("chmod +w -- " . shellescape(expand("%"))) | |
5690 | 5794 < See also |::S|. |
985 | 5795 |
5796 | |
3875 | 5797 shiftwidth() *shiftwidth()* |
5798 Returns the effective value of 'shiftwidth'. This is the | |
5799 'shiftwidth' value unless it is zero, in which case it is the | |
5800 'tabstop' value. To be backwards compatible in indent | |
5801 plugins, use this: > | |
5802 if exists('*shiftwidth') | |
5803 func s:sw() | |
5804 return shiftwidth() | |
5805 endfunc | |
5806 else | |
5807 func s:sw() | |
5808 return &sw | |
5809 endfunc | |
5810 endif | |
5811 < And then use s:sw() instead of &sw. | |
5812 | |
5813 | |
7 | 5814 simplify({filename}) *simplify()* |
5815 Simplify the file name as much as possible without changing | |
5816 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
5817 Unix) are not resolved. If the first path component in | |
5818 {filename} designates the current directory, this will be | |
5819 valid for the result as well. A trailing path separator is | |
5820 not removed either. | |
5821 Example: > | |
5822 simplify("./dir/.././/file/") == "./file/" | |
5823 < Note: The combination "dir/.." is only removed if "dir" is | |
5824 a searchable directory or does not exist. On Unix, it is also | |
5825 removed when "dir" is a symbolic link within the same | |
5826 directory. In order to resolve all the involved symbolic | |
5827 links before simplifying the path name, use |resolve()|. | |
5828 | |
82 | 5829 |
1621 | 5830 sin({expr}) *sin()* |
5831 Return the sine of {expr}, measured in radians, as a |Float|. | |
5832 {expr} must evaluate to a |Float| or a |Number|. | |
5833 Examples: > | |
5834 :echo sin(100) | |
5835 < -0.506366 > | |
5836 :echo sin(-4.01) | |
5837 < 0.763301 | |
5838 {only available when compiled with the |+float| feature} | |
5839 | |
5840 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5841 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5842 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
|
5843 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5844 {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
|
5845 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5846 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5847 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5848 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5849 < -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
|
5850 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5851 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5852 |
2902 | 5853 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
5747 | 5854 Sort the items in {list} in-place. Returns {list}. |
5855 | |
5856 If you want a list to remain unmodified make a copy first: > | |
82 | 5857 :let sortedlist = sort(copy(mylist)) |
5968 | 5858 |
6009 | 5859 < When {func} is omitted, is empty or zero, then sort() uses the |
5860 string representation of each item to sort on. Numbers sort | |
5861 after Strings, |Lists| after Numbers. For sorting text in the | |
5862 current buffer use |:sort|. | |
5863 | |
6180 | 5864 When {func} is given and it is '1' or 'i' then case is |
6009 | 5865 ignored. |
5866 | |
5867 When {func} is given and it is 'n' then all items will be | |
5868 sorted numerical (Implementation detail: This uses the | |
5869 strtod() function to parse numbers, Strings, Lists, Dicts and | |
5870 Funcrefs will be considered as being 0). | |
5871 | |
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5872 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
|
5873 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
|
5874 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
|
5875 |
685 | 5876 When {func} is a |Funcref| or a function name, this function |
5877 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
|
5878 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
|
5879 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
|
5880 smaller if the first one sorts before the second one. |
5747 | 5881 |
5882 {dict} is for functions with the "dict" attribute. It will be | |
5883 used to set the local variable "self". |Dictionary-function| | |
5884 | |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5885 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
|
5886 string) will keep their relative position. E.g., when sorting |
6051 | 5887 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
|
5888 same order as they were originally. |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5889 |
5747 | 5890 Also see |uniq()|. |
5891 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5892 Example: > |
82 | 5893 func MyCompare(i1, i2) |
5894 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
5895 endfunc | |
5896 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5897 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5898 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5899 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5900 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5901 endfunc |
344 | 5902 < |
374 | 5903 *soundfold()* |
5904 soundfold({word}) | |
5905 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 5906 language in 'spelllang' for the current window that supports |
375 | 5907 soundfolding. 'spell' must be set. When no sound folding is |
5908 possible the {word} is returned unmodified. | |
374 | 5909 This can be used for making spelling suggestions. Note that |
5910 the method can be quite slow. | |
5911 | |
344 | 5912 *spellbadword()* |
532 | 5913 spellbadword([{sentence}]) |
5914 Without argument: The result is the badly spelled word under | |
5915 or after the cursor. The cursor is moved to the start of the | |
5916 bad word. When no bad word is found in the cursor line the | |
5917 result is an empty string and the cursor doesn't move. | |
5918 | |
5919 With argument: The result is the first word in {sentence} that | |
5920 is badly spelled. If there are no spelling mistakes the | |
5921 result is an empty string. | |
5922 | |
5923 The return value is a list with two items: | |
5924 - The badly spelled word or an empty string. | |
5925 - The type of the spelling error: | |
856 | 5926 "bad" spelling mistake |
532 | 5927 "rare" rare word |
5928 "local" word only valid in another region | |
5929 "caps" word should start with Capital | |
5930 Example: > | |
5931 echo spellbadword("the quik brown fox") | |
5932 < ['quik', 'bad'] ~ | |
5933 | |
5934 The spelling information for the current window is used. The | |
5935 'spell' option must be set and the value of 'spelllang' is | |
5936 used. | |
344 | 5937 |
5938 *spellsuggest()* | |
537 | 5939 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 5940 Return a |List| with spelling suggestions to replace {word}. |
344 | 5941 When {max} is given up to this number of suggestions are |
5942 returned. Otherwise up to 25 suggestions are returned. | |
5943 | |
537 | 5944 When the {capital} argument is given and it's non-zero only |
5945 suggestions with a leading capital will be given. Use this | |
5946 after a match with 'spellcapcheck'. | |
5947 | |
344 | 5948 {word} can be a badly spelled word followed by other text. |
5949 This allows for joining two words that were split. The | |
359 | 5950 suggestions also include the following text, thus you can |
5951 replace a line. | |
5952 | |
5953 {word} may also be a good word. Similar words will then be | |
537 | 5954 returned. {word} itself is not included in the suggestions, |
5955 although it may appear capitalized. | |
344 | 5956 |
5957 The spelling information for the current window is used. The | |
375 | 5958 'spell' option must be set and the values of 'spelllang' and |
5959 'spellsuggest' are used. | |
344 | 5960 |
82 | 5961 |
282 | 5962 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 5963 Make a |List| out of {expr}. When {pattern} is omitted or |
5964 empty each white-separated sequence of characters becomes an | |
5965 item. | |
82 | 5966 Otherwise the string is split where {pattern} matches, |
3920 | 5967 removing the matched characters. 'ignorecase' is not used |
5968 here, add \c to ignore case. |/\c| | |
282 | 5969 When the first or last item is empty it is omitted, unless the |
5970 {keepempty} argument is given and it's non-zero. | |
293 | 5971 Other empty items are kept when {pattern} matches at least one |
5972 character or when {keepempty} is non-zero. | |
82 | 5973 Example: > |
95 | 5974 :let words = split(getline('.'), '\W\+') |
282 | 5975 < To split a string in individual characters: > |
236 | 5976 :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
|
5977 < 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
|
5978 the end of the pattern: > |
258 | 5979 :echo split('abc:def:ghi', ':\zs') |
5980 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 5981 Splitting a table where the first element can be empty: > |
5982 :let items = split(line, ':', 1) | |
5983 < The opposite function is |join()|. | |
82 | 5984 |
5985 | |
1621 | 5986 sqrt({expr}) *sqrt()* |
5987 Return the non-negative square root of Float {expr} as a | |
5988 |Float|. | |
5989 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
5990 is negative the result is NaN (Not a Number). | |
5991 Examples: > | |
5992 :echo sqrt(100) | |
5993 < 10.0 > | |
5994 :echo sqrt(-4.01) | |
5995 < nan | |
1668 | 5996 "nan" may be different, it depends on system libraries. |
1621 | 5997 {only available when compiled with the |+float| feature} |
5998 | |
5999 | |
6000 str2float( {expr}) *str2float()* | |
6001 Convert String {expr} to a Float. This mostly works the same | |
6002 as when using a floating point number in an expression, see | |
6003 |floating-point-format|. But it's a bit more permissive. | |
6004 E.g., "1e40" is accepted, while in an expression you need to | |
6005 write "1.0e40". | |
6006 Text after the number is silently ignored. | |
6007 The decimal point is always '.', no matter what the locale is | |
6008 set to. A comma ends the number: "12,345.67" is converted to | |
6009 12.0. You can strip out thousands separators with | |
6010 |substitute()|: > | |
6011 let f = str2float(substitute(text, ',', '', 'g')) | |
6012 < {only available when compiled with the |+float| feature} | |
6013 | |
6014 | |
782 | 6015 str2nr( {expr} [, {base}]) *str2nr()* |
6016 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
|
6017 {base} is the conversion base, it can be 2, 8, 10 or 16. |
782 | 6018 When {base} is omitted base 10 is used. This also means that |
6019 a leading zero doesn't cause octal conversion to be used, as | |
6020 with the default String to Number conversion. | |
6021 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
|
6022 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
|
6023 {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
|
6024 leading "0b" or "0B" is ignored. |
782 | 6025 Text after the number is silently ignored. |
856 | 6026 |
782 | 6027 |
6884 | 6028 strchars({expr} [, {skipcc}]) *strchars()* |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6029 The result is a Number, which is the number of characters |
6884 | 6030 in String {expr}. |
6031 When {skipcc} is omitted or zero, composing characters are | |
6032 counted separately. | |
6033 When {skipcc} set to 1, Composing characters are ignored. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6034 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6035 |
6918 | 6036 |
6037 {skipcc} is only available after 7.4.755. For backward | |
6038 compatibility, you can define a wrapper function: > | |
6039 if has("patch-7.4.755") | |
6040 function s:strchars(str, skipcc) | |
6041 return strchars(a:str, a:skipcc) | |
6042 endfunction | |
6043 else | |
6044 function s:strchars(str, skipcc) | |
6045 if a:skipcc | |
6046 return strlen(substitute(a:str, ".", "x", "g")) | |
6047 else | |
6048 return strchars(a:str) | |
6049 endif | |
6050 endfunction | |
6051 endif | |
6052 < | |
6053 | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6054 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6055 The result is a Number, which is the number of display cells |
6884 | 6056 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
|
6057 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6058 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6059 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6060 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
|
6061 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
|
6062 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6063 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6064 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6065 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6066 |
7 | 6067 strftime({format} [, {time}]) *strftime()* |
6068 The result is a String, which is a formatted date and time, as | |
6069 specified by the {format} string. The given {time} is used, | |
6070 or the current time if no time is given. The accepted | |
6071 {format} depends on your system, thus this is not portable! | |
6072 See the manual page of the C function strftime() for the | |
6073 format. The maximum length of the result is 80 characters. | |
6074 See also |localtime()| and |getftime()|. | |
6075 The language can be changed with the |:language| command. | |
6076 Examples: > | |
6077 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
6078 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
6079 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
6080 :echo strftime("%H:%M") 11:55 | |
6081 :echo strftime("%c", getftime("file.c")) | |
6082 Show mod time of file.c. | |
82 | 6083 < Not available on all systems. To check use: > |
6084 :if exists("*strftime") | |
6085 | |
133 | 6086 stridx({haystack}, {needle} [, {start}]) *stridx()* |
6087 The result is a Number, which gives the byte index in | |
6088 {haystack} of the first occurrence of the String {needle}. | |
140 | 6089 If {start} is specified, the search starts at index {start}. |
6090 This can be used to find a second match: > | |
2662 | 6091 :let colon1 = stridx(line, ":") |
6092 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 6093 < The search is done case-sensitive. |
205 | 6094 For pattern searches use |match()|. |
133 | 6095 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 6096 See also |strridx()|. |
6097 Examples: > | |
7 | 6098 :echo stridx("An Example", "Example") 3 |
6099 :echo stridx("Starting point", "Start") 0 | |
6100 :echo stridx("Starting point", "start") -1 | |
856 | 6101 < *strstr()* *strchr()* |
170 | 6102 stridx() works similar to the C function strstr(). When used |
6103 with a single character it works similar to strchr(). | |
6104 | |
55 | 6105 *string()* |
95 | 6106 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 6107 Float, String or a composition of them, then the result can be |
6108 parsed back with |eval()|. | |
55 | 6109 {expr} type result ~ |
99 | 6110 String 'string' |
95 | 6111 Number 123 |
1621 | 6112 Float 123.123456 or 1.123456e8 |
99 | 6113 Funcref function('name') |
95 | 6114 List [item, item] |
323 | 6115 Dictionary {key: value, key: value} |
99 | 6116 Note that in String values the ' character is doubled. |
1156 | 6117 Also see |strtrans()|. |
55 | 6118 |
7 | 6119 *strlen()* |
6120 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 6121 {expr} in bytes. |
55 | 6122 If the argument is a Number it is first converted to a String. |
6123 For other types an error is given. | |
6870 | 6124 If you want to count the number of multi-byte characters use |
6125 |strchars()|. | |
6126 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
7 | 6127 |
6128 strpart({src}, {start}[, {len}]) *strpart()* | |
6129 The result is a String, which is part of {src}, starting from | |
574 | 6130 byte {start}, with the byte length {len}. |
7 | 6131 When non-existing bytes are included, this doesn't result in |
6132 an error, the bytes are simply omitted. | |
6133 If {len} is missing, the copy continues from {start} till the | |
6134 end of the {src}. > | |
6135 strpart("abcdefg", 3, 2) == "de" | |
6136 strpart("abcdefg", -2, 4) == "ab" | |
6137 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 6138 strpart("abcdefg", 3) == "defg" |
7 | 6139 < Note: To get the first character, {start} must be 0. For |
6140 example, to get three bytes under and after the cursor: > | |
823 | 6141 strpart(getline("."), col(".") - 1, 3) |
7 | 6142 < |
140 | 6143 strridx({haystack}, {needle} [, {start}]) *strridx()* |
6144 The result is a Number, which gives the byte index in | |
6145 {haystack} of the last occurrence of the String {needle}. | |
6146 When {start} is specified, matches beyond this index are | |
6147 ignored. This can be used to find a match before a previous | |
6148 match: > | |
6149 :let lastcomma = strridx(line, ",") | |
6150 :let comma2 = strridx(line, ",", lastcomma - 1) | |
6151 < The search is done case-sensitive. | |
133 | 6152 For pattern searches use |match()|. |
6153 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 6154 If the {needle} is empty the length of {haystack} is returned. |
236 | 6155 See also |stridx()|. Examples: > |
7 | 6156 :echo strridx("an angry armadillo", "an") 3 |
856 | 6157 < *strrchr()* |
170 | 6158 When used with a single character it works similar to the C |
6159 function strrchr(). | |
6160 | |
7 | 6161 strtrans({expr}) *strtrans()* |
6162 The result is a String, which is {expr} with all unprintable | |
6163 characters translated into printable characters |'isprint'|. | |
6164 Like they are shown in a window. Example: > | |
6165 echo strtrans(@a) | |
6166 < This displays a newline in register a as "^@" instead of | |
6167 starting a new line. | |
6168 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6169 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6170 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
|
6171 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6172 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6173 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6174 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6175 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6176 |
5794 | 6177 submatch({nr}[, {list}]) *submatch()* |
2908 | 6178 Only for an expression in a |:substitute| command or |
6179 substitute() function. | |
6180 Returns the {nr}'th submatch of the matched text. When {nr} | |
6181 is 0 the whole matched text is returned. | |
5794 | 6182 Note that a NL in the string can stand for a line break of a |
6183 multi-line match or a NUL character in the text. | |
2908 | 6184 Also see |sub-replace-expression|. |
5794 | 6185 |
6186 If {list} is present and non-zero then submatch() returns | |
6187 a list of strings, similar to |getline()| with two arguments. | |
6188 NL characters in the text represent NUL characters in the | |
6189 text. | |
6190 Only returns more than one item for |:substitute|, inside | |
6191 |substitute()| this list will always contain one or zero | |
6192 items, since there are no real line breaks. | |
6193 | |
7 | 6194 Example: > |
6195 :s/\d\+/\=submatch(0) + 1/ | |
6196 < This finds the first number in the line and adds one to it. | |
6197 A line break is included as a newline character. | |
6198 | |
6199 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
6200 The result is a String, which is a copy of {expr}, in which | |
2908 | 6201 the first match of {pat} is replaced with {sub}. |
6202 When {flags} is "g", all matches of {pat} in {expr} are | |
6203 replaced. Otherwise {flags} should be "". | |
6204 | |
6205 This works like the ":substitute" command (without any flags). | |
6206 But the matching with {pat} is always done like the 'magic' | |
6207 option is set and 'cpoptions' is empty (to make scripts | |
3967 | 6208 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
6209 if you want to ignore or match case and ignore 'ignorecase'. | |
6210 'smartcase' is not used. See |string-match| for how {pat} is | |
6211 used. | |
2908 | 6212 |
6213 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 6214 Note that some codes in {sub} have a special meaning |
1621 | 6215 |sub-replace-special|. For example, to replace something with |
7 | 6216 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 6217 |
7 | 6218 When {pat} does not match in {expr}, {expr} is returned |
6219 unmodified. | |
2908 | 6220 |
7 | 6221 Example: > |
6222 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
6223 < This removes the last component of the 'path' option. > | |
6224 :echo substitute("testing", ".*", "\\U\\0", "") | |
6225 < results in "TESTING". | |
2908 | 6226 |
6227 When {sub} starts with "\=", the remainder is interpreted as | |
6228 an expression. See |sub-replace-expression|. Example: > | |
2833 | 6229 :echo substitute(s, '%\(\x\x\)', |
6230 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 6231 |
32 | 6232 synID({lnum}, {col}, {trans}) *synID()* |
7 | 6233 The result is a Number, which is the syntax ID at the position |
32 | 6234 {lnum} and {col} in the current window. |
7 | 6235 The syntax ID can be used with |synIDattr()| and |
6236 |synIDtrans()| to obtain syntax information about text. | |
419 | 6237 |
32 | 6238 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 6239 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
|
6240 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
|
6241 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
|
6242 zero. |
419 | 6243 |
7 | 6244 When {trans} is non-zero, transparent items are reduced to the |
1621 | 6245 item that they reveal. This is useful when wanting to know |
7 | 6246 the effective color. When {trans} is zero, the transparent |
6247 item is returned. This is useful when wanting to know which | |
6248 syntax item is effective (e.g. inside parens). | |
6249 Warning: This function can be very slow. Best speed is | |
6250 obtained by going through the file in forward direction. | |
6251 | |
6252 Example (echoes the name of the syntax item under the cursor): > | |
6253 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
6254 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6255 |
7 | 6256 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
6257 The result is a String, which is the {what} attribute of | |
6258 syntax ID {synID}. This can be used to obtain information | |
6259 about a syntax item. | |
6260 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 6261 for that mode. When {mode} is omitted, or an invalid value is |
7 | 6262 used, the attributes for the currently active highlighting are |
6263 used (GUI, cterm or term). | |
6264 Use synIDtrans() to follow linked highlight groups. | |
6265 {what} result | |
6266 "name" the name of the syntax item | |
6267 "fg" foreground color (GUI: color name used to set | |
6268 the color, cterm: color number as a string, | |
6269 term: empty string) | |
1755 | 6270 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6271 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6272 |highlight-font| |
1755 | 6273 "sp" special color (as with "fg") |highlight-guisp| |
7 | 6274 "fg#" like "fg", but for the GUI and the GUI is |
6275 running the name in "#RRGGBB" form | |
6276 "bg#" like "fg#" for "bg" | |
1755 | 6277 "sp#" like "fg#" for "sp" |
7 | 6278 "bold" "1" if bold |
6279 "italic" "1" if italic | |
6280 "reverse" "1" if reverse | |
6281 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6282 "standout" "1" if standout |
7 | 6283 "underline" "1" if underlined |
205 | 6284 "undercurl" "1" if undercurled |
7 | 6285 |
6286 Example (echoes the color of the syntax item under the | |
6287 cursor): > | |
6288 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
6289 < | |
6290 synIDtrans({synID}) *synIDtrans()* | |
6291 The result is a Number, which is the translated syntax ID of | |
6292 {synID}. This is the syntax group ID of what is being used to | |
6293 highlight the character. Highlight links given with | |
6294 ":highlight link" are followed. | |
6295 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6296 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6297 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
|
6298 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
|
6299 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
|
6300 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
|
6301 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
|
6302 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6303 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
|
6304 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6305 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
|
6306 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6307 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6308 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6309 |
1500 | 6310 synstack({lnum}, {col}) *synstack()* |
6311 Return a |List|, which is the stack of syntax items at the | |
6312 position {lnum} and {col} in the current window. Each item in | |
6313 the List is an ID like what |synID()| returns. | |
6314 The first item in the List is the outer region, following are | |
6315 items contained in that one. The last one is what |synID()| | |
6316 returns, unless not the whole item is highlighted or it is a | |
6317 transparent item. | |
6318 This function is useful for debugging a syntax file. | |
6319 Example that shows the syntax stack under the cursor: > | |
6320 for id in synstack(line("."), col(".")) | |
6321 echo synIDattr(id, "name") | |
6322 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6323 < 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
|
6324 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6325 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
|
6326 valid positions. |
1500 | 6327 |
24 | 6328 system({expr} [, {input}]) *system()* *E677* |
5808 | 6329 Get the output of the shell command {expr} as a string. See |
6330 |systemlist()| to get the output as a List. | |
5806 | 6331 |
6332 When {input} is given and is a string this string is written | |
6333 to a file and passed as stdin to the command. The string is | |
6334 written as-is, you need to take care of using the correct line | |
6335 separators yourself. | |
6336 If {input} is given and is a |List| it is written to the file | |
6337 in a way |writefile()| does with {binary} set to "b" (i.e. | |
6338 with a newline between each list item with newlines inside | |
6339 list items converted to NULs). | |
6340 Pipes are not used. | |
6341 | |
6183 | 6342 When prepended by |:silent| the shell will not be set to |
6343 cooked mode. This is meant to be used for commands that do | |
6344 not need the user to type. It avoids stray characters showing | |
6345 up on the screen which require |CTRL-L| to remove. > | |
6346 :silent let f = system('ls *.vim') | |
6347 < | |
5690 | 6348 Note: Use |shellescape()| or |::S| with |expand()| or |
6349 |fnamemodify()| to escape special characters in a command | |
6350 argument. Newlines in {expr} may cause the command to fail. | |
6351 The characters in 'shellquote' and 'shellxquote' may also | |
6352 cause trouble. | |
7 | 6353 This is not to be used for interactive commands. |
1661 | 6354 |
7 | 6355 The result is a String. Example: > |
1661 | 6356 :let files = system("ls " . shellescape(expand('%:h'))) |
5690 | 6357 :let files = system('ls ' . expand('%:h:S')) |
7 | 6358 |
6359 < To make the result more system-independent, the shell output | |
6360 is filtered to replace <CR> with <NL> for Macintosh, and | |
6361 <CR><NL> with <NL> for DOS-like systems. | |
5277 | 6362 To avoid the string being truncated at a NUL, all NUL |
6363 characters are replaced with SOH (0x01). | |
6364 | |
7 | 6365 The command executed is constructed using several options: |
6366 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
6367 ({tmp} is an automatically generated file name). | |
6368 For Unix and OS/2 braces are put around {expr} to allow for | |
6369 concatenated commands. | |
6370 | |
794 | 6371 The command will be executed in "cooked" mode, so that a |
6372 CTRL-C will interrupt the command (on Unix at least). | |
6373 | |
7 | 6374 The resulting error code can be found in |v:shell_error|. |
6375 This function will fail in |restricted-mode|. | |
625 | 6376 |
6377 Note that any wrong value in the options mentioned above may | |
6378 make the function fail. It has also been reported to fail | |
6379 when using a security agent application. | |
7 | 6380 Unlike ":!cmd" there is no automatic check for changed files. |
6381 Use |:checktime| to force a check. | |
6382 | |
205 | 6383 |
5808 | 6384 systemlist({expr} [, {input}]) *systemlist()* |
6385 Same as |system()|, but returns a |List| with lines (parts of | |
6386 output separated by NL) with NULs transformed into NLs. Output | |
6387 is the same as |readfile()| will output with {binary} argument | |
6388 set to "b". | |
6389 | |
6390 Returns an empty string on error, so be careful not to run | |
6391 into |E706|. | |
6392 | |
6393 | |
677 | 6394 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 6395 The result is a |List|, where each item is the number of the |
677 | 6396 buffer associated with each window in the current tab page. |
6397 {arg} specifies the number of tab page to be used. When | |
6398 omitted the current tab page is used. | |
6399 When {arg} is invalid the number zero is returned. | |
6400 To get a list of all buffers in all tabs use this: > | |
3445 | 6401 let buflist = [] |
677 | 6402 for i in range(tabpagenr('$')) |
3445 | 6403 call extend(buflist, tabpagebuflist(i + 1)) |
677 | 6404 endfor |
6405 < Note that a buffer may appear in more than one window. | |
6406 | |
6407 | |
6408 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 6409 The result is a Number, which is the number of the current |
6410 tab page. The first tab page has number 1. | |
6411 When the optional argument is "$", the number of the last tab | |
6412 page is returned (the tab page count). | |
6413 The number can be used with the |:tab| command. | |
6414 | |
6415 | |
5763 | 6416 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6417 Like |winnr()| but for tab page {tabarg}. |
677 | 6418 {tabarg} specifies the number of tab page to be used. |
6419 {arg} is used like with |winnr()|: | |
6420 - When omitted the current window number is returned. This is | |
6421 the window which will be used when going to this tab page. | |
6422 - When "$" the number of windows is returned. | |
6423 - When "#" the previous window nr is returned. | |
6424 Useful examples: > | |
6425 tabpagewinnr(1) " current window of tab page 1 | |
6426 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
6427 < When {tabarg} is invalid zero is returned. | |
6428 | |
805 | 6429 *tagfiles()* |
6430 tagfiles() Returns a |List| with the file names used to search for tags | |
6431 for the current buffer. This is the 'tags' option expanded. | |
6432 | |
6433 | |
205 | 6434 taglist({expr}) *taglist()* |
6435 Returns a list of tags matching the regular expression {expr}. | |
438 | 6436 Each list item is a dictionary with at least the following |
6437 entries: | |
648 | 6438 name Name of the tag. |
6439 filename Name of the file where the tag is | |
1156 | 6440 defined. It is either relative to the |
6441 current directory or a full path. | |
205 | 6442 cmd Ex command used to locate the tag in |
6443 the file. | |
648 | 6444 kind Type of the tag. The value for this |
205 | 6445 entry depends on the language specific |
1156 | 6446 kind values. Only available when |
6447 using a tags file generated by | |
6448 Exuberant ctags or hdrtag. | |
648 | 6449 static A file specific tag. Refer to |
205 | 6450 |static-tag| for more information. |
1156 | 6451 More entries may be present, depending on the content of the |
6452 tags file: access, implementation, inherits and signature. | |
6453 Refer to the ctags documentation for information about these | |
6454 fields. For C code the fields "struct", "class" and "enum" | |
6455 may appear, they give the name of the entity the tag is | |
6456 contained in. | |
452 | 6457 |
216 | 6458 The ex-command 'cmd' can be either an ex search pattern, a |
6459 line number or a line number followed by a byte number. | |
205 | 6460 |
6461 If there are no matching tags, then an empty list is returned. | |
6462 | |
6463 To get an exact tag match, the anchors '^' and '$' should be | |
4073 | 6464 used in {expr}. This also make the function work faster. |
6465 Refer to |tag-regexp| for more information about the tag | |
6466 search regular expression pattern. | |
205 | 6467 |
6468 Refer to |'tags'| for information about how the tags file is | |
6469 located by Vim. Refer to |tags-file-format| for the format of | |
6470 the tags file generated by the different ctags tools. | |
6471 | |
7 | 6472 tempname() *tempname()* *temp-file-name* |
6473 The result is a String, which is the name of a file that | |
1621 | 6474 doesn't exist. It can be used for a temporary file. The name |
7 | 6475 is different for at least 26 consecutive calls. Example: > |
6476 :let tmpfile = tempname() | |
6477 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6478 < For Unix, the file will be in a private directory |tempfile|. |
7 | 6479 For MS-Windows forward slashes are used when the 'shellslash' |
6480 option is set or when 'shellcmdflag' starts with '-'. | |
6481 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6482 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6483 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6484 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
|
6485 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6486 {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
|
6487 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6488 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6489 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6490 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6491 < -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
|
6492 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6493 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6494 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6495 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6496 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
|
6497 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6498 {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
|
6499 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6500 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6501 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6502 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6503 < -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
|
6504 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6505 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6506 |
7 | 6507 tolower({expr}) *tolower()* |
6508 The result is a copy of the String given, with all uppercase | |
6509 characters turned into lowercase (just like applying |gu| to | |
6510 the string). | |
6511 | |
6512 toupper({expr}) *toupper()* | |
6513 The result is a copy of the String given, with all lowercase | |
6514 characters turned into uppercase (just like applying |gU| to | |
6515 the string). | |
6516 | |
15 | 6517 tr({src}, {fromstr}, {tostr}) *tr()* |
6518 The result is a copy of the {src} string with all characters | |
6519 which appear in {fromstr} replaced by the character in that | |
6520 position in the {tostr} string. Thus the first character in | |
6521 {fromstr} is translated into the first character in {tostr} | |
6522 and so on. Exactly like the unix "tr" command. | |
6523 This code also deals with multibyte characters properly. | |
6524 | |
6525 Examples: > | |
6526 echo tr("hello there", "ht", "HT") | |
6527 < returns "Hello THere" > | |
6528 echo tr("<blob>", "<>", "{}") | |
6529 < returns "{blob}" | |
6530 | |
1621 | 6531 trunc({expr}) *trunc()* |
1668 | 6532 Return the largest integral value with magnitude less than or |
1621 | 6533 equal to {expr} as a |Float| (truncate towards zero). |
6534 {expr} must evaluate to a |Float| or a |Number|. | |
6535 Examples: > | |
6536 echo trunc(1.456) | |
6537 < 1.0 > | |
6538 echo trunc(-5.456) | |
6539 < -5.0 > | |
6540 echo trunc(4.0) | |
6541 < 4.0 | |
6542 {only available when compiled with the |+float| feature} | |
6543 | |
87 | 6544 *type()* |
6545 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 6546 Number: 0 |
6547 String: 1 | |
6548 Funcref: 2 | |
6549 List: 3 | |
6550 Dictionary: 4 | |
1621 | 6551 Float: 5 |
153 | 6552 To avoid the magic numbers it should be used this way: > |
87 | 6553 :if type(myvar) == type(0) |
6554 :if type(myvar) == type("") | |
6555 :if type(myvar) == type(function("tr")) | |
6556 :if type(myvar) == type([]) | |
153 | 6557 :if type(myvar) == type({}) |
1621 | 6558 :if type(myvar) == type(0.0) |
7 | 6559 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6560 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6561 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
|
6562 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
|
6563 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
|
6564 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6565 {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
|
6566 is used internally. |
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6567 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
|
6568 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
|
6569 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6570 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
|
6571 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6572 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6573 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6574 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
|
6575 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6576 "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
|
6577 "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
|
6578 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
|
6579 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
|
6580 "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
|
6581 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
|
6582 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6583 "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
|
6584 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6585 "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
|
6586 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6587 "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
|
6588 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
|
6589 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6590 "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
|
6591 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6592 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6593 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
|
6594 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
|
6595 "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
|
6596 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6597 "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
|
6598 |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
|
6599 "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
|
6600 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
|
6601 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
|
6602 "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
|
6603 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
|
6604 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
|
6605 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
|
6606 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
|
6607 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6608 "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
|
6609 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
|
6610 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
|
6611 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6612 "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
|
6613 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
|
6614 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6615 |
5747 | 6616 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
6617 Remove second and succeeding copies of repeated adjacent | |
6618 {list} items in-place. Returns {list}. If you want a list | |
6619 to remain unmodified make a copy first: > | |
6620 :let newlist = uniq(copy(mylist)) | |
6621 < The default compare function uses the string representation of | |
6622 each item. For the use of {func} and {dict} see |sort()|. | |
6623 | |
140 | 6624 values({dict}) *values()* |
1621 | 6625 Return a |List| with all the values of {dict}. The |List| is |
685 | 6626 in arbitrary order. |
140 | 6627 |
6628 | |
7 | 6629 virtcol({expr}) *virtcol()* |
6630 The result is a Number, which is the screen column of the file | |
6631 position given with {expr}. That is, the last screen position | |
6632 occupied by the character at that position, when the screen | |
6633 would be of unlimited width. When there is a <Tab> at the | |
6634 position, the returned Number will be the column at the end of | |
6635 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
3445 | 6636 set to 8, it returns 8. |conceal| is ignored. |
1317 | 6637 For the byte position use |col()|. |
6638 For the use of {expr} see |col()|. | |
6639 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 6640 "off" is the offset in screen columns from the start of the |
1266 | 6641 character. E.g., a position within a <Tab> or after the last |
2965 | 6642 character. When "off" is omitted zero is used. |
7 | 6643 When Virtual editing is active in the current mode, a position |
6644 beyond the end of the line can be returned. |'virtualedit'| | |
6645 The accepted positions are: | |
6646 . the cursor position | |
6647 $ the end of the cursor line (the result is the | |
6648 number of displayed characters in the cursor line | |
6649 plus one) | |
6650 'x position of mark x (if the mark is not set, 0 is | |
6651 returned) | |
6447 | 6652 v In Visual mode: the start of the Visual area (the |
6653 cursor is the end). When not in Visual mode | |
6654 returns the cursor position. Differs from |'<| in | |
6655 that it's updated right away. | |
7 | 6656 Note that only marks in the current file can be used. |
6657 Examples: > | |
6658 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
6659 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 6660 virtcol("'t") with text " there", with 't at 'h', returns 6 |
6661 < The first column is 1. 0 is returned for an error. | |
1156 | 6662 A more advanced example that echoes the maximum length of |
6663 all lines: > | |
6664 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
6665 | |
7 | 6666 |
6667 visualmode([expr]) *visualmode()* | |
6668 The result is a String, which describes the last Visual mode | |
856 | 6669 used in the current buffer. Initially it returns an empty |
6670 string, but once Visual mode has been used, it returns "v", | |
6671 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
6672 character-wise, line-wise, or block-wise Visual mode | |
6673 respectively. | |
7 | 6674 Example: > |
6675 :exe "normal " . visualmode() | |
6676 < This enters the same Visual mode as before. It is also useful | |
6677 in scripts if you wish to act differently depending on the | |
6678 Visual mode that was used. | |
1621 | 6679 If Visual mode is active, use |mode()| to get the Visual mode |
6680 (e.g., in a |:vmap|). | |
1661 | 6681 *non-zero-arg* |
6682 If [expr] is supplied and it evaluates to a non-zero Number or | |
6683 a non-empty String, then the Visual mode will be cleared and | |
1621 | 6684 the old value is returned. Note that " " and "0" are also |
1661 | 6685 non-empty strings, thus cause the mode to be cleared. A List, |
6686 Dictionary or Float is not a Number or String, thus does not | |
6687 cause the mode to be cleared. | |
7 | 6688 |
4151 | 6689 wildmenumode() *wildmenumode()* |
6690 Returns non-zero when the wildmenu is active and zero | |
6691 otherwise. See 'wildmenu' and 'wildmode'. | |
6692 This can be used in mappings to handle the 'wildcharm' option | |
6693 gracefully. (Makes only sense with |mapmode-c| mappings). | |
6694 | |
6695 For example to make <c-j> work like <down> in wildmode, use: > | |
6696 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
6697 < | |
6698 (Note, this needs the 'wildcharm' option set appropriately). | |
6699 | |
6700 | |
7 | 6701 *winbufnr()* |
6702 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 6703 associated with window {nr}. When {nr} is zero, the number of |
7 | 6704 the buffer in the current window is returned. When window |
6705 {nr} doesn't exist, -1 is returned. | |
6706 Example: > | |
6707 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
6708 < | |
6709 *wincol()* | |
6710 wincol() The result is a Number, which is the virtual column of the | |
6711 cursor in the window. This is counting screen cells from the | |
6712 left side of the window. The leftmost column is one. | |
6713 | |
6714 winheight({nr}) *winheight()* | |
6715 The result is a Number, which is the height of window {nr}. | |
6716 When {nr} is zero, the height of the current window is | |
6717 returned. When window {nr} doesn't exist, -1 is returned. | |
6718 An existing window always has a height of zero or more. | |
6719 Examples: > | |
6720 :echo "The current window has " . winheight(0) . " lines." | |
6721 < | |
6722 *winline()* | |
6723 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 6724 in the window. This is counting screen lines from the top of |
7 | 6725 the window. The first line is one. |
531 | 6726 If the cursor was moved the view on the file will be updated |
6727 first, this may cause a scroll. | |
7 | 6728 |
6729 *winnr()* | |
20 | 6730 winnr([{arg}]) The result is a Number, which is the number of the current |
6731 window. The top window has number 1. | |
6732 When the optional argument is "$", the number of the | |
3967 | 6733 last window is returned (the window count). > |
6734 let window_count = winnr('$') | |
6735 < When the optional argument is "#", the number of the last | |
20 | 6736 accessed window is returned (where |CTRL-W_p| goes to). |
1156 | 6737 If there is no previous window or it is in another tab page 0 |
6738 is returned. | |
20 | 6739 The number can be used with |CTRL-W_w| and ":wincmd w" |
6740 |:wincmd|. | |
1156 | 6741 Also see |tabpagewinnr()|. |
7 | 6742 |
6743 *winrestcmd()* | |
6744 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
6745 the current window sizes. Only works properly when no windows | |
712 | 6746 are opened or closed and the current window and tab page is |
6747 unchanged. | |
7 | 6748 Example: > |
6749 :let cmd = winrestcmd() | |
6750 :call MessWithWindowSizes() | |
6751 :exe cmd | |
712 | 6752 < |
6753 *winrestview()* | |
6754 winrestview({dict}) | |
6755 Uses the |Dictionary| returned by |winsaveview()| to restore | |
6756 the view of the current window. | |
5940 | 6757 Note: The {dict} does not have to contain all values, that are |
6758 returned by |winsaveview()|. If values are missing, those | |
6759 settings won't be restored. So you can use: > | |
6760 :call winrestview({'curswant': 4}) | |
6761 < | |
6762 This will only set the curswant value (the column the cursor | |
6763 wants to move on vertical movements) of the cursor to column 5 | |
6764 (yes, that is 5), while all other settings will remain the | |
6765 same. This is useful, if you set the cursor position manually. | |
6766 | |
712 | 6767 If you have changed the values the result is unpredictable. |
6768 If the window size changed the result won't be the same. | |
6769 | |
6770 *winsaveview()* | |
6771 winsaveview() Returns a |Dictionary| that contains information to restore | |
6772 the view of the current window. Use |winrestview()| to | |
6773 restore the view. | |
6774 This is useful if you have a mapping that jumps around in the | |
6775 buffer and you want to go back to the original view. | |
6776 This does not save fold information. Use the 'foldenable' | |
798 | 6777 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
|
6778 not opened when moving around. This may have side effects. |
712 | 6779 The return value includes: |
6780 lnum cursor line number | |
5940 | 6781 col cursor column (Note: the first column |
6782 zero, as opposed to what getpos() | |
6783 returns) | |
712 | 6784 coladd cursor column offset for 'virtualedit' |
6785 curswant column for vertical movement | |
6786 topline first line in the window | |
6787 topfill filler lines, only in diff mode | |
6788 leftcol first column displayed | |
6789 skipcol columns skipped | |
6790 Note that no option values are saved. | |
6791 | |
7 | 6792 |
6793 winwidth({nr}) *winwidth()* | |
6794 The result is a Number, which is the width of window {nr}. | |
6795 When {nr} is zero, the width of the current window is | |
6796 returned. When window {nr} doesn't exist, -1 is returned. | |
6797 An existing window always has a width of zero or more. | |
6798 Examples: > | |
6799 :echo "The current window has " . winwidth(0) . " columns." | |
6800 :if winwidth(0) <= 50 | |
6801 : exe "normal 50\<C-W>|" | |
6802 :endif | |
6803 < | |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6804 wordcount() *wordcount()* |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6805 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
|
6806 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
|
6807 |g_CTRL-G| |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6808 The return value includes: |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6809 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
|
6810 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
|
6811 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
|
6812 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
|
6813 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6814 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
|
6815 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6816 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
|
6817 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6818 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
|
6819 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6820 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
|
6821 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6822 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
|
6823 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6824 |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6825 |
158 | 6826 *writefile()* |
6341 | 6827 writefile({list}, {fname} [, {flags}]) |
685 | 6828 Write |List| {list} to file {fname}. Each list item is |
158 | 6829 separated with a NL. Each list item must be a String or |
6830 Number. | |
6341 | 6831 When {flags} contains "b" then binary mode is used: There will |
158 | 6832 not be a NL after the last list item. An empty item at the |
6833 end does cause the last line in the file to end in a NL. | |
6341 | 6834 |
6835 When {flags} contains "a" then append mode is used, lines are | |
6836 append to the file: > | |
6837 :call writefile(["foo"], "event.log", "a") | |
6838 :call writefile(["bar"], "event.log", "a") | |
6839 > | |
6840 < All NL characters are replaced with a NUL character. | |
158 | 6841 Inserting CR characters needs to be done before passing {list} |
6842 to writefile(). | |
6843 An existing file is overwritten, if possible. | |
6844 When the write fails -1 is returned, otherwise 0. There is an | |
6845 error message if the file can't be created or when writing | |
6846 fails. | |
6847 Also see |readfile()|. | |
6848 To copy a file byte for byte: > | |
6849 :let fl = readfile("foo", "b") | |
6850 :call writefile(fl, "foocopy", "b") | |
3214 | 6851 |
6852 | |
6853 xor({expr}, {expr}) *xor()* | |
6854 Bitwise XOR on the two arguments. The arguments are converted | |
6855 to a number. A List, Dict or Float argument causes an error. | |
6856 Example: > | |
6857 :let bits = xor(bits, 0x80) | |
3256 | 6858 < |
3214 | 6859 |
7 | 6860 |
6861 *feature-list* | |
6009 | 6862 There are four types of features: |
7 | 6863 1. Features that are only supported when they have been enabled when Vim |
6864 was compiled |+feature-list|. Example: > | |
6865 :if has("cindent") | |
6866 2. Features that are only supported when certain conditions have been met. | |
6867 Example: > | |
6868 :if has("gui_running") | |
6869 < *has-patch* | |
5814 | 6870 3. Included patches. The "patch123" feature means that patch 123 has been |
6871 included. Note that this form does not check the version of Vim, you need | |
6872 to inspect |v:version| for that. | |
6873 Example (checking version 6.2.148 or later): > | |
7 | 6874 :if v:version > 602 || v:version == 602 && has("patch148") |
5814 | 6875 < Note that it's possible for patch 147 to be omitted even though 148 is |
6876 included. | |
6877 | |
6878 4. Beyond a certain version or at a certain version and including a specific | |
5862 | 6879 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
6880 later, or it is version 7.4 and patch 237 was included. | |
6881 Note that this only works for patch 7.4.237 and later, before that you | |
6882 need to use the example above that checks v:version. Example: > | |
6883 :if has("patch-7.4.248") | |
5814 | 6884 < Note that it's possible for patch 147 to be omitted even though 148 is |
1156 | 6885 included. |
7 | 6886 |
5340 | 6887 acl Compiled with |ACL| support. |
7 | 6888 all_builtin_terms Compiled with all builtin terminals enabled. |
6889 amiga Amiga version of Vim. | |
6890 arabic Compiled with Arabic support |Arabic|. | |
6891 arp Compiled with ARP support (Amiga). | |
613 | 6892 autocmd Compiled with autocommand support. |autocommand| |
7 | 6893 balloon_eval Compiled with |balloon-eval| support. |
435 | 6894 balloon_multiline GUI supports multiline balloons. |
7 | 6895 beos BeOS version of Vim. |
6896 browse Compiled with |:browse| support, and browse() will | |
6897 work. | |
3682 | 6898 browsefilter Compiled with support for |browsefilter|. |
7 | 6899 builtin_terms Compiled with some builtin terminals. |
6900 byte_offset Compiled with support for 'o' in 'statusline' | |
6901 cindent Compiled with 'cindent' support. | |
6902 clientserver Compiled with remote invocation support |clientserver|. | |
6903 clipboard Compiled with 'clipboard' support. | |
6904 cmdline_compl Compiled with |cmdline-completion| support. | |
6905 cmdline_hist Compiled with |cmdline-history| support. | |
6906 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
6907 comments Compiled with |'comments'| support. | |
2681 | 6908 compatible Compiled to be very Vi compatible. |
7 | 6909 cryptv Compiled with encryption support |encryption|. |
6910 cscope Compiled with |cscope| support. | |
6911 debug Compiled with "DEBUG" defined. | |
6912 dialog_con Compiled with console dialog support. | |
6913 dialog_gui Compiled with GUI dialog support. | |
6914 diff Compiled with |vimdiff| and 'diff' support. | |
6915 digraphs Compiled with support for digraphs. | |
6110 | 6916 directx Compiled with support for Direct-X and 'renderoptions'. |
7 | 6917 dnd Compiled with support for the "~ register |quote_~|. |
2681 | 6918 dos16 16 bits DOS version of Vim. |
7 | 6919 dos32 32 bits DOS (DJGPP) version of Vim. |
6920 ebcdic Compiled on a machine with ebcdic character set. | |
6921 emacs_tags Compiled with support for Emacs tags. | |
6922 eval Compiled with expression evaluation support. Always | |
6923 true, of course! | |
6924 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
6925 extra_search Compiled with support for |'incsearch'| and | |
6926 |'hlsearch'| | |
6927 farsi Compiled with Farsi support |farsi|. | |
6928 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 6929 filterpipe When 'shelltemp' is off pipes are used for shell |
6930 read/write/filter commands | |
7 | 6931 find_in_path Compiled with support for include file searches |
6932 |+find_in_path|. | |
1621 | 6933 float Compiled with support for |Float|. |
7 | 6934 fname_case Case in file names matters (for Amiga, MS-DOS, and |
6935 Windows this is not present). | |
6936 folding Compiled with |folding| support. | |
6937 footer Compiled with GUI footer support. |gui-footer| | |
6938 fork Compiled to use fork()/exec() instead of system(). | |
6939 gettext Compiled with message translation |multi-lang| | |
6940 gui Compiled with GUI enabled. | |
6941 gui_athena Compiled with Athena GUI. | |
2681 | 6942 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 6943 gui_gtk Compiled with GTK+ GUI (any version). |
6944 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
6945 gui_mac Compiled with Macintosh GUI. | |
6946 gui_motif Compiled with Motif GUI. | |
6947 gui_photon Compiled with Photon GUI. | |
2681 | 6948 gui_running Vim is running in the GUI, or it will start soon. |
7 | 6949 gui_win32 Compiled with MS Windows Win32 GUI. |
6950 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
6951 hangul_input Compiled with Hangul input support. |hangul| | |
6952 iconv Can use iconv() for conversion. | |
6953 insert_expand Compiled with support for CTRL-X expansion commands in | |
6954 Insert mode. | |
6955 jumplist Compiled with |jumplist| support. | |
6956 keymap Compiled with 'keymap' support. | |
6957 langmap Compiled with 'langmap' support. | |
6958 libcall Compiled with |libcall()| support. | |
5995 | 6959 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
6960 'breakindent' support. | |
7 | 6961 lispindent Compiled with support for lisp indenting. |
6962 listcmds Compiled with commands for the buffer list |:files| | |
6963 and the argument list |arglist|. | |
6964 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
|
6965 lua Compiled with Lua interface |Lua|. |
7 | 6966 mac Macintosh version of Vim. |
6967 macunix Macintosh version of Vim, using Unix files (OS-X). | |
6968 menu Compiled with support for |:menu|. | |
6969 mksession Compiled with support for |:mksession|. | |
6970 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
6971 mouse Compiled with support mouse. | |
6972 mouse_dec Compiled with support for Dec terminal mouse. | |
6973 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
6974 mouse_netterm Compiled with support for netterm mouse. | |
6975 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 6976 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3750 | 6977 mouse_sgr Compiled with support for sgr mouse. |
3224 | 6978 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 6979 mouse_xterm Compiled with support for xterm mouse. |
2681 | 6980 mouseshape Compiled with support for 'mouseshape'. |
1768 | 6981 multi_byte Compiled with support for 'encoding' |
6982 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 6983 multi_byte_ime Compiled with support for IME input method. |
6984 multi_lang Compiled with support for multiple languages. | |
14 | 6985 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 6986 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 6987 netbeans_intg Compiled with support for |netbeans|. |
6988 ole Compiled with OLE automation support for Win32. | |
6989 os2 OS/2 version of Vim. | |
6990 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
6991 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
|
6992 persistent_undo Compiled with support for persistent undo history. |
7 | 6993 postscript Compiled with PostScript file printing. |
6994 printer Compiled with |:hardcopy| support. | |
170 | 6995 profile Compiled with |:profile| support. |
2826 | 6996 python Compiled with Python 2.x interface. |has-python| |
6997 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 6998 qnx QNX version of Vim. |
6999 quickfix Compiled with |quickfix| support. | |
857 | 7000 reltime Compiled with |reltime()| support. |
7 | 7001 rightleft Compiled with 'rightleft' support. |
7002 ruby Compiled with Ruby interface |ruby|. | |
7003 scrollbind Compiled with 'scrollbind' support. | |
7004 showcmd Compiled with 'showcmd' support. | |
7005 signs Compiled with |:sign| support. | |
7006 smartindent Compiled with 'smartindent' support. | |
9 | 7007 sniff Compiled with SNiFF interface support. |
2681 | 7008 spell Compiled with spell checking support |spell|. |
1989 | 7009 startuptime Compiled with |--startuptime| support. |
7 | 7010 statusline Compiled with support for 'statusline', 'rulerformat' |
7011 and special formats of 'titlestring' and 'iconstring'. | |
7012 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 7013 syntax Compiled with syntax highlighting support |syntax|. |
7 | 7014 syntax_items There are active syntax highlighting items for the |
7015 current buffer. | |
7016 system Compiled to use system() instead of fork()/exec(). | |
7017 tag_binary Compiled with binary searching in tags files | |
7018 |tag-binary-search|. | |
7019 tag_old_static Compiled with support for old static tags | |
7020 |tag-old-static|. | |
7021 tag_any_white Compiled with support for any white characters in tags | |
7022 files |tag-any-white|. | |
7023 tcl Compiled with Tcl interface. | |
7024 terminfo Compiled with terminfo instead of termcap. | |
7025 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
7026 textobjects Compiled with support for |text-objects|. | |
7027 tgetent Compiled with tgetent support, able to use a termcap | |
7028 or terminfo file. | |
7029 title Compiled with window title support |'title'|. | |
7030 toolbar Compiled with support for |gui-toolbar|. | |
7031 unix Unix version of Vim. | |
7032 user_commands User-defined commands. | |
2681 | 7033 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 7034 vim_starting True while initial source'ing takes place. |startup| |
2681 | 7035 viminfo Compiled with viminfo support. |
7 | 7036 virtualedit Compiled with 'virtualedit' option. |
7037 visual Compiled with Visual mode. | |
7038 visualextra Compiled with extra Visual mode commands. | |
7039 |blockwise-operators|. | |
7040 vms VMS version of Vim. | |
7041 vreplace Compiled with |gR| and |gr| commands. | |
7042 wildignore Compiled with 'wildignore' option. | |
7043 wildmenu Compiled with 'wildmenu' option. | |
7044 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
|
7045 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
|
7046 64 bits) |
2681 | 7047 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 7048 win64 Win64 version of Vim (MS-Windows 64 bit). |
7049 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 7050 winaltkeys Compiled with 'winaltkeys' option. |
7051 windows Compiled with support for more than one window. | |
7 | 7052 writebackup Compiled with 'writebackup' default on. |
7053 xfontset Compiled with X fontset support |xfontset|. | |
7054 xim Compiled with X input method support |xim|. | |
5340 | 7055 xpm Compiled with pixmap support. |
7056 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
7057 backward compatibility. Use "xpm" instead.) | |
7 | 7058 xsmp Compiled with X session management support. |
7059 xsmp_interact Compiled with interactive X session management support. | |
7060 xterm_clipboard Compiled with support for xterm clipboard. | |
7061 xterm_save Compiled with support for saving and restoring the | |
7062 xterm screen. | |
7063 x11 Compiled with X11 support. | |
7064 | |
7065 *string-match* | |
7066 Matching a pattern in a String | |
7067 | |
7068 A regexp pattern as explained at |pattern| is normally used to find a match in | |
7069 the buffer lines. When a pattern is used to find a match in a String, almost | |
7070 everything works in the same way. The difference is that a String is handled | |
7071 like it is one line. When it contains a "\n" character, this is not seen as a | |
7072 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
7073 with ".". Example: > | |
7074 :let a = "aaaa\nxxxx" | |
7075 :echo matchstr(a, "..\n..") | |
7076 aa | |
7077 xx | |
7078 :echo matchstr(a, "a.x") | |
7079 a | |
7080 x | |
7081 | |
7082 Don't forget that "^" will only match at the first character of the String and | |
7083 "$" at the last character of the string. They don't match after or before a | |
7084 "\n". | |
7085 | |
7086 ============================================================================== | |
7087 5. Defining functions *user-functions* | |
7088 | |
7089 New functions can be defined. These can be called just like builtin | |
7090 functions. The function executes a sequence of Ex commands. Normal mode | |
7091 commands can be executed with the |:normal| command. | |
7092 | |
7093 The function name must start with an uppercase letter, to avoid confusion with | |
7094 builtin functions. To prevent from using the same name in different scripts | |
7095 avoid obvious, short names. A good habit is to start the function name with | |
7096 the name of the script, e.g., "HTMLcolor()". | |
7097 | |
504 | 7098 It's also possible to use curly braces, see |curly-braces-names|. And the |
7099 |autoload| facility is useful to define a function only when it's called. | |
7 | 7100 |
7101 *local-function* | |
7102 A function local to a script must start with "s:". A local script function | |
7103 can only be called from within the script and from functions, user commands | |
7104 and autocommands defined in the script. It is also possible to call the | |
1698 | 7105 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 7106 instead of "s:" when the mapping is expanded outside of the script. |
5862 | 7107 There are only script-local functions, no buffer-local or window-local |
7108 functions. | |
7 | 7109 |
7110 *:fu* *:function* *E128* *E129* *E123* | |
7111 :fu[nction] List all functions and their arguments. | |
7112 | |
7113 :fu[nction] {name} List function {name}. | |
685 | 7114 {name} can also be a |Dictionary| entry that is a |
7115 |Funcref|: > | |
114 | 7116 :function dict.init |
504 | 7117 |
7118 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
7119 Example that lists all functions ending with "File": > | |
7120 :function /File$ | |
482 | 7121 < |
7122 *:function-verbose* | |
7123 When 'verbose' is non-zero, listing a function will also display where it was | |
7124 last defined. Example: > | |
7125 | |
7126 :verbose function SetFileTypeSH | |
7127 function SetFileTypeSH(name) | |
7128 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
7129 < | |
484 | 7130 See |:verbose-cmd| for more information. |
482 | 7131 |
5862 | 7132 *E124* *E125* *E853* *E884* |
102 | 7133 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 7134 Define a new function by the name {name}. The name |
7135 must be made of alphanumeric characters and '_', and | |
5862 | 7136 must start with a capital or "s:" (see above). Note |
7137 that using "b:" or "g:" is not allowed. (since patch | |
7138 7.4.260 E884 is given if the function name has a colon | |
7139 in the name, e.g. for "foo:bar()". Before that patch | |
7140 no error was given). | |
114 | 7141 |
685 | 7142 {name} can also be a |Dictionary| entry that is a |
7143 |Funcref|: > | |
114 | 7144 :function dict.init(arg) |
1621 | 7145 < "dict" must be an existing dictionary. The entry |
114 | 7146 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 7147 is required to overwrite an existing function. The |
114 | 7148 result is a |Funcref| to a numbered function. The |
7149 function can only be used with a |Funcref| and will be | |
7150 deleted if there are no more references to it. | |
7 | 7151 *E127* *E122* |
7152 When a function by this name already exists and [!] is | |
7153 not used an error message is given. When [!] is used, | |
7154 an existing function is silently replaced. Unless it | |
7155 is currently being executed, that is an error. | |
133 | 7156 |
7157 For the {arguments} see |function-argument|. | |
7158 | |
5618 | 7159 *:func-range* *a:firstline* *a:lastline* |
7 | 7160 When the [range] argument is added, the function is |
7161 expected to take care of a range itself. The range is | |
7162 passed as "a:firstline" and "a:lastline". If [range] | |
7163 is excluded, ":{range}call" will call the function for | |
7164 each line in the range, with the cursor on the start | |
7165 of each line. See |function-range-example|. | |
3967 | 7166 The cursor is still moved to the first line of the |
7167 range, as is the case with all Ex commands. | |
5618 | 7168 *:func-abort* |
7 | 7169 When the [abort] argument is added, the function will |
7170 abort as soon as an error is detected. | |
5618 | 7171 *:func-dict* |
102 | 7172 When the [dict] argument is added, the function must |
1621 | 7173 be invoked through an entry in a |Dictionary|. The |
102 | 7174 local variable "self" will then be set to the |
7175 dictionary. See |Dictionary-function|. | |
7 | 7176 |
1621 | 7177 *function-search-undo* |
653 | 7178 The last used search pattern and the redo command "." |
1621 | 7179 will not be changed by the function. This also |
7180 implies that the effect of |:nohlsearch| is undone | |
7181 when the function returns. | |
653 | 7182 |
7 | 7183 *:endf* *:endfunction* *E126* *E193* |
7184 :endf[unction] The end of a function definition. Must be on a line | |
7185 by its own, without other commands. | |
7186 | |
7187 *:delf* *:delfunction* *E130* *E131* | |
7188 :delf[unction] {name} Delete function {name}. | |
685 | 7189 {name} can also be a |Dictionary| entry that is a |
7190 |Funcref|: > | |
114 | 7191 :delfunc dict.init |
1621 | 7192 < This will remove the "init" entry from "dict". The |
114 | 7193 function is deleted if there are no more references to |
7194 it. | |
7 | 7195 *:retu* *:return* *E133* |
7196 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
7197 evaluated and returned as the result of the function. | |
7198 If "[expr]" is not given, the number 0 is returned. | |
7199 When a function ends without an explicit ":return", | |
7200 the number 0 is returned. | |
7201 Note that there is no check for unreachable lines, | |
7202 thus there is no warning if commands follow ":return". | |
7203 | |
7204 If the ":return" is used after a |:try| but before the | |
7205 matching |:finally| (if present), the commands | |
7206 following the ":finally" up to the matching |:endtry| | |
7207 are executed first. This process applies to all | |
7208 nested ":try"s inside the function. The function | |
7209 returns at the outermost ":endtry". | |
7210 | |
133 | 7211 *function-argument* *a:var* |
1621 | 7212 An argument can be defined by giving its name. In the function this can then |
133 | 7213 be used as "a:name" ("a:" for argument). |
1156 | 7214 *a:0* *a:1* *a:000* *E740* *...* |
133 | 7215 Up to 20 arguments can be given, separated by commas. After the named |
7216 arguments an argument "..." can be specified, which means that more arguments | |
7217 may optionally be following. In the function the extra arguments can be used | |
7218 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 7219 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
7220 that "a:1" is the same as "a:000[0]". | |
148 | 7221 *E742* |
7222 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 7223 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 7224 Thus you can pass a |List| to a function and have the function add an item to |
7225 it. If you want to make sure the function cannot change a |List| or | |
7226 |Dictionary| use |:lockvar|. | |
133 | 7227 |
7228 When not using "...", the number of arguments in a function call must be equal | |
7229 to the number of named arguments. When using "...", the number of arguments | |
7230 may be larger. | |
7231 | |
7232 It is also possible to define a function without any arguments. You must | |
7233 still supply the () then. The body of the function follows in the next lines, | |
7234 until the matching |:endfunction|. It is allowed to define another function | |
7235 inside a function body. | |
7236 | |
7237 *local-variables* | |
7 | 7238 Inside a function variables can be used. These are local variables, which |
7239 will disappear when the function returns. Global variables need to be | |
7240 accessed with "g:". | |
7241 | |
7242 Example: > | |
7243 :function Table(title, ...) | |
7244 : echohl Title | |
7245 : echo a:title | |
7246 : echohl None | |
140 | 7247 : echo a:0 . " items:" |
7248 : for s in a:000 | |
7249 : echon ' ' . s | |
7250 : endfor | |
7 | 7251 :endfunction |
7252 | |
7253 This function can then be called with: > | |
140 | 7254 call Table("Table", "line1", "line2") |
7255 call Table("Empty Table") | |
7 | 7256 |
1156 | 7257 To return more than one value, return a |List|: > |
7258 :function Compute(n1, n2) | |
7 | 7259 : if a:n2 == 0 |
1156 | 7260 : return ["fail", 0] |
7 | 7261 : endif |
1156 | 7262 : return ["ok", a:n1 / a:n2] |
7 | 7263 :endfunction |
7264 | |
7265 This function can then be called with: > | |
1156 | 7266 :let [success, div] = Compute(102, 6) |
7 | 7267 :if success == "ok" |
7268 : echo div | |
7269 :endif | |
1156 | 7270 < |
786 | 7271 *:cal* *:call* *E107* *E117* |
7 | 7272 :[range]cal[l] {name}([arguments]) |
7273 Call a function. The name of the function and its arguments | |
7274 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 7275 used. The returned value is discarded. |
7 | 7276 Without a range and for functions that accept a range, the |
7277 function is called once. When a range is given the cursor is | |
7278 positioned at the start of the first line before executing the | |
7279 function. | |
7280 When a range is given and the function doesn't handle it | |
7281 itself, the function is executed for each line in the range, | |
7282 with the cursor in the first column of that line. The cursor | |
7283 is left at the last line (possibly moved by the last function | |
1621 | 7284 call). The arguments are re-evaluated for each line. Thus |
7 | 7285 this works: |
7286 *function-range-example* > | |
7287 :function Mynumber(arg) | |
7288 : echo line(".") . " " . a:arg | |
7289 :endfunction | |
7290 :1,5call Mynumber(getline(".")) | |
7291 < | |
7292 The "a:firstline" and "a:lastline" are defined anyway, they | |
7293 can be used to do something different at the start or end of | |
7294 the range. | |
7295 | |
7296 Example of a function that handles the range itself: > | |
7297 | |
7298 :function Cont() range | |
7299 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
7300 :endfunction | |
7301 :4,8call Cont() | |
7302 < | |
7303 This function inserts the continuation character "\" in front | |
7304 of all the lines in the range, except the first one. | |
7305 | |
1156 | 7306 When the function returns a composite value it can be further |
7307 dereferenced, but the range will not be used then. Example: > | |
7308 :4,8call GetDict().method() | |
7309 < Here GetDict() gets the range but method() does not. | |
7310 | |
7 | 7311 *E132* |
7312 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
7313 option. | |
7314 | |
161 | 7315 |
7316 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 7317 *autoload-functions* |
7318 When using many or large functions, it's possible to automatically define them | |
161 | 7319 only when they are used. There are two methods: with an autocommand and with |
7320 the "autoload" directory in 'runtimepath'. | |
7321 | |
7322 | |
7323 Using an autocommand ~ | |
7324 | |
170 | 7325 This is introduced in the user manual, section |41.14|. |
7326 | |
161 | 7327 The autocommand is useful if you have a plugin that is a long Vim script file. |
7328 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 7329 That makes Vim startup faster. The autocommand should then load the same file |
161 | 7330 again, setting a variable to skip the |:finish| command. |
7331 | |
7332 Use the FuncUndefined autocommand event with a pattern that matches the | |
7333 function(s) to be defined. Example: > | |
7 | 7334 |
7335 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
7336 | |
7337 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
7338 "BufNet". Also see |FuncUndefined|. | |
7339 | |
161 | 7340 |
7341 Using an autoload script ~ | |
168 | 7342 *autoload* *E746* |
170 | 7343 This is introduced in the user manual, section |41.15|. |
7344 | |
161 | 7345 Using a script in the "autoload" directory is simpler, but requires using |
7346 exactly the right file name. A function that can be autoloaded has a name | |
7347 like this: > | |
7348 | |
270 | 7349 :call filename#funcname() |
161 | 7350 |
7351 When such a function is called, and it is not defined yet, Vim will search the | |
7352 "autoload" directories in 'runtimepath' for a script file called | |
7353 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
7354 then define the function like this: > | |
7355 | |
270 | 7356 function filename#funcname() |
161 | 7357 echo "Done!" |
7358 endfunction | |
7359 | |
530 | 7360 The file name and the name used before the # in the function must match |
161 | 7361 exactly, and the defined function must have the name exactly as it will be |
7362 called. | |
7363 | |
270 | 7364 It is possible to use subdirectories. Every # in the function name works like |
7365 a path separator. Thus when calling a function: > | |
7366 | |
7367 :call foo#bar#func() | |
161 | 7368 |
7369 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
7370 | |
168 | 7371 This also works when reading a variable that has not been set yet: > |
7372 | |
270 | 7373 :let l = foo#bar#lvar |
168 | 7374 |
557 | 7375 However, when the autoload script was already loaded it won't be loaded again |
7376 for an unknown variable. | |
7377 | |
168 | 7378 When assigning a value to such a variable nothing special happens. This can |
7379 be used to pass settings to the autoload script before it's loaded: > | |
7380 | |
270 | 7381 :let foo#bar#toggle = 1 |
7382 :call foo#bar#func() | |
168 | 7383 |
164 | 7384 Note that when you make a mistake and call a function that is supposed to be |
7385 defined in an autoload script, but the script doesn't actually define the | |
7386 function, the script will be sourced every time you try to call the function. | |
168 | 7387 And you will get an error message every time. |
7388 | |
7389 Also note that if you have two script files, and one calls a function in the | |
1621 | 7390 other and vice versa, before the used function is defined, it won't work. |
168 | 7391 Avoid using the autoload functionality at the toplevel. |
161 | 7392 |
794 | 7393 Hint: If you distribute a bunch of scripts you can pack them together with the |
7394 |vimball| utility. Also read the user manual |distribute-script|. | |
7395 | |
7 | 7396 ============================================================================== |
7397 6. Curly braces names *curly-braces-names* | |
7398 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7399 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
|
7400 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
|
7401 wrapped in braces {} like this: > |
7 | 7402 my_{adjective}_variable |
7403 | |
7404 When Vim encounters this, it evaluates the expression inside the braces, puts | |
7405 that in place of the expression, and re-interprets the whole as a variable | |
7406 name. So in the above example, if the variable "adjective" was set to | |
7407 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
7408 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
7409 | |
7410 One application for this is to create a set of variables governed by an option | |
1621 | 7411 value. For example, the statement > |
7 | 7412 echo my_{&background}_message |
7413 | |
7414 would output the contents of "my_dark_message" or "my_light_message" depending | |
7415 on the current value of 'background'. | |
7416 | |
7417 You can use multiple brace pairs: > | |
7418 echo my_{adverb}_{adjective}_message | |
7419 ..or even nest them: > | |
7420 echo my_{ad{end_of_word}}_message | |
7421 where "end_of_word" is either "verb" or "jective". | |
7422 | |
7423 However, the expression inside the braces must evaluate to a valid single | |
236 | 7424 variable name, e.g. this is invalid: > |
7 | 7425 :let foo='a + b' |
7426 :echo c{foo}d | |
7427 .. since the result of expansion is "ca + bd", which is not a variable name. | |
7428 | |
7429 *curly-braces-function-names* | |
7430 You can call and define functions by an evaluated name in a similar way. | |
7431 Example: > | |
7432 :let func_end='whizz' | |
7433 :call my_func_{func_end}(parameter) | |
7434 | |
7435 This would call the function "my_func_whizz(parameter)". | |
7436 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7437 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7438 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7439 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7440 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7441 |
7 | 7442 ============================================================================== |
7443 7. Commands *expression-commands* | |
7444 | |
7445 :let {var-name} = {expr1} *:let* *E18* | |
7446 Set internal variable {var-name} to the result of the | |
7447 expression {expr1}. The variable will get the type | |
7448 from the {expr}. If {var-name} didn't exist yet, it | |
7449 is created. | |
7450 | |
85 | 7451 :let {var-name}[{idx}] = {expr1} *E689* |
7452 Set a list item to the result of the expression | |
7453 {expr1}. {var-name} must refer to a list and {idx} | |
7454 must be a valid index in that list. For nested list | |
7455 the index can be repeated. | |
1621 | 7456 This cannot be used to add an item to a |List|. |
7457 This cannot be used to set a byte in a String. You | |
7458 can do that like this: > | |
7459 :let var = var[0:2] . 'X' . var[4:] | |
7460 < | |
114 | 7461 *E711* *E719* |
7462 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 7463 Set a sequence of items in a |List| to the result of |
7464 the expression {expr1}, which must be a list with the | |
87 | 7465 correct number of items. |
7466 {idx1} can be omitted, zero is used instead. | |
7467 {idx2} can be omitted, meaning the end of the list. | |
7468 When the selected range of items is partly past the | |
7469 end of the list, items will be added. | |
7470 | |
153 | 7471 *:let+=* *:let-=* *:let.=* *E734* |
114 | 7472 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
7473 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
7474 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
7475 These fail if {var} was not set yet and when the type | |
7476 of {var} and {expr1} don't fit the operator. | |
7477 | |
7478 | |
7 | 7479 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
7480 Set environment variable {env-name} to the result of | |
7481 the expression {expr1}. The type is always String. | |
114 | 7482 :let ${env-name} .= {expr1} |
7483 Append {expr1} to the environment variable {env-name}. | |
7484 If the environment variable didn't exist yet this | |
7485 works like "=". | |
7 | 7486 |
7487 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
7488 Write the result of the expression {expr1} in register | |
7489 {reg-name}. {reg-name} must be a single letter, and | |
7490 must be the name of a writable register (see | |
7491 |registers|). "@@" can be used for the unnamed | |
7492 register, "@/" for the search pattern. | |
7493 If the result of {expr1} ends in a <CR> or <NL>, the | |
7494 register will be linewise, otherwise it will be set to | |
7495 characterwise. | |
7496 This can be used to clear the last search pattern: > | |
7497 :let @/ = "" | |
7498 < This is different from searching for an empty string, | |
7499 that would match everywhere. | |
7500 | |
114 | 7501 :let @{reg-name} .= {expr1} |
1621 | 7502 Append {expr1} to register {reg-name}. If the |
114 | 7503 register was empty it's like setting it to {expr1}. |
7504 | |
1156 | 7505 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 7506 Set option {option-name} to the result of the |
68 | 7507 expression {expr1}. A String or Number value is |
7508 always converted to the type of the option. | |
7 | 7509 For an option local to a window or buffer the effect |
7510 is just like using the |:set| command: both the local | |
555 | 7511 value and the global value are changed. |
68 | 7512 Example: > |
7513 :let &path = &path . ',/usr/local/include' | |
7 | 7514 |
114 | 7515 :let &{option-name} .= {expr1} |
7516 For a string option: Append {expr1} to the value. | |
7517 Does not insert a comma like |:set+=|. | |
7518 | |
7519 :let &{option-name} += {expr1} | |
7520 :let &{option-name} -= {expr1} | |
7521 For a number or boolean option: Add or subtract | |
7522 {expr1}. | |
7523 | |
7 | 7524 :let &l:{option-name} = {expr1} |
114 | 7525 :let &l:{option-name} .= {expr1} |
7526 :let &l:{option-name} += {expr1} | |
7527 :let &l:{option-name} -= {expr1} | |
7 | 7528 Like above, but only set the local value of an option |
7529 (if there is one). Works like |:setlocal|. | |
7530 | |
7531 :let &g:{option-name} = {expr1} | |
114 | 7532 :let &g:{option-name} .= {expr1} |
7533 :let &g:{option-name} += {expr1} | |
7534 :let &g:{option-name} -= {expr1} | |
7 | 7535 Like above, but only set the global value of an option |
7536 (if there is one). Works like |:setglobal|. | |
7537 | |
85 | 7538 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 7539 {expr1} must evaluate to a |List|. The first item in |
68 | 7540 the list is assigned to {name1}, the second item to |
7541 {name2}, etc. | |
7542 The number of names must match the number of items in | |
685 | 7543 the |List|. |
68 | 7544 Each name can be one of the items of the ":let" |
7545 command as mentioned above. | |
7546 Example: > | |
7547 :let [s, item] = GetItem(s) | |
114 | 7548 < Detail: {expr1} is evaluated first, then the |
7549 assignments are done in sequence. This matters if | |
7550 {name2} depends on {name1}. Example: > | |
7551 :let x = [0, 1] | |
7552 :let i = 0 | |
7553 :let [i, x[i]] = [1, 2] | |
7554 :echo x | |
7555 < The result is [0, 2]. | |
7556 | |
7557 :let [{name1}, {name2}, ...] .= {expr1} | |
7558 :let [{name1}, {name2}, ...] += {expr1} | |
7559 :let [{name1}, {name2}, ...] -= {expr1} | |
7560 Like above, but append/add/subtract the value for each | |
685 | 7561 |List| item. |
68 | 7562 |
7563 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 7564 Like |:let-unpack| above, but the |List| may have more |
114 | 7565 items than there are names. A list of the remaining |
7566 items is assigned to {lastname}. If there are no | |
7567 remaining items {lastname} is set to an empty list. | |
68 | 7568 Example: > |
7569 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
7570 < | |
114 | 7571 :let [{name}, ..., ; {lastname}] .= {expr1} |
7572 :let [{name}, ..., ; {lastname}] += {expr1} | |
7573 :let [{name}, ..., ; {lastname}] -= {expr1} | |
7574 Like above, but append/add/subtract the value for each | |
685 | 7575 |List| item. |
2596 | 7576 |
7577 *E121* | |
1621 | 7578 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 7579 variable names may be given. Special names recognized |
7580 here: *E738* | |
777 | 7581 g: global variables |
7582 b: local buffer variables | |
7583 w: local window variables | |
819 | 7584 t: local tab page variables |
777 | 7585 s: script-local variables |
7586 l: local function variables | |
123 | 7587 v: Vim variables. |
7 | 7588 |
55 | 7589 :let List the values of all variables. The type of the |
7590 variable is indicated before the value: | |
7591 <nothing> String | |
7592 # Number | |
856 | 7593 * Funcref |
7 | 7594 |
148 | 7595 |
1156 | 7596 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 7597 Remove the internal variable {name}. Several variable |
7598 names can be given, they are all removed. The name | |
685 | 7599 may also be a |List| or |Dictionary| item. |
7 | 7600 With [!] no error message is given for non-existing |
7601 variables. | |
685 | 7602 One or more items from a |List| can be removed: > |
108 | 7603 :unlet list[3] " remove fourth item |
7604 :unlet list[3:] " remove fourth item to last | |
685 | 7605 < One item from a |Dictionary| can be removed at a time: > |
108 | 7606 :unlet dict['two'] |
7607 :unlet dict.two | |
1668 | 7608 < This is especially useful to clean up used global |
7609 variables and script-local variables (these are not | |
7610 deleted when the script ends). Function-local | |
7611 variables are automatically deleted when the function | |
7612 ends. | |
7 | 7613 |
148 | 7614 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
7615 Lock the internal variable {name}. Locking means that | |
7616 it can no longer be changed (until it is unlocked). | |
7617 A locked variable can be deleted: > | |
7618 :lockvar v | |
7619 :let v = 'asdf' " fails! | |
7620 :unlet v | |
7621 < *E741* | |
7622 If you try to change a locked variable you get an | |
6530 | 7623 error message: "E741: Value is locked: {name}" |
148 | 7624 |
685 | 7625 [depth] is relevant when locking a |List| or |
7626 |Dictionary|. It specifies how deep the locking goes: | |
7627 1 Lock the |List| or |Dictionary| itself, | |
148 | 7628 cannot add or remove items, but can |
7629 still change their values. | |
7630 2 Also lock the values, cannot change | |
685 | 7631 the items. If an item is a |List| or |
7632 |Dictionary|, cannot add or remove | |
148 | 7633 items, but can still change the |
7634 values. | |
685 | 7635 3 Like 2 but for the |List| / |
7636 |Dictionary| in the |List| / | |
7637 |Dictionary|, one level deeper. | |
7638 The default [depth] is 2, thus when {name} is a |List| | |
7639 or |Dictionary| the values cannot be changed. | |
148 | 7640 *E743* |
7641 For unlimited depth use [!] and omit [depth]. | |
7642 However, there is a maximum depth of 100 to catch | |
7643 loops. | |
7644 | |
685 | 7645 Note that when two variables refer to the same |List| |
7646 and you lock one of them, the |List| will also be | |
819 | 7647 locked when used through the other variable. |
7648 Example: > | |
148 | 7649 :let l = [0, 1, 2, 3] |
7650 :let cl = l | |
7651 :lockvar l | |
7652 :let cl[1] = 99 " won't work! | |
7653 < You may want to make a copy of a list to avoid this. | |
7654 See |deepcopy()|. | |
7655 | |
7656 | |
7657 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
7658 Unlock the internal variable {name}. Does the | |
7659 opposite of |:lockvar|. | |
7660 | |
7661 | |
7 | 7662 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
7663 :en[dif] Execute the commands until the next matching ":else" | |
7664 or ":endif" if {expr1} evaluates to non-zero. | |
7665 | |
7666 From Vim version 4.5 until 5.0, every Ex command in | |
7667 between the ":if" and ":endif" is ignored. These two | |
7668 commands were just to allow for future expansions in a | |
7669 backwards compatible way. Nesting was allowed. Note | |
7670 that any ":else" or ":elseif" was ignored, the "else" | |
7671 part was not executed either. | |
7672 | |
7673 You can use this to remain compatible with older | |
7674 versions: > | |
7675 :if version >= 500 | |
7676 : version-5-specific-commands | |
7677 :endif | |
7678 < The commands still need to be parsed to find the | |
7679 "endif". Sometimes an older Vim has a problem with a | |
7680 new command. For example, ":silent" is recognized as | |
7681 a ":substitute" command. In that case ":execute" can | |
7682 avoid problems: > | |
7683 :if version >= 600 | |
7684 : execute "silent 1,$delete" | |
7685 :endif | |
7686 < | |
7687 NOTE: The ":append" and ":insert" commands don't work | |
7688 properly in between ":if" and ":endif". | |
7689 | |
7690 *:else* *:el* *E581* *E583* | |
7691 :el[se] Execute the commands until the next matching ":else" | |
7692 or ":endif" if they previously were not being | |
7693 executed. | |
7694 | |
7695 *:elseif* *:elsei* *E582* *E584* | |
7696 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
7697 is no extra ":endif". | |
7698 | |
7699 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 7700 *E170* *E585* *E588* *E733* |
7 | 7701 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
7702 as long as {expr1} evaluates to non-zero. | |
7703 When an error is detected from a command inside the | |
7704 loop, execution continues after the "endwhile". | |
75 | 7705 Example: > |
7706 :let lnum = 1 | |
7707 :while lnum <= line("$") | |
7708 :call FixLine(lnum) | |
7709 :let lnum = lnum + 1 | |
7710 :endwhile | |
7711 < | |
7 | 7712 NOTE: The ":append" and ":insert" commands don't work |
99 | 7713 properly inside a ":while" and ":for" loop. |
75 | 7714 |
114 | 7715 :for {var} in {list} *:for* *E690* *E732* |
75 | 7716 :endfo[r] *:endfo* *:endfor* |
7717 Repeat the commands between ":for" and ":endfor" for | |
158 | 7718 each item in {list}. Variable {var} is set to the |
79 | 7719 value of each item. |
7720 When an error is detected for a command inside the | |
75 | 7721 loop, execution continues after the "endfor". |
464 | 7722 Changing {list} inside the loop affects what items are |
7723 used. Make a copy if this is unwanted: > | |
79 | 7724 :for item in copy(mylist) |
7725 < When not making a copy, Vim stores a reference to the | |
7726 next item in the list, before executing the commands | |
1621 | 7727 with the current item. Thus the current item can be |
79 | 7728 removed without effect. Removing any later item means |
7729 it will not be found. Thus the following example | |
7730 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7731 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7732 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7733 endfor |
87 | 7734 < Note that reordering the list (e.g., with sort() or |
7735 reverse()) may have unexpected effects. | |
7736 Note that the type of each list item should be | |
75 | 7737 identical to avoid errors for the type of {var} |
7738 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7739 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7740 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7741 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7742 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7743 endfor |
75 | 7744 |
7745 :for [{var1}, {var2}, ...] in {listlist} | |
7746 :endfo[r] | |
7747 Like ":for" above, but each item in {listlist} must be | |
7748 a list, of which each item is assigned to {var1}, | |
7749 {var2}, etc. Example: > | |
7750 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
7751 :echo getline(lnum)[col] | |
7752 :endfor | |
7753 < | |
7 | 7754 *:continue* *:con* *E586* |
75 | 7755 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
7756 to the start of the loop. | |
7757 If it is used after a |:try| inside the loop but | |
7758 before the matching |:finally| (if present), the | |
7759 commands following the ":finally" up to the matching | |
7760 |:endtry| are executed first. This process applies to | |
7761 all nested ":try"s inside the loop. The outermost | |
7762 ":endtry" then jumps back to the start of the loop. | |
7 | 7763 |
7764 *:break* *:brea* *E587* | |
75 | 7765 :brea[k] When used inside a ":while" or ":for" loop, skips to |
7766 the command after the matching ":endwhile" or | |
7767 ":endfor". | |
7768 If it is used after a |:try| inside the loop but | |
7769 before the matching |:finally| (if present), the | |
7770 commands following the ":finally" up to the matching | |
7771 |:endtry| are executed first. This process applies to | |
7772 all nested ":try"s inside the loop. The outermost | |
7773 ":endtry" then jumps to the command after the loop. | |
7 | 7774 |
7775 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
7776 :endt[ry] Change the error handling for the commands between | |
7777 ":try" and ":endtry" including everything being | |
7778 executed across ":source" commands, function calls, | |
7779 or autocommand invocations. | |
7780 | |
7781 When an error or interrupt is detected and there is | |
7782 a |:finally| command following, execution continues | |
7783 after the ":finally". Otherwise, or when the | |
7784 ":endtry" is reached thereafter, the next | |
7785 (dynamically) surrounding ":try" is checked for | |
7786 a corresponding ":finally" etc. Then the script | |
7787 processing is terminated. (Whether a function | |
7788 definition has an "abort" argument does not matter.) | |
7789 Example: > | |
7790 :try | edit too much | finally | echo "cleanup" | endtry | |
7791 :echo "impossible" " not reached, script terminated above | |
7792 < | |
7793 Moreover, an error or interrupt (dynamically) inside | |
7794 ":try" and ":endtry" is converted to an exception. It | |
7795 can be caught as if it were thrown by a |:throw| | |
7796 command (see |:catch|). In this case, the script | |
7797 processing is not terminated. | |
7798 | |
7799 The value "Vim:Interrupt" is used for an interrupt | |
7800 exception. An error in a Vim command is converted | |
7801 to a value of the form "Vim({command}):{errmsg}", | |
7802 other errors are converted to a value of the form | |
7803 "Vim:{errmsg}". {command} is the full command name, | |
7804 and {errmsg} is the message that is displayed if the | |
7805 error exception is not caught, always beginning with | |
7806 the error number. | |
7807 Examples: > | |
7808 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
7809 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
7810 < | |
7811 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7812 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 7813 |:finally|, or |:endtry| that belongs to the same |
7814 |:try| as the ":catch" are executed when an exception | |
7815 matching {pattern} is being thrown and has not yet | |
7816 been caught by a previous ":catch". Otherwise, these | |
7817 commands are skipped. | |
7818 When {pattern} is omitted all errors are caught. | |
7819 Examples: > | |
7820 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
7821 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
7822 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
7823 :catch /^Vim(write):/ " catch all errors in :write | |
7824 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
7825 :catch /my-exception/ " catch user exception | |
7826 :catch /.*/ " catch everything | |
7827 :catch " same as /.*/ | |
7828 < | |
7829 Another character can be used instead of / around the | |
7830 {pattern}, so long as it does not have a special | |
7831 meaning (e.g., '|' or '"') and doesn't occur inside | |
7832 {pattern}. | |
5814 | 7833 Information about the exception is available in |
7834 |v:exception|. Also see |throw-variables|. | |
7 | 7835 NOTE: It is not reliable to ":catch" the TEXT of |
7836 an error message because it may vary in different | |
7837 locales. | |
7838 | |
7839 *:fina* *:finally* *E606* *E607* | |
7840 :fina[lly] The following commands until the matching |:endtry| | |
7841 are executed whenever the part between the matching | |
7842 |:try| and the ":finally" is left: either by falling | |
7843 through to the ":finally" or by a |:continue|, | |
7844 |:break|, |:finish|, or |:return|, or by an error or | |
7845 interrupt or exception (see |:throw|). | |
7846 | |
7847 *:th* *:throw* *E608* | |
7848 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
7849 If the ":throw" is used after a |:try| but before the | |
7850 first corresponding |:catch|, commands are skipped | |
7851 until the first ":catch" matching {expr1} is reached. | |
7852 If there is no such ":catch" or if the ":throw" is | |
7853 used after a ":catch" but before the |:finally|, the | |
7854 commands following the ":finally" (if present) up to | |
7855 the matching |:endtry| are executed. If the ":throw" | |
7856 is after the ":finally", commands up to the ":endtry" | |
7857 are skipped. At the ":endtry", this process applies | |
7858 again for the next dynamically surrounding ":try" | |
7859 (which may be found in a calling function or sourcing | |
7860 script), until a matching ":catch" has been found. | |
7861 If the exception is not caught, the command processing | |
7862 is terminated. | |
7863 Example: > | |
7864 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 7865 < Note that "catch" may need to be on a separate line |
7866 for when an error causes the parsing to skip the whole | |
7867 line and not see the "|" that separates the commands. | |
7 | 7868 |
7869 *:ec* *:echo* | |
7870 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
7871 first {expr1} starts on a new line. | |
7872 Also see |:comment|. | |
7873 Use "\n" to start a new line. Use "\r" to move the | |
7874 cursor to the first column. | |
7875 Uses the highlighting set by the |:echohl| command. | |
7876 Cannot be followed by a comment. | |
7877 Example: > | |
7878 :echo "the value of 'shell' is" &shell | |
1156 | 7879 < *:echo-redraw* |
7880 A later redraw may make the message disappear again. | |
7881 And since Vim mostly postpones redrawing until it's | |
7882 finished with a sequence of commands this happens | |
7883 quite often. To avoid that a command from before the | |
7884 ":echo" causes a redraw afterwards (redraws are often | |
7885 postponed until you type something), force a redraw | |
7886 with the |:redraw| command. Example: > | |
7 | 7887 :new | redraw | echo "there is a new window" |
7888 < | |
7889 *:echon* | |
7890 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
7891 |:comment|. | |
7892 Uses the highlighting set by the |:echohl| command. | |
7893 Cannot be followed by a comment. | |
7894 Example: > | |
7895 :echon "the value of 'shell' is " &shell | |
7896 < | |
7897 Note the difference between using ":echo", which is a | |
7898 Vim command, and ":!echo", which is an external shell | |
7899 command: > | |
7900 :!echo % --> filename | |
7901 < The arguments of ":!" are expanded, see |:_%|. > | |
7902 :!echo "%" --> filename or "filename" | |
7903 < Like the previous example. Whether you see the double | |
7904 quotes or not depends on your 'shell'. > | |
7905 :echo % --> nothing | |
7906 < The '%' is an illegal character in an expression. > | |
7907 :echo "%" --> % | |
7908 < This just echoes the '%' character. > | |
7909 :echo expand("%") --> filename | |
7910 < This calls the expand() function to expand the '%'. | |
7911 | |
7912 *:echoh* *:echohl* | |
7913 :echoh[l] {name} Use the highlight group {name} for the following | |
7914 |:echo|, |:echon| and |:echomsg| commands. Also used | |
7915 for the |input()| prompt. Example: > | |
7916 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
7917 < Don't forget to set the group back to "None", | |
7918 otherwise all following echo's will be highlighted. | |
7919 | |
7920 *:echom* *:echomsg* | |
7921 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
7922 message in the |message-history|. | |
7923 Spaces are placed between the arguments as with the | |
7924 |:echo| command. But unprintable characters are | |
7925 displayed, not interpreted. | |
1156 | 7926 The parsing works slightly different from |:echo|, |
7927 more like |:execute|. All the expressions are first | |
7928 evaluated and concatenated before echoing anything. | |
7929 The expressions must evaluate to a Number or String, a | |
7930 Dictionary or List causes an error. | |
7 | 7931 Uses the highlighting set by the |:echohl| command. |
7932 Example: > | |
7933 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 7934 < See |:echo-redraw| to avoid the message disappearing |
7935 when the screen is redrawn. | |
7 | 7936 *:echoe* *:echoerr* |
7937 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
7938 message in the |message-history|. When used in a | |
7939 script or function the line number will be added. | |
7940 Spaces are placed between the arguments as with the | |
1621 | 7941 :echo command. When used inside a try conditional, |
7 | 7942 the message is raised as an error exception instead |
7943 (see |try-echoerr|). | |
7944 Example: > | |
7945 :echoerr "This script just failed!" | |
7946 < If you just want a highlighted message use |:echohl|. | |
7947 And to get a beep: > | |
7948 :exe "normal \<Esc>" | |
7949 < | |
7950 *:exe* *:execute* | |
7951 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 7952 of {expr1} as an Ex command. |
7953 Multiple arguments are concatenated, with a space in | |
7954 between. To avoid the extra space use the "." | |
7955 operator to concatenate strings into one argument. | |
7956 {expr1} is used as the processed command, command line | |
7957 editing keys are not recognized. | |
7 | 7958 Cannot be followed by a comment. |
7959 Examples: > | |
2152 | 7960 :execute "buffer" nextbuf |
7961 :execute "normal" count . "w" | |
7 | 7962 < |
7963 ":execute" can be used to append a command to commands | |
7964 that don't accept a '|'. Example: > | |
7965 :execute '!ls' | echo "theend" | |
7966 | |
7967 < ":execute" is also a nice way to avoid having to type | |
7968 control characters in a Vim script for a ":normal" | |
7969 command: > | |
7970 :execute "normal ixxx\<Esc>" | |
7971 < This has an <Esc> character, see |expr-string|. | |
7972 | |
1621 | 7973 Be careful to correctly escape special characters in |
7974 file names. The |fnameescape()| function can be used | |
1661 | 7975 for Vim commands, |shellescape()| for |:!| commands. |
7976 Examples: > | |
1621 | 7977 :execute "e " . fnameescape(filename) |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
7978 :execute "!ls " . shellescape(filename, 1) |
1621 | 7979 < |
7 | 7980 Note: The executed string may be any command-line, but |
5763 | 7981 starting or ending "if", "while" and "for" does not |
7982 always work, because when commands are skipped the | |
7983 ":execute" is not evaluated and Vim loses track of | |
7984 where blocks start and end. Also "break" and | |
7985 "continue" should not be inside ":execute". | |
7986 This example does not work, because the ":execute" is | |
7987 not evaluated and Vim does not see the "while", and | |
7988 gives an error for finding an ":endwhile": > | |
7989 :if 0 | |
7990 : execute 'while i > 5' | |
7991 : echo "test" | |
7992 : endwhile | |
7993 :endif | |
7 | 7994 < |
7995 It is allowed to have a "while" or "if" command | |
7996 completely in the executed string: > | |
7997 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
7998 < | |
7999 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8000 *:exe-comment* |
7 | 8001 ":execute", ":echo" and ":echon" cannot be followed by |
8002 a comment directly, because they see the '"' as the | |
8003 start of a string. But, you can use '|' followed by a | |
8004 comment. Example: > | |
8005 :echo "foo" | "this is a comment | |
8006 | |
8007 ============================================================================== | |
8008 8. Exception handling *exception-handling* | |
8009 | |
8010 The Vim script language comprises an exception handling feature. This section | |
8011 explains how it can be used in a Vim script. | |
8012 | |
8013 Exceptions may be raised by Vim on an error or on interrupt, see | |
8014 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
8015 exception by using the ":throw" command, see |throw-catch|. | |
8016 | |
8017 | |
8018 TRY CONDITIONALS *try-conditionals* | |
8019 | |
8020 Exceptions can be caught or can cause cleanup code to be executed. You can | |
8021 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
8022 a finally clause (to be executed for cleanup). | |
8023 A try conditional begins with a |:try| command and ends at the matching | |
8024 |:endtry| command. In between, you can use a |:catch| command to start | |
8025 a catch clause, or a |:finally| command to start a finally clause. There may | |
8026 be none or multiple catch clauses, but there is at most one finally clause, | |
8027 which must not be followed by any catch clauses. The lines before the catch | |
8028 clauses and the finally clause is called a try block. > | |
8029 | |
8030 :try | |
1621 | 8031 : ... |
8032 : ... TRY BLOCK | |
8033 : ... | |
7 | 8034 :catch /{pattern}/ |
1621 | 8035 : ... |
8036 : ... CATCH CLAUSE | |
8037 : ... | |
7 | 8038 :catch /{pattern}/ |
1621 | 8039 : ... |
8040 : ... CATCH CLAUSE | |
8041 : ... | |
7 | 8042 :finally |
1621 | 8043 : ... |
8044 : ... FINALLY CLAUSE | |
8045 : ... | |
7 | 8046 :endtry |
8047 | |
8048 The try conditional allows to watch code for exceptions and to take the | |
8049 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
8050 from the try block and also the catch clauses may cause cleanup actions. | |
8051 When no exception is thrown during execution of the try block, the control | |
8052 is transferred to the finally clause, if present. After its execution, the | |
8053 script continues with the line following the ":endtry". | |
8054 When an exception occurs during execution of the try block, the remaining | |
8055 lines in the try block are skipped. The exception is matched against the | |
8056 patterns specified as arguments to the ":catch" commands. The catch clause | |
8057 after the first matching ":catch" is taken, other catch clauses are not | |
8058 executed. The catch clause ends when the next ":catch", ":finally", or | |
8059 ":endtry" command is reached - whatever is first. Then, the finally clause | |
8060 (if present) is executed. When the ":endtry" is reached, the script execution | |
8061 continues in the following line as usual. | |
8062 When an exception that does not match any of the patterns specified by the | |
8063 ":catch" commands is thrown in the try block, the exception is not caught by | |
8064 that try conditional and none of the catch clauses is executed. Only the | |
8065 finally clause, if present, is taken. The exception pends during execution of | |
8066 the finally clause. It is resumed at the ":endtry", so that commands after | |
8067 the ":endtry" are not executed and the exception might be caught elsewhere, | |
8068 see |try-nesting|. | |
8069 When during execution of a catch clause another exception is thrown, the | |
1621 | 8070 remaining lines in that catch clause are not executed. The new exception is |
7 | 8071 not matched against the patterns in any of the ":catch" commands of the same |
8072 try conditional and none of its catch clauses is taken. If there is, however, | |
8073 a finally clause, it is executed, and the exception pends during its | |
8074 execution. The commands following the ":endtry" are not executed. The new | |
8075 exception might, however, be caught elsewhere, see |try-nesting|. | |
8076 When during execution of the finally clause (if present) an exception is | |
1621 | 8077 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 8078 clause has been taken because of an exception from the try block or one of the |
8079 catch clauses, the original (pending) exception is discarded. The commands | |
8080 following the ":endtry" are not executed, and the exception from the finally | |
8081 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
8082 | |
8083 The finally clause is also executed, when a ":break" or ":continue" for | |
8084 a ":while" loop enclosing the complete try conditional is executed from the | |
8085 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
8086 from the try block or a catch clause of a try conditional in a function or | |
8087 sourced script, respectively. The ":break", ":continue", ":return", or | |
8088 ":finish" pends during execution of the finally clause and is resumed when the | |
8089 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
8090 from the finally clause. | |
8091 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
8092 try conditional or when a ":return" or ":finish" is encountered in the finally | |
8093 clause, the rest of the finally clause is skipped, and the ":break", | |
8094 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
8095 clause has been taken because of an exception or an earlier ":break", | |
8096 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
8097 this pending exception or command is discarded. | |
8098 | |
8099 For examples see |throw-catch| and |try-finally|. | |
8100 | |
8101 | |
8102 NESTING OF TRY CONDITIONALS *try-nesting* | |
8103 | |
8104 Try conditionals can be nested arbitrarily. That is, a complete try | |
8105 conditional can be put into the try block, a catch clause, or the finally | |
8106 clause of another try conditional. If the inner try conditional does not | |
8107 catch an exception thrown in its try block or throws a new exception from one | |
8108 of its catch clauses or its finally clause, the outer try conditional is | |
8109 checked according to the rules above. If the inner try conditional is in the | |
8110 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 8111 otherwise only the finally clause is executed. It does not matter for |
7 | 8112 nesting, whether the inner try conditional is directly contained in the outer |
8113 one, or whether the outer one sources a script or calls a function containing | |
8114 the inner try conditional. | |
8115 | |
8116 When none of the active try conditionals catches an exception, just their | |
8117 finally clauses are executed. Thereafter, the script processing terminates. | |
8118 An error message is displayed in case of an uncaught exception explicitly | |
8119 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
8120 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
8121 as usual. | |
8122 | |
8123 For examples see |throw-catch|. | |
8124 | |
8125 | |
8126 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
8127 | |
8128 Exception handling code can get tricky. If you are in doubt what happens, set | |
8129 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
8130 script file. Then you see when an exception is thrown, discarded, caught, or | |
8131 finished. When using a verbosity level of at least 14, things pending in | |
8132 a finally clause are also shown. This information is also given in debug mode | |
8133 (see |debug-scripts|). | |
8134 | |
8135 | |
8136 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
8137 | |
8138 You can throw any number or string as an exception. Use the |:throw| command | |
8139 and pass the value to be thrown as argument: > | |
8140 :throw 4711 | |
8141 :throw "string" | |
8142 < *throw-expression* | |
8143 You can also specify an expression argument. The expression is then evaluated | |
8144 first, and the result is thrown: > | |
8145 :throw 4705 + strlen("string") | |
8146 :throw strpart("strings", 0, 6) | |
8147 | |
8148 An exception might be thrown during evaluation of the argument of the ":throw" | |
8149 command. Unless it is caught there, the expression evaluation is abandoned. | |
8150 The ":throw" command then does not throw a new exception. | |
8151 Example: > | |
8152 | |
8153 :function! Foo(arg) | |
8154 : try | |
8155 : throw a:arg | |
8156 : catch /foo/ | |
8157 : endtry | |
8158 : return 1 | |
8159 :endfunction | |
8160 : | |
8161 :function! Bar() | |
8162 : echo "in Bar" | |
8163 : return 4710 | |
8164 :endfunction | |
8165 : | |
8166 :throw Foo("arrgh") + Bar() | |
8167 | |
8168 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
8169 executed. > | |
8170 :throw Foo("foo") + Bar() | |
8171 however displays "in Bar" and throws 4711. | |
8172 | |
8173 Any other command that takes an expression as argument might also be | |
1621 | 8174 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 8175 exception is then propagated to the caller of the command. |
8176 Example: > | |
8177 | |
8178 :if Foo("arrgh") | |
8179 : echo "then" | |
8180 :else | |
8181 : echo "else" | |
8182 :endif | |
8183 | |
8184 Here neither of "then" or "else" is displayed. | |
8185 | |
8186 *catch-order* | |
8187 Exceptions can be caught by a try conditional with one or more |:catch| | |
8188 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
8189 command can be specified as a pattern argument. The subsequent catch clause | |
8190 gets executed when a matching exception is caught. | |
8191 Example: > | |
8192 | |
8193 :function! Foo(value) | |
8194 : try | |
8195 : throw a:value | |
8196 : catch /^\d\+$/ | |
8197 : echo "Number thrown" | |
8198 : catch /.*/ | |
8199 : echo "String thrown" | |
8200 : endtry | |
8201 :endfunction | |
8202 : | |
8203 :call Foo(0x1267) | |
8204 :call Foo('string') | |
8205 | |
8206 The first call to Foo() displays "Number thrown", the second "String thrown". | |
8207 An exception is matched against the ":catch" commands in the order they are | |
8208 specified. Only the first match counts. So you should place the more | |
8209 specific ":catch" first. The following order does not make sense: > | |
8210 | |
8211 : catch /.*/ | |
8212 : echo "String thrown" | |
8213 : catch /^\d\+$/ | |
8214 : echo "Number thrown" | |
8215 | |
8216 The first ":catch" here matches always, so that the second catch clause is | |
8217 never taken. | |
8218 | |
8219 *throw-variables* | |
8220 If you catch an exception by a general pattern, you may access the exact value | |
8221 in the variable |v:exception|: > | |
8222 | |
8223 : catch /^\d\+$/ | |
8224 : echo "Number thrown. Value is" v:exception | |
8225 | |
8226 You may also be interested where an exception was thrown. This is stored in | |
8227 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
8228 exception most recently caught as long it is not finished. | |
8229 Example: > | |
8230 | |
8231 :function! Caught() | |
8232 : if v:exception != "" | |
8233 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
8234 : else | |
8235 : echo 'Nothing caught' | |
8236 : endif | |
8237 :endfunction | |
8238 : | |
8239 :function! Foo() | |
8240 : try | |
8241 : try | |
8242 : try | |
8243 : throw 4711 | |
8244 : finally | |
8245 : call Caught() | |
8246 : endtry | |
8247 : catch /.*/ | |
8248 : call Caught() | |
8249 : throw "oops" | |
8250 : endtry | |
8251 : catch /.*/ | |
8252 : call Caught() | |
8253 : finally | |
8254 : call Caught() | |
8255 : endtry | |
8256 :endfunction | |
8257 : | |
8258 :call Foo() | |
8259 | |
8260 This displays > | |
8261 | |
8262 Nothing caught | |
8263 Caught "4711" in function Foo, line 4 | |
8264 Caught "oops" in function Foo, line 10 | |
8265 Nothing caught | |
8266 | |
8267 A practical example: The following command ":LineNumber" displays the line | |
8268 number in the script or function where it has been used: > | |
8269 | |
8270 :function! LineNumber() | |
8271 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
8272 :endfunction | |
8273 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
8274 < | |
8275 *try-nested* | |
8276 An exception that is not caught by a try conditional can be caught by | |
8277 a surrounding try conditional: > | |
8278 | |
8279 :try | |
8280 : try | |
8281 : throw "foo" | |
8282 : catch /foobar/ | |
8283 : echo "foobar" | |
8284 : finally | |
8285 : echo "inner finally" | |
8286 : endtry | |
8287 :catch /foo/ | |
8288 : echo "foo" | |
8289 :endtry | |
8290 | |
8291 The inner try conditional does not catch the exception, just its finally | |
8292 clause is executed. The exception is then caught by the outer try | |
8293 conditional. The example displays "inner finally" and then "foo". | |
8294 | |
8295 *throw-from-catch* | |
8296 You can catch an exception and throw a new one to be caught elsewhere from the | |
8297 catch clause: > | |
8298 | |
8299 :function! Foo() | |
8300 : throw "foo" | |
8301 :endfunction | |
8302 : | |
8303 :function! Bar() | |
8304 : try | |
8305 : call Foo() | |
8306 : catch /foo/ | |
8307 : echo "Caught foo, throw bar" | |
8308 : throw "bar" | |
8309 : endtry | |
8310 :endfunction | |
8311 : | |
8312 :try | |
8313 : call Bar() | |
8314 :catch /.*/ | |
8315 : echo "Caught" v:exception | |
8316 :endtry | |
8317 | |
8318 This displays "Caught foo, throw bar" and then "Caught bar". | |
8319 | |
8320 *rethrow* | |
8321 There is no real rethrow in the Vim script language, but you may throw | |
8322 "v:exception" instead: > | |
8323 | |
8324 :function! Bar() | |
8325 : try | |
8326 : call Foo() | |
8327 : catch /.*/ | |
8328 : echo "Rethrow" v:exception | |
8329 : throw v:exception | |
8330 : endtry | |
8331 :endfunction | |
8332 < *try-echoerr* | |
8333 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
8334 exceptions, because it is not possible to fake Vim internal exceptions. | |
8335 Trying so causes an error exception. You should throw your own exception | |
8336 denoting the situation. If you want to cause a Vim error exception containing | |
8337 the original error exception value, you can use the |:echoerr| command: > | |
8338 | |
8339 :try | |
8340 : try | |
8341 : asdf | |
8342 : catch /.*/ | |
8343 : echoerr v:exception | |
8344 : endtry | |
8345 :catch /.*/ | |
8346 : echo v:exception | |
8347 :endtry | |
8348 | |
8349 This code displays | |
8350 | |
1621 | 8351 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 8352 |
8353 | |
8354 CLEANUP CODE *try-finally* | |
8355 | |
8356 Scripts often change global settings and restore them at their end. If the | |
8357 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 8358 an inconsistent state. The same may happen to you in the development phase of |
7 | 8359 a script when an error occurs or you explicitly throw an exception without |
8360 catching it. You can solve these problems by using a try conditional with | |
8361 a finally clause for restoring the settings. Its execution is guaranteed on | |
8362 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
8363 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 8364 to exceptions. When not caught, they terminate the script after the finally |
7 | 8365 clause has been executed.) |
8366 Example: > | |
8367 | |
8368 :try | |
8369 : let s:saved_ts = &ts | |
8370 : set ts=17 | |
8371 : | |
8372 : " Do the hard work here. | |
8373 : | |
8374 :finally | |
8375 : let &ts = s:saved_ts | |
8376 : unlet s:saved_ts | |
8377 :endtry | |
8378 | |
8379 This method should be used locally whenever a function or part of a script | |
8380 changes global settings which need to be restored on failure or normal exit of | |
8381 that function or script part. | |
8382 | |
8383 *break-finally* | |
8384 Cleanup code works also when the try block or a catch clause is left by | |
8385 a ":continue", ":break", ":return", or ":finish". | |
8386 Example: > | |
8387 | |
8388 :let first = 1 | |
8389 :while 1 | |
8390 : try | |
8391 : if first | |
8392 : echo "first" | |
8393 : let first = 0 | |
8394 : continue | |
8395 : else | |
8396 : throw "second" | |
8397 : endif | |
8398 : catch /.*/ | |
8399 : echo v:exception | |
8400 : break | |
8401 : finally | |
8402 : echo "cleanup" | |
8403 : endtry | |
8404 : echo "still in while" | |
8405 :endwhile | |
8406 :echo "end" | |
8407 | |
8408 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
8409 | |
8410 :function! Foo() | |
8411 : try | |
8412 : return 4711 | |
8413 : finally | |
8414 : echo "cleanup\n" | |
8415 : endtry | |
8416 : echo "Foo still active" | |
8417 :endfunction | |
8418 : | |
8419 :echo Foo() "returned by Foo" | |
8420 | |
8421 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 8422 extra ":return" in the finally clause. (Above all, this would override the |
7 | 8423 return value.) |
8424 | |
8425 *except-from-finally* | |
8426 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
8427 a finally clause is possible, but not recommended since it abandons the | |
8428 cleanup actions for the try conditional. But, of course, interrupt and error | |
8429 exceptions might get raised from a finally clause. | |
8430 Example where an error in the finally clause stops an interrupt from | |
8431 working correctly: > | |
8432 | |
8433 :try | |
8434 : try | |
8435 : echo "Press CTRL-C for interrupt" | |
8436 : while 1 | |
8437 : endwhile | |
8438 : finally | |
8439 : unlet novar | |
8440 : endtry | |
8441 :catch /novar/ | |
8442 :endtry | |
8443 :echo "Script still running" | |
8444 :sleep 1 | |
8445 | |
8446 If you need to put commands that could fail into a finally clause, you should | |
8447 think about catching or ignoring the errors in these commands, see | |
8448 |catch-errors| and |ignore-errors|. | |
8449 | |
8450 | |
8451 CATCHING ERRORS *catch-errors* | |
8452 | |
8453 If you want to catch specific errors, you just have to put the code to be | |
8454 watched in a try block and add a catch clause for the error message. The | |
8455 presence of the try conditional causes all errors to be converted to an | |
8456 exception. No message is displayed and |v:errmsg| is not set then. To find | |
8457 the right pattern for the ":catch" command, you have to know how the format of | |
8458 the error exception is. | |
8459 Error exceptions have the following format: > | |
8460 | |
8461 Vim({cmdname}):{errmsg} | |
8462 or > | |
8463 Vim:{errmsg} | |
8464 | |
8465 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 8466 the command name is not known. {errmsg} is the error message usually produced |
7 | 8467 when the error occurs outside try conditionals. It always begins with |
8468 a capital "E", followed by a two or three-digit error number, a colon, and | |
8469 a space. | |
8470 | |
8471 Examples: | |
8472 | |
8473 The command > | |
8474 :unlet novar | |
8475 normally produces the error message > | |
8476 E108: No such variable: "novar" | |
8477 which is converted inside try conditionals to an exception > | |
8478 Vim(unlet):E108: No such variable: "novar" | |
8479 | |
8480 The command > | |
8481 :dwim | |
8482 normally produces the error message > | |
8483 E492: Not an editor command: dwim | |
8484 which is converted inside try conditionals to an exception > | |
8485 Vim:E492: Not an editor command: dwim | |
8486 | |
8487 You can catch all ":unlet" errors by a > | |
8488 :catch /^Vim(unlet):/ | |
8489 or all errors for misspelled command names by a > | |
8490 :catch /^Vim:E492:/ | |
8491 | |
8492 Some error messages may be produced by different commands: > | |
8493 :function nofunc | |
8494 and > | |
8495 :delfunction nofunc | |
8496 both produce the error message > | |
8497 E128: Function name must start with a capital: nofunc | |
8498 which is converted inside try conditionals to an exception > | |
8499 Vim(function):E128: Function name must start with a capital: nofunc | |
8500 or > | |
8501 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
8502 respectively. You can catch the error by its number independently on the | |
8503 command that caused it if you use the following pattern: > | |
8504 :catch /^Vim(\a\+):E128:/ | |
8505 | |
8506 Some commands like > | |
8507 :let x = novar | |
8508 produce multiple error messages, here: > | |
8509 E121: Undefined variable: novar | |
8510 E15: Invalid expression: novar | |
8511 Only the first is used for the exception value, since it is the most specific | |
8512 one (see |except-several-errors|). So you can catch it by > | |
8513 :catch /^Vim(\a\+):E121:/ | |
8514 | |
8515 You can catch all errors related to the name "nofunc" by > | |
8516 :catch /\<nofunc\>/ | |
8517 | |
8518 You can catch all Vim errors in the ":write" and ":read" commands by > | |
8519 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
8520 | |
8521 You can catch all Vim errors by the pattern > | |
8522 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
8523 < | |
8524 *catch-text* | |
8525 NOTE: You should never catch the error message text itself: > | |
8526 :catch /No such variable/ | |
6647 | 8527 only works in the English locale, but not when the user has selected |
7 | 8528 a different language by the |:language| command. It is however helpful to |
8529 cite the message text in a comment: > | |
8530 :catch /^Vim(\a\+):E108:/ " No such variable | |
8531 | |
8532 | |
8533 IGNORING ERRORS *ignore-errors* | |
8534 | |
8535 You can ignore errors in a specific Vim command by catching them locally: > | |
8536 | |
8537 :try | |
8538 : write | |
8539 :catch | |
8540 :endtry | |
8541 | |
8542 But you are strongly recommended NOT to use this simple form, since it could | |
8543 catch more than you want. With the ":write" command, some autocommands could | |
8544 be executed and cause errors not related to writing, for instance: > | |
8545 | |
8546 :au BufWritePre * unlet novar | |
8547 | |
8548 There could even be such errors you are not responsible for as a script | |
8549 writer: a user of your script might have defined such autocommands. You would | |
8550 then hide the error from the user. | |
8551 It is much better to use > | |
8552 | |
8553 :try | |
8554 : write | |
8555 :catch /^Vim(write):/ | |
8556 :endtry | |
8557 | |
8558 which only catches real write errors. So catch only what you'd like to ignore | |
8559 intentionally. | |
8560 | |
8561 For a single command that does not cause execution of autocommands, you could | |
8562 even suppress the conversion of errors to exceptions by the ":silent!" | |
8563 command: > | |
8564 :silent! nunmap k | |
8565 This works also when a try conditional is active. | |
8566 | |
8567 | |
8568 CATCHING INTERRUPTS *catch-interrupt* | |
8569 | |
8570 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 8571 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 8572 script is not terminated, then. |
8573 Example: > | |
8574 | |
8575 :function! TASK1() | |
8576 : sleep 10 | |
8577 :endfunction | |
8578 | |
8579 :function! TASK2() | |
8580 : sleep 20 | |
8581 :endfunction | |
8582 | |
8583 :while 1 | |
8584 : let command = input("Type a command: ") | |
8585 : try | |
8586 : if command == "" | |
8587 : continue | |
8588 : elseif command == "END" | |
8589 : break | |
8590 : elseif command == "TASK1" | |
8591 : call TASK1() | |
8592 : elseif command == "TASK2" | |
8593 : call TASK2() | |
8594 : else | |
8595 : echo "\nIllegal command:" command | |
8596 : continue | |
8597 : endif | |
8598 : catch /^Vim:Interrupt$/ | |
8599 : echo "\nCommand interrupted" | |
8600 : " Caught the interrupt. Continue with next prompt. | |
8601 : endtry | |
8602 :endwhile | |
8603 | |
8604 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 8605 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 8606 |
8607 For testing what happens when CTRL-C would be pressed on a specific line in | |
8608 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
8609 command on that line. See |debug-scripts|. | |
8610 | |
8611 | |
8612 CATCHING ALL *catch-all* | |
8613 | |
8614 The commands > | |
8615 | |
8616 :catch /.*/ | |
8617 :catch // | |
8618 :catch | |
8619 | |
8620 catch everything, error exceptions, interrupt exceptions and exceptions | |
8621 explicitly thrown by the |:throw| command. This is useful at the top level of | |
8622 a script in order to catch unexpected things. | |
8623 Example: > | |
8624 | |
8625 :try | |
8626 : | |
8627 : " do the hard work here | |
8628 : | |
8629 :catch /MyException/ | |
8630 : | |
8631 : " handle known problem | |
8632 : | |
8633 :catch /^Vim:Interrupt$/ | |
8634 : echo "Script interrupted" | |
8635 :catch /.*/ | |
8636 : echo "Internal error (" . v:exception . ")" | |
8637 : echo " - occurred at " . v:throwpoint | |
8638 :endtry | |
8639 :" end of script | |
8640 | |
8641 Note: Catching all might catch more things than you want. Thus, you are | |
8642 strongly encouraged to catch only for problems that you can really handle by | |
8643 specifying a pattern argument to the ":catch". | |
8644 Example: Catching all could make it nearly impossible to interrupt a script | |
8645 by pressing CTRL-C: > | |
8646 | |
8647 :while 1 | |
8648 : try | |
8649 : sleep 1 | |
8650 : catch | |
8651 : endtry | |
8652 :endwhile | |
8653 | |
8654 | |
8655 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
8656 | |
8657 Exceptions may be used during execution of autocommands. Example: > | |
8658 | |
8659 :autocmd User x try | |
8660 :autocmd User x throw "Oops!" | |
8661 :autocmd User x catch | |
8662 :autocmd User x echo v:exception | |
8663 :autocmd User x endtry | |
8664 :autocmd User x throw "Arrgh!" | |
8665 :autocmd User x echo "Should not be displayed" | |
8666 : | |
8667 :try | |
8668 : doautocmd User x | |
8669 :catch | |
8670 : echo v:exception | |
8671 :endtry | |
8672 | |
8673 This displays "Oops!" and "Arrgh!". | |
8674 | |
8675 *except-autocmd-Pre* | |
8676 For some commands, autocommands get executed before the main action of the | |
8677 command takes place. If an exception is thrown and not caught in the sequence | |
8678 of autocommands, the sequence and the command that caused its execution are | |
8679 abandoned and the exception is propagated to the caller of the command. | |
8680 Example: > | |
8681 | |
8682 :autocmd BufWritePre * throw "FAIL" | |
8683 :autocmd BufWritePre * echo "Should not be displayed" | |
8684 : | |
8685 :try | |
8686 : write | |
8687 :catch | |
8688 : echo "Caught:" v:exception "from" v:throwpoint | |
8689 :endtry | |
8690 | |
8691 Here, the ":write" command does not write the file currently being edited (as | |
8692 you can see by checking 'modified'), since the exception from the BufWritePre | |
8693 autocommand abandons the ":write". The exception is then caught and the | |
8694 script displays: > | |
8695 | |
8696 Caught: FAIL from BufWrite Auto commands for "*" | |
8697 < | |
8698 *except-autocmd-Post* | |
8699 For some commands, autocommands get executed after the main action of the | |
8700 command has taken place. If this main action fails and the command is inside | |
8701 an active try conditional, the autocommands are skipped and an error exception | |
8702 is thrown that can be caught by the caller of the command. | |
8703 Example: > | |
8704 | |
8705 :autocmd BufWritePost * echo "File successfully written!" | |
8706 : | |
8707 :try | |
8708 : write /i/m/p/o/s/s/i/b/l/e | |
8709 :catch | |
8710 : echo v:exception | |
8711 :endtry | |
8712 | |
8713 This just displays: > | |
8714 | |
8715 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
8716 | |
8717 If you really need to execute the autocommands even when the main action | |
8718 fails, trigger the event from the catch clause. | |
8719 Example: > | |
8720 | |
8721 :autocmd BufWritePre * set noreadonly | |
8722 :autocmd BufWritePost * set readonly | |
8723 : | |
8724 :try | |
8725 : write /i/m/p/o/s/s/i/b/l/e | |
8726 :catch | |
8727 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
8728 :endtry | |
8729 < | |
8730 You can also use ":silent!": > | |
8731 | |
8732 :let x = "ok" | |
8733 :let v:errmsg = "" | |
8734 :autocmd BufWritePost * if v:errmsg != "" | |
8735 :autocmd BufWritePost * let x = "after fail" | |
8736 :autocmd BufWritePost * endif | |
8737 :try | |
8738 : silent! write /i/m/p/o/s/s/i/b/l/e | |
8739 :catch | |
8740 :endtry | |
8741 :echo x | |
8742 | |
8743 This displays "after fail". | |
8744 | |
8745 If the main action of the command does not fail, exceptions from the | |
8746 autocommands will be catchable by the caller of the command: > | |
8747 | |
8748 :autocmd BufWritePost * throw ":-(" | |
8749 :autocmd BufWritePost * echo "Should not be displayed" | |
8750 : | |
8751 :try | |
8752 : write | |
8753 :catch | |
8754 : echo v:exception | |
8755 :endtry | |
8756 < | |
8757 *except-autocmd-Cmd* | |
8758 For some commands, the normal action can be replaced by a sequence of | |
8759 autocommands. Exceptions from that sequence will be catchable by the caller | |
8760 of the command. | |
8761 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 8762 had actually been written when the exception occurred. You need to tell it in |
7 | 8763 some way. > |
8764 | |
8765 :if !exists("cnt") | |
8766 : let cnt = 0 | |
8767 : | |
8768 : autocmd BufWriteCmd * if &modified | |
8769 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
8770 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
8771 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8772 : autocmd BufWriteCmd * endif | |
8773 : autocmd BufWriteCmd * write | set nomodified | |
8774 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
8775 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
8776 : autocmd BufWriteCmd * endif | |
8777 : autocmd BufWriteCmd * echo "File successfully written!" | |
8778 : autocmd BufWriteCmd * endif | |
8779 :endif | |
8780 : | |
8781 :try | |
8782 : write | |
8783 :catch /^BufWriteCmdError$/ | |
8784 : if &modified | |
8785 : echo "Error on writing (file contents not changed)" | |
8786 : else | |
8787 : echo "Error after writing" | |
8788 : endif | |
8789 :catch /^Vim(write):/ | |
8790 : echo "Error on writing" | |
8791 :endtry | |
8792 | |
8793 When this script is sourced several times after making changes, it displays | |
8794 first > | |
8795 File successfully written! | |
8796 then > | |
8797 Error on writing (file contents not changed) | |
8798 then > | |
8799 Error after writing | |
8800 etc. | |
8801 | |
8802 *except-autocmd-ill* | |
8803 You cannot spread a try conditional over autocommands for different events. | |
8804 The following code is ill-formed: > | |
8805 | |
8806 :autocmd BufWritePre * try | |
8807 : | |
8808 :autocmd BufWritePost * catch | |
8809 :autocmd BufWritePost * echo v:exception | |
8810 :autocmd BufWritePost * endtry | |
8811 : | |
8812 :write | |
8813 | |
8814 | |
8815 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
8816 | |
8817 Some programming languages allow to use hierarchies of exception classes or to | |
8818 pass additional information with the object of an exception class. You can do | |
8819 similar things in Vim. | |
8820 In order to throw an exception from a hierarchy, just throw the complete | |
8821 class name with the components separated by a colon, for instance throw the | |
8822 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
8823 When you want to pass additional information with your exception class, add | |
8824 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
8825 for an error when writing "myfile". | |
8826 With the appropriate patterns in the ":catch" command, you can catch for | |
8827 base classes or derived classes of your hierarchy. Additional information in | |
8828 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
8829 Example: > | |
8830 | |
8831 :function! CheckRange(a, func) | |
8832 : if a:a < 0 | |
8833 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
8834 : endif | |
8835 :endfunction | |
8836 : | |
8837 :function! Add(a, b) | |
8838 : call CheckRange(a:a, "Add") | |
8839 : call CheckRange(a:b, "Add") | |
8840 : let c = a:a + a:b | |
8841 : if c < 0 | |
8842 : throw "EXCEPT:MATHERR:OVERFLOW" | |
8843 : endif | |
8844 : return c | |
8845 :endfunction | |
8846 : | |
8847 :function! Div(a, b) | |
8848 : call CheckRange(a:a, "Div") | |
8849 : call CheckRange(a:b, "Div") | |
8850 : if (a:b == 0) | |
8851 : throw "EXCEPT:MATHERR:ZERODIV" | |
8852 : endif | |
8853 : return a:a / a:b | |
8854 :endfunction | |
8855 : | |
8856 :function! Write(file) | |
8857 : try | |
1621 | 8858 : execute "write" fnameescape(a:file) |
7 | 8859 : catch /^Vim(write):/ |
8860 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
8861 : endtry | |
8862 :endfunction | |
8863 : | |
8864 :try | |
8865 : | |
8866 : " something with arithmetics and I/O | |
8867 : | |
8868 :catch /^EXCEPT:MATHERR:RANGE/ | |
8869 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
8870 : echo "Range error in" function | |
8871 : | |
8872 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
8873 : echo "Math error" | |
8874 : | |
8875 :catch /^EXCEPT:IO/ | |
8876 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
8877 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
8878 : if file !~ '^/' | |
8879 : let file = dir . "/" . file | |
8880 : endif | |
8881 : echo 'I/O error for "' . file . '"' | |
8882 : | |
8883 :catch /^EXCEPT/ | |
8884 : echo "Unspecified error" | |
8885 : | |
8886 :endtry | |
8887 | |
8888 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
8889 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
8890 exceptions with the "Vim" prefix; they are reserved for Vim. | |
8891 Vim error exceptions are parameterized with the name of the command that | |
8892 failed, if known. See |catch-errors|. | |
8893 | |
8894 | |
8895 PECULIARITIES | |
8896 *except-compat* | |
8897 The exception handling concept requires that the command sequence causing the | |
8898 exception is aborted immediately and control is transferred to finally clauses | |
8899 and/or a catch clause. | |
8900 | |
8901 In the Vim script language there are cases where scripts and functions | |
8902 continue after an error: in functions without the "abort" flag or in a command | |
8903 after ":silent!", control flow goes to the following line, and outside | |
8904 functions, control flow goes to the line following the outermost ":endwhile" | |
8905 or ":endif". On the other hand, errors should be catchable as exceptions | |
8906 (thus, requiring the immediate abortion). | |
8907 | |
8908 This problem has been solved by converting errors to exceptions and using | |
8909 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 8910 conditional is active. This is no restriction since an (error) exception can |
8911 be caught only from an active try conditional. If you want an immediate | |
7 | 8912 termination without catching the error, just use a try conditional without |
8913 catch clause. (You can cause cleanup code being executed before termination | |
8914 by specifying a finally clause.) | |
8915 | |
8916 When no try conditional is active, the usual abortion and continuation | |
8917 behavior is used instead of immediate abortion. This ensures compatibility of | |
8918 scripts written for Vim 6.1 and earlier. | |
8919 | |
8920 However, when sourcing an existing script that does not use exception handling | |
8921 commands (or when calling one of its functions) from inside an active try | |
8922 conditional of a new script, you might change the control flow of the existing | |
8923 script on error. You get the immediate abortion on error and can catch the | |
8924 error in the new script. If however the sourced script suppresses error | |
8925 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 8926 |v:errmsg| if appropriate), its execution path is not changed. The error is |
8927 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 8928 where this happens is for scripts that don't care about errors and produce |
8929 error messages. You probably won't want to use such code from your new | |
8930 scripts. | |
8931 | |
8932 *except-syntax-err* | |
8933 Syntax errors in the exception handling commands are never caught by any of | |
8934 the ":catch" commands of the try conditional they belong to. Its finally | |
8935 clauses, however, is executed. | |
8936 Example: > | |
8937 | |
8938 :try | |
8939 : try | |
8940 : throw 4711 | |
8941 : catch /\(/ | |
8942 : echo "in catch with syntax error" | |
8943 : catch | |
8944 : echo "inner catch-all" | |
8945 : finally | |
8946 : echo "inner finally" | |
8947 : endtry | |
8948 :catch | |
8949 : echo 'outer catch-all caught "' . v:exception . '"' | |
8950 : finally | |
8951 : echo "outer finally" | |
8952 :endtry | |
8953 | |
8954 This displays: > | |
8955 inner finally | |
8956 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
8957 outer finally | |
8958 The original exception is discarded and an error exception is raised, instead. | |
8959 | |
8960 *except-single-line* | |
8961 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
8962 a single line, but then syntax errors may make it difficult to recognize the | |
8963 "catch" line, thus you better avoid this. | |
8964 Example: > | |
8965 :try | unlet! foo # | catch | endtry | |
8966 raises an error exception for the trailing characters after the ":unlet!" | |
8967 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
8968 error exception is discarded and the "E488: Trailing characters" message gets | |
8969 displayed. | |
8970 | |
8971 *except-several-errors* | |
8972 When several errors appear in a single command, the first error message is | |
8973 usually the most specific one and therefor converted to the error exception. | |
8974 Example: > | |
8975 echo novar | |
8976 causes > | |
8977 E121: Undefined variable: novar | |
8978 E15: Invalid expression: novar | |
8979 The value of the error exception inside try conditionals is: > | |
8980 Vim(echo):E121: Undefined variable: novar | |
8981 < *except-syntax-error* | |
8982 But when a syntax error is detected after a normal error in the same command, | |
8983 the syntax error is used for the exception being thrown. | |
8984 Example: > | |
8985 unlet novar # | |
8986 causes > | |
8987 E108: No such variable: "novar" | |
8988 E488: Trailing characters | |
8989 The value of the error exception inside try conditionals is: > | |
8990 Vim(unlet):E488: Trailing characters | |
8991 This is done because the syntax error might change the execution path in a way | |
8992 not intended by the user. Example: > | |
8993 try | |
8994 try | unlet novar # | catch | echo v:exception | endtry | |
8995 catch /.*/ | |
8996 echo "outer catch:" v:exception | |
8997 endtry | |
8998 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
8999 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
9000 | |
9001 ============================================================================== | |
9002 9. Examples *eval-examples* | |
9003 | |
1156 | 9004 Printing in Binary ~ |
7 | 9005 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9006 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 9007 :func Nr2Bin(nr) |
7 | 9008 : let n = a:nr |
9009 : let r = "" | |
9010 : while n | |
1156 | 9011 : let r = '01'[n % 2] . r |
9012 : let n = n / 2 | |
7 | 9013 : endwhile |
9014 : return r | |
9015 :endfunc | |
9016 | |
1156 | 9017 :" The function String2Bin() converts each character in a string to a |
9018 :" binary string, separated with dashes. | |
9019 :func String2Bin(str) | |
7 | 9020 : let out = '' |
1156 | 9021 : for ix in range(strlen(a:str)) |
9022 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
9023 : endfor | |
9024 : return out[1:] | |
7 | 9025 :endfunc |
9026 | |
9027 Example of its use: > | |
1156 | 9028 :echo Nr2Bin(32) |
9029 result: "100000" > | |
9030 :echo String2Bin("32") | |
9031 result: "110011-110010" | |
9032 | |
9033 | |
9034 Sorting lines ~ | |
9035 | |
9036 This example sorts lines with a specific compare function. > | |
9037 | |
9038 :func SortBuffer() | |
9039 : let lines = getline(1, '$') | |
9040 : call sort(lines, function("Strcmp")) | |
9041 : call setline(1, lines) | |
7 | 9042 :endfunction |
9043 | |
1156 | 9044 As a one-liner: > |
9045 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
9046 | |
9047 | |
9048 scanf() replacement ~ | |
7 | 9049 *sscanf* |
9050 There is no sscanf() function in Vim. If you need to extract parts from a | |
9051 line, you can use matchstr() and substitute() to do it. This example shows | |
9052 how to get the file name, line number and column number out of a line like | |
9053 "foobar.txt, 123, 45". > | |
9054 :" Set up the match bit | |
9055 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
9056 :"get the part matching the whole expression | |
9057 :let l = matchstr(line, mx) | |
9058 :"get each item out of the match | |
9059 :let file = substitute(l, mx, '\1', '') | |
9060 :let lnum = substitute(l, mx, '\2', '') | |
9061 :let col = substitute(l, mx, '\3', '') | |
9062 | |
9063 The input is in the variable "line", the results in the variables "file", | |
9064 "lnum" and "col". (idea from Michael Geddes) | |
9065 | |
1156 | 9066 |
9067 getting the scriptnames in a Dictionary ~ | |
9068 *scriptnames-dictionary* | |
9069 The |:scriptnames| command can be used to get a list of all script files that | |
9070 have been sourced. There is no equivalent function or variable for this | |
9071 (because it's rarely needed). In case you need to manipulate the list this | |
9072 code can be used: > | |
9073 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
9074 let scriptnames_output = '' | |
9075 redir => scriptnames_output | |
9076 silent scriptnames | |
9077 redir END | |
9078 | |
1621 | 9079 " Split the output into lines and parse each line. Add an entry to the |
1156 | 9080 " "scripts" dictionary. |
9081 let scripts = {} | |
9082 for line in split(scriptnames_output, "\n") | |
9083 " Only do non-blank lines. | |
9084 if line =~ '\S' | |
9085 " Get the first number in the line. | |
1621 | 9086 let nr = matchstr(line, '\d\+') |
1156 | 9087 " Get the file name, remove the script number " 123: ". |
1621 | 9088 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 9089 " Add an item to the Dictionary |
1621 | 9090 let scripts[nr] = name |
1156 | 9091 endif |
9092 endfor | |
9093 unlet scriptnames_output | |
9094 | |
7 | 9095 ============================================================================== |
9096 10. No +eval feature *no-eval-feature* | |
9097 | |
9098 When the |+eval| feature was disabled at compile time, none of the expression | |
9099 evaluation commands are available. To prevent this from causing Vim scripts | |
9100 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
9101 recognized, though the argument of the ":if" and everything between the ":if" | |
9102 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
9103 only if the commands are at the start of the line. The ":else" command is not | |
9104 recognized. | |
9105 | |
9106 Example of how to avoid executing commands when the |+eval| feature is | |
9107 missing: > | |
9108 | |
9109 :if 1 | |
9110 : echo "Expression evaluation is compiled in" | |
9111 :else | |
9112 : echo "You will _never_ see this message" | |
9113 :endif | |
9114 | |
9115 ============================================================================== | |
9116 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
9117 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9118 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
|
9119 '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
|
9120 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
|
9121 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
|
9122 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 9123 The sandbox is also used for the |:sandbox| command. |
7 | 9124 |
9125 These items are not allowed in the sandbox: | |
9126 - changing the buffer text | |
9127 - defining or changing mapping, autocommands, functions, user commands | |
9128 - setting certain options (see |option-summary|) | |
1156 | 9129 - setting certain v: variables (see |v:var|) *E794* |
7 | 9130 - executing a shell command |
9131 - reading or writing a file | |
9132 - jumping to another buffer or editing a file | |
625 | 9133 - executing Python, Perl, etc. commands |
29 | 9134 This is not guaranteed 100% secure, but it should block most attacks. |
9135 | |
9136 *:san* *:sandbox* | |
401 | 9137 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 9138 option that may have been set from a modeline, e.g. |
9139 'foldexpr'. | |
9140 | |
634 | 9141 *sandbox-option* |
9142 A few options contain an expression. When this expression is evaluated it may | |
790 | 9143 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 9144 restrictive, thus this only happens when the option was set from an insecure |
9145 location. Insecure in this context are: | |
843 | 9146 - sourcing a .vimrc or .exrc in the current directory |
634 | 9147 - while executing in the sandbox |
9148 - value coming from a modeline | |
9149 | |
9150 Note that when in the sandbox and saving an option value and restoring it, the | |
9151 option will still be marked as it was set in the sandbox. | |
9152 | |
9153 ============================================================================== | |
9154 12. Textlock *textlock* | |
9155 | |
9156 In a few situations it is not allowed to change the text in the buffer, jump | |
9157 to another window and some other things that might confuse or break what Vim | |
9158 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 9159 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 9160 happen any moment the mouse cursor is resting at some position. |
9161 | |
9162 This is not allowed when the textlock is active: | |
9163 - changing the buffer text | |
9164 - jumping to another buffer or window | |
9165 - editing another file | |
9166 - closing a window or quitting Vim | |
9167 - etc. | |
9168 | |
7 | 9169 |
9170 vim:tw=78:ts=8:ft=help:norl: |