Mercurial > vim
annotate runtime/doc/eval.txt @ 8669:06848fe9c816 v7.4.1624
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Mar 20 20:57:45 2016 +0100
patch 7.4.1624
Problem: Can't get info about a channel.
Solution: Add ch_info().
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 20 Mar 2016 21:00:05 +0100 |
parents | 63dc856bd13d |
children | e770986c855a |
rev | line source |
---|---|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Mar 20 |
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* |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
40 There are nine types of variables: |
1621 | 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 List An ordered sequence of items |List|. | |
53 Example: [1, 2, ['a', 'b']] | |
55 | 54 |
370 | 55 Dictionary An associative, unordered array: Each entry has a key and a |
56 value. |Dictionary| | |
57 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
58 | |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
59 Funcref A reference to a function |Funcref|. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
60 Example: function("strlen") |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
61 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
62 Special |v:false|, |v:true|, |v:none| and |v:null|. *Special* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
63 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
64 Job Used for a job, see |job_start()|. *Job* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
65 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
66 Channel Used for a channel, see |ch_open()|. *Channel* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
67 |
55 | 68 The Number and String types are converted automatically, depending on how they |
69 are used. | |
7 | 70 |
71 Conversion from a Number to a String is by making the ASCII representation of | |
2581 | 72 the Number. Examples: |
73 Number 123 --> String "123" ~ | |
74 Number 0 --> String "0" ~ | |
75 Number -1 --> String "-1" ~ | |
2152 | 76 *octal* |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
77 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
|
78 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
|
79 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
|
80 Examples: |
2581 | 81 String "456" --> Number 456 ~ |
82 String "6bar" --> Number 6 ~ | |
83 String "foo" --> Number 0 ~ | |
84 String "0xf1" --> Number 241 ~ | |
85 String "0100" --> Number 64 ~ | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
86 String "0b101" --> Number 5 ~ |
2581 | 87 String "-8" --> Number -8 ~ |
88 String "+8" --> Number 0 ~ | |
7 | 89 |
90 To force conversion from String to Number, add zero to it: > | |
91 :echo "0100" + 0 | |
782 | 92 < 64 ~ |
93 | |
94 To avoid a leading zero to cause octal conversion, or for using a different | |
95 base, use |str2nr()|. | |
7 | 96 |
97 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
98 | |
99 Note that in the command > | |
100 :if "foo" | |
101 "foo" is converted to 0, which means FALSE. To test for a non-empty string, | |
3893 | 102 use empty(): > |
103 :if !empty("foo") | |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
104 < |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
105 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
106 List, Dictionary, Funcref and Job types are not automatically converted. |
85 | 107 |
1621 | 108 *E805* *E806* *E808* |
109 When mixing Number and Float the Number is converted to Float. Otherwise | |
110 there is no automatic conversion of Float. You can use str2float() for String | |
111 to Float, printf() for Float to String and float2nr() for Float to Number. | |
112 | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
113 *E891* *E892* *E893* *E894* *E907* *E911* *E914* |
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
114 When expecting a Float a Number can also be used, but nothing else. |
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
115 |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
116 *no-type-checking* |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
117 You will not get an error if you try to change the type of a variable. |
85 | 118 |
119 | |
87 | 120 1.2 Function references ~ |
153 | 121 *Funcref* *E695* *E718* |
1621 | 122 A Funcref variable is obtained with the |function()| function. It can be used |
114 | 123 in an expression in the place of a function name, before the parenthesis |
124 around the arguments, to invoke the function it refers to. Example: > | |
55 | 125 |
126 :let Fn = function("MyFunc") | |
127 :echo Fn() | |
114 | 128 < *E704* *E705* *E707* |
819 | 129 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
5340 | 130 can use "g:" but the following name must still start with a capital. You |
819 | 131 cannot have both a Funcref variable and a function with the same name. |
85 | 132 |
114 | 133 A special case is defining a function and directly assigning its Funcref to a |
134 Dictionary entry. Example: > | |
135 :function dict.init() dict | |
136 : let self.val = 0 | |
137 :endfunction | |
138 | |
139 The key of the Dictionary can start with a lower case letter. The actual | |
140 function name is not used here. Also see |numbered-function|. | |
141 | |
142 A Funcref can also be used with the |:call| command: > | |
143 :call Fn() | |
144 :call dict.init() | |
85 | 145 |
146 The name of the referenced function can be obtained with |string()|. > | |
119 | 147 :let func = string(Fn) |
85 | 148 |
149 You can use |call()| to invoke a Funcref and use a list variable for the | |
150 arguments: > | |
119 | 151 :let r = call(Fn, mylist) |
85 | 152 |
153 | |
87 | 154 1.3 Lists ~ |
5814 | 155 *list* *List* *Lists* *E686* |
55 | 156 A List is an ordered sequence of items. An item can be of any type. Items |
1621 | 157 can be accessed by their index number. Items can be added and removed at any |
55 | 158 position in the sequence. |
159 | |
85 | 160 |
161 List creation ~ | |
162 *E696* *E697* | |
55 | 163 A List is created with a comma separated list of items in square brackets. |
85 | 164 Examples: > |
165 :let mylist = [1, two, 3, "four"] | |
166 :let emptylist = [] | |
55 | 167 |
1621 | 168 An item can be any expression. Using a List for an item creates a |
842 | 169 List of Lists: > |
85 | 170 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 171 |
172 An extra comma after the last item is ignored. | |
173 | |
85 | 174 |
175 List index ~ | |
176 *list-index* *E684* | |
55 | 177 An item in the List can be accessed by putting the index in square brackets |
85 | 178 after the List. Indexes are zero-based, thus the first item has index zero. > |
179 :let item = mylist[0] " get the first item: 1 | |
55 | 180 :let item = mylist[2] " get the third item: 3 |
85 | 181 |
87 | 182 When the resulting item is a list this can be repeated: > |
85 | 183 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 184 < |
85 | 185 A negative index is counted from the end. Index -1 refers to the last item in |
186 the List, -2 to the last but one item, etc. > | |
55 | 187 :let last = mylist[-1] " get the last item: "four" |
188 | |
85 | 189 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 190 is not available it returns zero or the default value you specify: > |
85 | 191 :echo get(mylist, idx) |
192 :echo get(mylist, idx, "NONE") | |
193 | |
194 | |
195 List concatenation ~ | |
196 | |
197 Two lists can be concatenated with the "+" operator: > | |
198 :let longlist = mylist + [5, 6] | |
119 | 199 :let mylist += [7, 8] |
85 | 200 |
201 To prepend or append an item turn the item into a list by putting [] around | |
202 it. To change a list in-place see |list-modification| below. | |
203 | |
204 | |
205 Sublist ~ | |
206 | |
55 | 207 A part of the List can be obtained by specifying the first and last index, |
208 separated by a colon in square brackets: > | |
85 | 209 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 210 |
211 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 212 similar to -1. > |
90 | 213 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
214 :let shortlist = mylist[2:2] " List with one item: [3] | |
215 :let otherlist = mylist[:] " make a copy of the List | |
85 | 216 |
842 | 217 If the first index is beyond the last item of the List or the second item is |
218 before the first item, the result is an empty list. There is no error | |
219 message. | |
220 | |
221 If the second index is equal to or greater than the length of the list the | |
222 length minus one is used: > | |
829 | 223 :let mylist = [0, 1, 2, 3] |
224 :echo mylist[2:8] " result: [2, 3] | |
225 | |
270 | 226 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
1621 | 227 using a single letter variable before the ":". Insert a space when needed: |
270 | 228 mylist[s : e]. |
229 | |
85 | 230 |
231 List identity ~ | |
99 | 232 *list-identity* |
85 | 233 When variable "aa" is a list and you assign it to another variable "bb", both |
234 variables refer to the same list. Thus changing the list "aa" will also | |
235 change "bb": > | |
236 :let aa = [1, 2, 3] | |
237 :let bb = aa | |
238 :call add(aa, 4) | |
239 :echo bb | |
114 | 240 < [1, 2, 3, 4] |
85 | 241 |
242 Making a copy of a list is done with the |copy()| function. Using [:] also | |
243 works, as explained above. This creates a shallow copy of the list: Changing | |
87 | 244 a list item in the list will also change the item in the copied list: > |
85 | 245 :let aa = [[1, 'a'], 2, 3] |
246 :let bb = copy(aa) | |
114 | 247 :call add(aa, 4) |
85 | 248 :let aa[0][1] = 'aaa' |
249 :echo aa | |
114 | 250 < [[1, aaa], 2, 3, 4] > |
85 | 251 :echo bb |
114 | 252 < [[1, aaa], 2, 3] |
85 | 253 |
87 | 254 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 255 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 256 |
257 The operator "is" can be used to check if two variables refer to the same | |
114 | 258 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 259 the same value. > |
260 :let alist = [1, 2, 3] | |
261 :let blist = [1, 2, 3] | |
262 :echo alist is blist | |
114 | 263 < 0 > |
87 | 264 :echo alist == blist |
114 | 265 < 1 |
85 | 266 |
323 | 267 Note about comparing lists: Two lists are considered equal if they have the |
268 same length and all items compare equal, as with using "==". There is one | |
388 | 269 exception: When comparing a number with a string they are considered |
270 different. There is no automatic type conversion, as with using "==" on | |
271 variables. Example: > | |
272 echo 4 == "4" | |
323 | 273 < 1 > |
388 | 274 echo [4] == ["4"] |
323 | 275 < 0 |
276 | |
388 | 277 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 278 can compare simple values this way too by putting them in a list: > |
388 | 279 |
280 :let a = 5 | |
281 :let b = "5" | |
1621 | 282 :echo a == b |
388 | 283 < 1 > |
1621 | 284 :echo [a] == [b] |
388 | 285 < 0 |
323 | 286 |
85 | 287 |
288 List unpack ~ | |
289 | |
290 To unpack the items in a list to individual variables, put the variables in | |
291 square brackets, like list items: > | |
292 :let [var1, var2] = mylist | |
293 | |
294 When the number of variables does not match the number of items in the list | |
295 this produces an error. To handle any extra items from the list append ";" | |
296 and a variable name: > | |
297 :let [var1, var2; rest] = mylist | |
298 | |
299 This works like: > | |
300 :let var1 = mylist[0] | |
301 :let var2 = mylist[1] | |
95 | 302 :let rest = mylist[2:] |
85 | 303 |
304 Except that there is no error if there are only two items. "rest" will be an | |
305 empty list then. | |
306 | |
307 | |
308 List modification ~ | |
309 *list-modification* | |
87 | 310 To change a specific item of a list use |:let| this way: > |
85 | 311 :let list[4] = "four" |
312 :let listlist[0][3] = item | |
313 | |
87 | 314 To change part of a list you can specify the first and last item to be |
114 | 315 modified. The value must at least have the number of items in the range: > |
87 | 316 :let list[3:5] = [3, 4, 5] |
317 | |
85 | 318 Adding and removing items from a list is done with functions. Here are a few |
319 examples: > | |
320 :call insert(list, 'a') " prepend item 'a' | |
321 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
322 :call add(list, "new") " append String item | |
114 | 323 :call add(list, [1, 2]) " append a List as one new item |
85 | 324 :call extend(list, [1, 2]) " extend the list with two more items |
325 :let i = remove(list, 3) " remove item 3 | |
108 | 326 :unlet list[3] " idem |
85 | 327 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 328 :unlet list[3 : ] " idem |
114 | 329 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
330 | |
331 Changing the order of items in a list: > | |
87 | 332 :call sort(list) " sort a list alphabetically |
333 :call reverse(list) " reverse the order of items | |
5747 | 334 :call uniq(sort(list)) " sort and remove duplicates |
87 | 335 |
85 | 336 |
337 For loop ~ | |
338 | |
87 | 339 The |:for| loop executes commands for each item in a list. A variable is set |
340 to each item in the list in sequence. Example: > | |
114 | 341 :for item in mylist |
342 : call Doit(item) | |
85 | 343 :endfor |
344 | |
345 This works like: > | |
346 :let index = 0 | |
347 :while index < len(mylist) | |
114 | 348 : let item = mylist[index] |
349 : :call Doit(item) | |
85 | 350 : let index = index + 1 |
351 :endwhile | |
352 | |
95 | 353 If all you want to do is modify each item in the list then the |map()| |
114 | 354 function will be a simpler method than a for loop. |
95 | 355 |
1621 | 356 Just like the |:let| command, |:for| also accepts a list of variables. This |
85 | 357 requires the argument to be a list of lists. > |
358 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
359 : call Doit(lnum, col) | |
360 :endfor | |
361 | |
362 This works like a |:let| command is done for each list item. Again, the types | |
363 must remain the same to avoid an error. | |
364 | |
114 | 365 It is also possible to put remaining items in a List variable: > |
85 | 366 :for [i, j; rest] in listlist |
367 : call Doit(i, j) | |
368 : if !empty(rest) | |
369 : echo "remainder: " . string(rest) | |
370 : endif | |
371 :endfor | |
372 | |
373 | |
374 List functions ~ | |
114 | 375 *E714* |
85 | 376 Functions that are useful with a List: > |
87 | 377 :let r = call(funcname, list) " call a function with an argument list |
85 | 378 :if empty(list) " check if list is empty |
102 | 379 :let l = len(list) " number of items in list |
380 :let big = max(list) " maximum value in list | |
381 :let small = min(list) " minimum value in list | |
87 | 382 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
383 :let i = index(list, 'x') " index of first 'x' in list | |
85 | 384 :let lines = getline(1, 10) " get ten text lines from buffer |
385 :call append('$', lines) " append text lines in buffer | |
95 | 386 :let list = split("a b c") " create list from items in a string |
387 :let string = join(list, ', ') " create string from list items | |
102 | 388 :let s = string(list) " String representation of list |
389 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
99 | 390 |
258 | 391 Don't forget that a combination of features can make things simple. For |
392 example, to add up all the numbers in a list: > | |
393 :exe 'let sum = ' . join(nrlist, '+') | |
394 | |
99 | 395 |
396 1.4 Dictionaries ~ | |
5814 | 397 *dict* *Dictionaries* *Dictionary* |
99 | 398 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 399 entry can be located with the key. The entries are stored without a specific |
400 ordering. | |
99 | 401 |
402 | |
403 Dictionary creation ~ | |
114 | 404 *E720* *E721* *E722* *E723* |
99 | 405 A Dictionary is created with a comma separated list of entries in curly |
114 | 406 braces. Each entry has a key and a value, separated by a colon. Each key can |
407 only appear once. Examples: > | |
99 | 408 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
409 :let emptydict = {} | |
114 | 410 < *E713* *E716* *E717* |
99 | 411 A key is always a String. You can use a Number, it will be converted to a |
412 String automatically. Thus the String '4' and the number 4 will find the same | |
1621 | 413 entry. Note that the String '04' and the Number 04 are different, since the |
114 | 414 Number will be converted to the String '4'. |
415 | |
1621 | 416 A value can be any expression. Using a Dictionary for a value creates a |
99 | 417 nested Dictionary: > |
418 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
419 | |
420 An extra comma after the last entry is ignored. | |
421 | |
422 | |
423 Accessing entries ~ | |
424 | |
425 The normal way to access an entry is by putting the key in square brackets: > | |
426 :let val = mydict["one"] | |
427 :let mydict["four"] = 4 | |
428 | |
114 | 429 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 430 |
431 For keys that consist entirely of letters, digits and underscore the following | |
432 form can be used |expr-entry|: > | |
433 :let val = mydict.one | |
434 :let mydict.four = 4 | |
435 | |
436 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
437 key lookup can be repeated: > | |
114 | 438 :echo dict.key[idx].key |
99 | 439 |
440 | |
441 Dictionary to List conversion ~ | |
442 | |
1621 | 443 You may want to loop over the entries in a dictionary. For this you need to |
99 | 444 turn the Dictionary into a List and pass it to |:for|. |
445 | |
446 Most often you want to loop over the keys, using the |keys()| function: > | |
447 :for key in keys(mydict) | |
448 : echo key . ': ' . mydict[key] | |
449 :endfor | |
450 | |
451 The List of keys is unsorted. You may want to sort them first: > | |
452 :for key in sort(keys(mydict)) | |
453 | |
454 To loop over the values use the |values()| function: > | |
455 :for v in values(mydict) | |
456 : echo "value: " . v | |
457 :endfor | |
458 | |
459 If you want both the key and the value use the |items()| function. It returns | |
1621 | 460 a List in which each item is a List with two items, the key and the value: > |
1156 | 461 :for [key, value] in items(mydict) |
462 : echo key . ': ' . value | |
99 | 463 :endfor |
464 | |
465 | |
466 Dictionary identity ~ | |
161 | 467 *dict-identity* |
99 | 468 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
469 Dictionary. Otherwise, assignment results in referring to the same | |
470 Dictionary: > | |
471 :let onedict = {'a': 1, 'b': 2} | |
472 :let adict = onedict | |
473 :let adict['a'] = 11 | |
474 :echo onedict['a'] | |
475 11 | |
476 | |
327 | 477 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
478 more info see |list-identity|. | |
99 | 479 |
480 | |
481 Dictionary modification ~ | |
482 *dict-modification* | |
483 To change an already existing entry of a Dictionary, or to add a new entry, | |
484 use |:let| this way: > | |
485 :let dict[4] = "four" | |
486 :let dict['one'] = item | |
487 | |
108 | 488 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
489 Three ways to remove the entry with key "aaa" from dict: > | |
490 :let i = remove(dict, 'aaa') | |
491 :unlet dict.aaa | |
492 :unlet dict['aaa'] | |
99 | 493 |
494 Merging a Dictionary with another is done with |extend()|: > | |
114 | 495 :call extend(adict, bdict) |
496 This extends adict with all entries from bdict. Duplicate keys cause entries | |
497 in adict to be overwritten. An optional third argument can change this. | |
119 | 498 Note that the order of entries in a Dictionary is irrelevant, thus don't |
499 expect ":echo adict" to show the items from bdict after the older entries in | |
500 adict. | |
99 | 501 |
502 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 503 :call filter(dict, 'v:val =~ "x"') |
114 | 504 This removes all entries from "dict" with a value not matching 'x'. |
102 | 505 |
506 | |
507 Dictionary function ~ | |
4159 | 508 *Dictionary-function* *self* *E725* *E862* |
102 | 509 When a function is defined with the "dict" attribute it can be used in a |
1621 | 510 special way with a dictionary. Example: > |
102 | 511 :function Mylen() dict |
114 | 512 : return len(self.data) |
102 | 513 :endfunction |
114 | 514 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
515 :echo mydict.len() | |
102 | 516 |
517 This is like a method in object oriented programming. The entry in the | |
518 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
519 the function was invoked from. | |
520 | |
114 | 521 It is also possible to add a function without the "dict" attribute as a |
522 Funcref to a Dictionary, but the "self" variable is not available then. | |
523 | |
819 | 524 *numbered-function* *anonymous-function* |
102 | 525 To avoid the extra name for the function it can be defined and directly |
526 assigned to a Dictionary in this way: > | |
114 | 527 :let mydict = {'data': [0, 1, 2, 3]} |
6741 | 528 :function mydict.len() |
114 | 529 : return len(self.data) |
102 | 530 :endfunction |
114 | 531 :echo mydict.len() |
532 | |
533 The function will then get a number and the value of dict.len is a |Funcref| | |
1621 | 534 that references this function. The function can only be used through a |
114 | 535 |Funcref|. It will automatically be deleted when there is no |Funcref| |
536 remaining that refers to it. | |
537 | |
538 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 539 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
540 If you get an error for a numbered function, you can find out what it is with |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
541 a trick. Assuming the function is 42, the command is: > |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
542 :function {42} |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
543 |
102 | 544 |
545 Functions for Dictionaries ~ | |
114 | 546 *E715* |
547 Functions that can be used with a Dictionary: > | |
102 | 548 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
549 :if empty(dict) " TRUE if dict is empty | |
550 :let l = len(dict) " number of items in dict | |
551 :let big = max(dict) " maximum value in dict | |
552 :let small = min(dict) " minimum value in dict | |
553 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
554 :let s = string(dict) " String representation of dict | |
555 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
99 | 556 |
557 | |
558 1.5 More about variables ~ | |
85 | 559 *more-variables* |
7 | 560 If you need to know the type of a variable or expression, use the |type()| |
561 function. | |
562 | |
563 When the '!' flag is included in the 'viminfo' option, global variables that | |
564 start with an uppercase letter, and don't contain a lowercase letter, are | |
565 stored in the viminfo file |viminfo-file|. | |
566 | |
567 When the 'sessionoptions' option contains "global", global variables that | |
568 start with an uppercase letter and contain at least one lowercase letter are | |
569 stored in the session file |session-file|. | |
570 | |
571 variable name can be stored where ~ | |
572 my_var_6 not | |
573 My_Var_6 session file | |
574 MY_VAR_6 viminfo file | |
575 | |
576 | |
577 It's possible to form a variable name with curly braces, see | |
578 |curly-braces-names|. | |
579 | |
580 ============================================================================== | |
581 2. Expression syntax *expression-syntax* | |
582 | |
583 Expression syntax summary, from least to most significant: | |
584 | |
585 |expr1| expr2 ? expr1 : expr1 if-then-else | |
586 | |
587 |expr2| expr3 || expr3 .. logical OR | |
588 | |
589 |expr3| expr4 && expr4 .. logical AND | |
590 | |
591 |expr4| expr5 == expr5 equal | |
592 expr5 != expr5 not equal | |
593 expr5 > expr5 greater than | |
594 expr5 >= expr5 greater than or equal | |
595 expr5 < expr5 smaller than | |
596 expr5 <= expr5 smaller than or equal | |
597 expr5 =~ expr5 regexp matches | |
598 expr5 !~ expr5 regexp doesn't match | |
599 | |
600 expr5 ==? expr5 equal, ignoring case | |
601 expr5 ==# expr5 equal, match case | |
602 etc. As above, append ? for ignoring case, # for | |
603 matching case | |
604 | |
685 | 605 expr5 is expr5 same |List| instance |
606 expr5 isnot expr5 different |List| instance | |
79 | 607 |
608 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 609 expr6 - expr6 .. number subtraction |
610 expr6 . expr6 .. string concatenation | |
611 | |
612 |expr6| expr7 * expr7 .. number multiplication | |
613 expr7 / expr7 .. number division | |
614 expr7 % expr7 .. number modulo | |
615 | |
616 |expr7| ! expr7 logical NOT | |
617 - expr7 unary minus | |
618 + expr7 unary plus | |
102 | 619 |
685 | 620 |expr8| expr8[expr1] byte of a String or item of a |List| |
621 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
622 expr8.name entry in a |Dictionary| | |
623 expr8(expr1, ...) function call with |Funcref| variable | |
102 | 624 |
625 |expr9| number number constant | |
26 | 626 "string" string constant, backslash is special |
99 | 627 'string' string constant, ' is doubled |
685 | 628 [expr1, ...] |List| |
629 {expr1: expr1, ...} |Dictionary| | |
7 | 630 &option option value |
631 (expr1) nested expression | |
632 variable internal variable | |
633 va{ria}ble internal variable with curly braces | |
634 $VAR environment variable | |
635 @r contents of register 'r' | |
636 function(expr1, ...) function call | |
637 func{ti}on(expr1, ...) function call with curly braces | |
638 | |
639 | |
640 ".." indicates that the operations in this level can be concatenated. | |
641 Example: > | |
642 &nu || &list && &shell == "csh" | |
643 | |
644 All expressions within one level are parsed from left to right. | |
645 | |
646 | |
647 expr1 *expr1* *E109* | |
648 ----- | |
649 | |
650 expr2 ? expr1 : expr1 | |
651 | |
652 The expression before the '?' is evaluated to a number. If it evaluates to | |
653 non-zero, the result is the value of the expression between the '?' and ':', | |
654 otherwise the result is the value of the expression after the ':'. | |
655 Example: > | |
656 :echo lnum == 1 ? "top" : lnum | |
657 | |
658 Since the first expression is an "expr2", it cannot contain another ?:. The | |
659 other two expressions can, thus allow for recursive use of ?:. | |
660 Example: > | |
661 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
662 | |
663 To keep this readable, using |line-continuation| is suggested: > | |
664 :echo lnum == 1 | |
665 :\ ? "top" | |
666 :\ : lnum == 1000 | |
667 :\ ? "last" | |
668 :\ : lnum | |
669 | |
1156 | 670 You should always put a space before the ':', otherwise it can be mistaken for |
671 use in a variable such as "a:1". | |
672 | |
7 | 673 |
674 expr2 and expr3 *expr2* *expr3* | |
675 --------------- | |
676 | |
677 *expr-barbar* *expr-&&* | |
678 The "||" and "&&" operators take one argument on each side. The arguments | |
679 are (converted to) Numbers. The result is: | |
680 | |
681 input output ~ | |
682 n1 n2 n1 || n2 n1 && n2 ~ | |
683 zero zero zero zero | |
684 zero non-zero non-zero zero | |
685 non-zero zero non-zero zero | |
686 non-zero non-zero non-zero non-zero | |
687 | |
688 The operators can be concatenated, for example: > | |
689 | |
690 &nu || &list && &shell == "csh" | |
691 | |
692 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
693 | |
694 &nu || (&list && &shell == "csh") | |
695 | |
696 Once the result is known, the expression "short-circuits", that is, further | |
697 arguments are not evaluated. This is like what happens in C. For example: > | |
698 | |
699 let a = 1 | |
700 echo a || b | |
701 | |
702 This is valid even if there is no variable called "b" because "a" is non-zero, | |
703 so the result must be non-zero. Similarly below: > | |
704 | |
705 echo exists("b") && b == "yes" | |
706 | |
707 This is valid whether "b" has been defined or not. The second clause will | |
708 only be evaluated if "b" has been defined. | |
709 | |
710 | |
711 expr4 *expr4* | |
712 ----- | |
713 | |
714 expr5 {cmp} expr5 | |
715 | |
716 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
717 if it evaluates to true. | |
718 | |
1621 | 719 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 720 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
721 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
722 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
723 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
724 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 725 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
726 *expr-is?* *expr-isnot?* | |
7 | 727 use 'ignorecase' match case ignore case ~ |
728 equal == ==# ==? | |
729 not equal != !=# !=? | |
730 greater than > ># >? | |
731 greater than or equal >= >=# >=? | |
732 smaller than < <# <? | |
733 smaller than or equal <= <=# <=? | |
734 regexp matches =~ =~# =~? | |
735 regexp doesn't match !~ !~# !~? | |
2908 | 736 same instance is is# is? |
737 different instance isnot isnot# isnot? | |
7 | 738 |
739 Examples: | |
740 "abc" ==# "Abc" evaluates to 0 | |
741 "abc" ==? "Abc" evaluates to 1 | |
742 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
743 | |
85 | 744 *E691* *E692* |
685 | 745 A |List| can only be compared with a |List| and only "equal", "not equal" and |
746 "is" can be used. This compares the values of the list, recursively. | |
747 Ignoring case means case is ignored when comparing item values. | |
79 | 748 |
114 | 749 *E735* *E736* |
685 | 750 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
751 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
114 | 752 recursively. Ignoring case means case is ignored when comparing item values. |
753 | |
85 | 754 *E693* *E694* |
685 | 755 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
756 equal" can be used. Case is never ignored. Whether arguments or a Dictionary |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
757 are bound (with a partial) is ignored. This is so that when a function is |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
758 made a member of a Dictionary it is still considered to be the same function. |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
759 To compare partials to see if they bind the same argument and Dictionary |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
760 values use string(): > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
761 echo string(Partial1) == string(Partial2) |
685 | 762 |
2908 | 763 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
764 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
765 of a |List| is different from the original |List|. When using "is" without | |
766 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
767 equivalent to using "not equal". Except that a different type means the | |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
768 values are different: > |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
769 echo 4 == '4' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
770 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
771 echo 4 is '4' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
772 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
773 echo 0 is [] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
774 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
775 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
79 | 776 |
7 | 777 When comparing a String with a Number, the String is converted to a Number, |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
778 and the comparison is done on Numbers. This means that: > |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
779 echo 0 == 'x' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
780 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
781 because 'x' converted to a Number is zero. However: > |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
782 echo [0] == ['x'] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
783 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
784 Inside a List or Dictionary this conversion is not used. |
7 | 785 |
786 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
787 results in the mathematical difference (comparing byte values), not | |
788 necessarily the alphabetical difference in the local language. | |
789 | |
1621 | 790 When using the operators with a trailing '#', or the short version and |
1156 | 791 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 792 |
793 When using the operators with a trailing '?', or the short version and | |
1156 | 794 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
795 | |
796 'smartcase' is not used. | |
7 | 797 |
798 The "=~" and "!~" operators match the lefthand argument with the righthand | |
799 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
800 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
801 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
802 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
803 single-quote string, see |literal-string|. | |
804 Since a string is considered to be a single line, a multi-line pattern | |
805 (containing \n, backslash-n) will not match. However, a literal NL character | |
806 can be matched like an ordinary character. Examples: | |
807 "foo\nbar" =~ "\n" evaluates to 1 | |
808 "foo\nbar" =~ "\\n" evaluates to 0 | |
809 | |
810 | |
811 expr5 and expr6 *expr5* *expr6* | |
812 --------------- | |
685 | 813 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 814 expr6 - expr6 .. Number subtraction *expr--* |
815 expr6 . expr6 .. String concatenation *expr-.* | |
816 | |
692 | 817 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 818 result is a new list with the two lists Concatenated. |
79 | 819 |
3214 | 820 expr7 * expr7 .. Number multiplication *expr-star* |
821 expr7 / expr7 .. Number division *expr-/* | |
822 expr7 % expr7 .. Number modulo *expr-%* | |
7 | 823 |
824 For all, except ".", Strings are converted to Numbers. | |
3214 | 825 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 826 |
827 Note the difference between "+" and ".": | |
828 "123" + "456" = 579 | |
829 "123" . "456" = "123456" | |
830 | |
1621 | 831 Since '.' has the same precedence as '+' and '-', you need to read: > |
832 1 . 90 + 90.0 | |
833 As: > | |
834 (1 . 90) + 90.0 | |
835 That works, since the String "190" is automatically converted to the Number | |
836 190, which can be added to the Float 90.0. However: > | |
837 1 . 90 * 90.0 | |
838 Should be read as: > | |
839 1 . (90 * 90.0) | |
840 Since '.' has lower precedence than '*'. This does NOT work, since this | |
841 attempts to concatenate a Float and a String. | |
842 | |
843 When dividing a Number by zero the result depends on the value: | |
844 0 / 0 = -0x80000000 (like NaN for Float) | |
845 >0 / 0 = 0x7fffffff (like positive infinity) | |
846 <0 / 0 = -0x7fffffff (like negative infinity) | |
847 (before Vim 7.2 it was always 0x7fffffff) | |
848 | |
7 | 849 When the righthand side of '%' is zero, the result is 0. |
850 | |
685 | 851 None of these work for |Funcref|s. |
79 | 852 |
1621 | 853 . and % do not work for Float. *E804* |
854 | |
7 | 855 |
856 expr7 *expr7* | |
857 ----- | |
858 ! expr7 logical NOT *expr-!* | |
859 - expr7 unary minus *expr-unary--* | |
860 + expr7 unary plus *expr-unary-+* | |
861 | |
862 For '!' non-zero becomes zero, zero becomes one. | |
863 For '-' the sign of the number is changed. | |
864 For '+' the number is unchanged. | |
865 | |
866 A String will be converted to a Number first. | |
867 | |
1621 | 868 These three can be repeated and mixed. Examples: |
7 | 869 !-1 == 0 |
870 !!8 == 1 | |
871 --9 == 9 | |
872 | |
873 | |
874 expr8 *expr8* | |
875 ----- | |
685 | 876 expr8[expr1] item of String or |List| *expr-[]* *E111* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
877 *E909* |
102 | 878 If expr8 is a Number or String this results in a String that contains the |
879 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
|
880 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
881 an alternative. |
55 | 882 |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
883 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
|
884 text column numbers start with one! Example, to get the byte under the |
55 | 885 cursor: > |
823 | 886 :let c = getline(".")[col(".") - 1] |
7 | 887 |
888 If the length of the String is less than the index, the result is an empty | |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
889 String. A negative index always results in an empty string (reason: backward |
55 | 890 compatibility). Use [-1:] to get the last byte. |
891 | |
685 | 892 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 893 for possible index values. If the index is out of range this results in an |
1621 | 894 error. Example: > |
55 | 895 :let item = mylist[-1] " get last item |
896 | |
685 | 897 Generally, if a |List| index is equal to or higher than the length of the |
898 |List|, or more negative than the length of the |List|, this results in an | |
899 error. | |
55 | 900 |
99 | 901 |
102 | 902 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
903 | |
904 If expr8 is a Number or String this results in the substring with the bytes | |
905 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
|
906 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
|
907 |byteidx()| for computing the indexes. |
55 | 908 |
909 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
910 string minus one is used. | |
911 | |
912 A negative number can be used to measure from the end of the string. -1 is | |
913 the last character, -2 the last but one, etc. | |
914 | |
915 If an index goes out of range for the string characters are omitted. If | |
916 expr1b is smaller than expr1a the result is an empty string. | |
917 | |
918 Examples: > | |
919 :let c = name[-1:] " last byte of a string | |
920 :let c = name[-2:-2] " last but one byte of a string | |
921 :let s = line(".")[4:] " from the fifth byte to the end | |
922 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
923 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
924 *sublist* *slice* |
685 | 925 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 926 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 927 just above, except that indexes out of range cause an error. Examples: > |
55 | 928 :let l = mylist[:3] " first four items |
929 :let l = mylist[4:4] " List with one item | |
930 :let l = mylist[:] " shallow copy of a List | |
931 | |
685 | 932 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
933 error. | |
934 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
935 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
|
936 for a sublist: > |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
937 mylist[n:] " uses variable n |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
938 mylist[s:] " uses namespace s:, error! |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
939 |
685 | 940 |
941 expr8.name entry in a |Dictionary| *expr-entry* | |
942 | |
943 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
944 name will be used as a key in the |Dictionary|. This is just like: | |
945 expr8[name]. | |
99 | 946 |
947 The name must consist of alphanumeric characters, just like a variable name, | |
948 but it may start with a number. Curly braces cannot be used. | |
949 | |
950 There must not be white space before or after the dot. | |
951 | |
952 Examples: > | |
953 :let dict = {"one": 1, 2: "two"} | |
954 :echo dict.one | |
955 :echo dict .2 | |
956 | |
957 Note that the dot is also used for String concatenation. To avoid confusion | |
958 always put spaces around the dot for String concatenation. | |
959 | |
960 | |
685 | 961 expr8(expr1, ...) |Funcref| function call |
102 | 962 |
963 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
964 | |
965 | |
966 | |
967 *expr9* | |
7 | 968 number |
969 ------ | |
3224 | 970 number number constant *expr-number* |
971 *hex-number* *octal-number* | |
7 | 972 |
973 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
974 | |
1621 | 975 *floating-point-format* |
976 Floating point numbers can be written in two forms: | |
977 | |
978 [-+]{N}.{M} | |
6530 | 979 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 980 |
981 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
982 contain digits. | |
983 [-+] means there is an optional plus or minus sign. | |
984 {exp} is the exponent, power of 10. | |
985 Only a decimal point is accepted, not a comma. No matter what the current | |
986 locale is. | |
987 {only when compiled with the |+float| feature} | |
988 | |
989 Examples: | |
990 123.456 | |
991 +0.0001 | |
992 55.0 | |
993 -0.123 | |
994 1.234e03 | |
995 1.0E-6 | |
996 -3.1416e+88 | |
997 | |
998 These are INVALID: | |
999 3. empty {M} | |
1000 1e40 missing .{M} | |
1001 | |
1698 | 1002 *float-pi* *float-e* |
1003 A few useful values to copy&paste: > | |
1004 :let pi = 3.14159265359 | |
1005 :let e = 2.71828182846 | |
1006 | |
1621 | 1007 Rationale: |
1008 Before floating point was introduced, the text "123.456" was interpreted as | |
1009 the two numbers "123" and "456", both converted to a string and concatenated, | |
1010 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 1011 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 1012 incompatibility was accepted in favor of being able to use the normal notation |
1013 for floating point numbers. | |
1014 | |
1015 *floating-point-precision* | |
1016 The precision and range of floating points numbers depends on what "double" | |
1017 means in the library Vim was compiled with. There is no way to change this at | |
1018 runtime. | |
1019 | |
1020 The default for displaying a |Float| is to use 6 decimal places, like using | |
1021 printf("%g", f). You can select something else when using the |printf()| | |
1022 function. Example: > | |
1023 :echo printf('%.15e', atan(1)) | |
1024 < 7.853981633974483e-01 | |
1025 | |
1026 | |
7 | 1027 |
6884 | 1028 string *string* *String* *expr-string* *E114* |
7 | 1029 ------ |
1030 "string" string constant *expr-quote* | |
1031 | |
1032 Note that double quotes are used. | |
1033 | |
1034 A string constant accepts these special characters: | |
1035 \... three-digit octal number (e.g., "\316") | |
1036 \.. two-digit octal number (must be followed by non-digit) | |
1037 \. one-digit octal number (must be followed by non-digit) | |
1038 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1039 \x. byte specified with one hex number (must be followed by non-hex char) | |
1040 \X.. same as \x.. | |
1041 \X. same as \x. | |
1621 | 1042 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1043 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1044 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1045 \b backspace <BS> |
1046 \e escape <Esc> | |
1047 \f formfeed <FF> | |
1048 \n newline <NL> | |
1049 \r return <CR> | |
1050 \t tab <Tab> | |
1051 \\ backslash | |
1052 \" double quote | |
2152 | 1053 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1054 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1055 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1056 |
1156 | 1057 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1058 encodings. Use "\u00ff" to store character 255 according to the current value | |
1059 of 'encoding'. | |
1060 | |
7 | 1061 Note that "\000" and "\x00" force the end of the string. |
1062 | |
1063 | |
1064 literal-string *literal-string* *E115* | |
1065 --------------- | |
26 | 1066 'string' string constant *expr-'* |
7 | 1067 |
1068 Note that single quotes are used. | |
1069 | |
1621 | 1070 This string is taken as it is. No backslashes are removed or have a special |
99 | 1071 meaning. The only exception is that two quotes stand for one quote. |
26 | 1072 |
1073 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1074 to be doubled. These two commands are equivalent: > |
26 | 1075 if a =~ "\\s*" |
1076 if a =~ '\s*' | |
7 | 1077 |
1078 | |
1079 option *expr-option* *E112* *E113* | |
1080 ------ | |
1081 &option option value, local value if possible | |
1082 &g:option global option value | |
1083 &l:option local option value | |
1084 | |
1085 Examples: > | |
1086 echo "tabstop is " . &tabstop | |
1087 if &insertmode | |
1088 | |
1089 Any option name can be used here. See |options|. When using the local value | |
1090 and there is no buffer-local or window-local value, the global value is used | |
1091 anyway. | |
1092 | |
1093 | |
1156 | 1094 register *expr-register* *@r* |
7 | 1095 -------- |
1096 @r contents of register 'r' | |
1097 | |
1098 The result is the contents of the named register, as a single string. | |
1099 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1100 register use @" or @@. See |registers| for an explanation of the available |
336 | 1101 registers. |
1102 | |
1103 When using the '=' register you get the expression itself, not what it | |
1104 evaluates to. Use |eval()| to evaluate it. | |
7 | 1105 |
1106 | |
1107 nesting *expr-nesting* *E110* | |
1108 ------- | |
1109 (expr1) nested expression | |
1110 | |
1111 | |
1112 environment variable *expr-env* | |
1113 -------------------- | |
1114 $VAR environment variable | |
1115 | |
1116 The String value of any environment variable. When it is not defined, the | |
1117 result is an empty string. | |
1118 *expr-env-expand* | |
1119 Note that there is a difference between using $VAR directly and using | |
1120 expand("$VAR"). Using it directly will only expand environment variables that | |
1121 are known inside the current Vim session. Using expand() will first try using | |
1122 the environment variables known inside the current Vim session. If that | |
1123 fails, a shell will be used to expand the variable. This can be slow, but it | |
1124 does expand all variables that the shell knows about. Example: > | |
6180 | 1125 :echo $shell |
1126 :echo expand("$shell") | |
1127 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1128 variable (if your shell supports it). |
1129 | |
1130 | |
1131 internal variable *expr-variable* | |
1132 ----------------- | |
1133 variable internal variable | |
1134 See below |internal-variables|. | |
1135 | |
1136 | |
170 | 1137 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1138 ------------- |
1139 function(expr1, ...) function call | |
1140 See below |functions|. | |
1141 | |
1142 | |
1143 ============================================================================== | |
2596 | 1144 3. Internal variable *internal-variables* *E461* |
1145 | |
7 | 1146 An internal variable name can be made up of letters, digits and '_'. But it |
1147 cannot start with a digit. It's also possible to use curly braces, see | |
1148 |curly-braces-names|. | |
1149 | |
1150 An internal variable is created with the ":let" command |:let|. | |
87 | 1151 An internal variable is explicitly destroyed with the ":unlet" command |
1152 |:unlet|. | |
1153 Using a name that is not an internal variable or refers to a variable that has | |
1154 been destroyed results in an error. | |
7 | 1155 |
1156 There are several name spaces for variables. Which one is to be used is | |
1157 specified by what is prepended: | |
1158 | |
1159 (nothing) In a function: local to a function; otherwise: global | |
1160 |buffer-variable| b: Local to the current buffer. | |
1161 |window-variable| w: Local to the current window. | |
819 | 1162 |tabpage-variable| t: Local to the current tab page. |
7 | 1163 |global-variable| g: Global. |
1164 |local-variable| l: Local to a function. | |
1165 |script-variable| s: Local to a |:source|'ed Vim script. | |
1166 |function-argument| a: Function argument (only inside a function). | |
5815 | 1167 |vim-variable| v: Global, predefined by Vim. |
7 | 1168 |
685 | 1169 The scope name by itself can be used as a |Dictionary|. For example, to |
1170 delete all script-local variables: > | |
133 | 1171 :for k in keys(s:) |
1172 : unlet s:[k] | |
1173 :endfor | |
1174 < | |
4358 | 1175 *buffer-variable* *b:var* *b:* |
7 | 1176 A variable name that is preceded with "b:" is local to the current buffer. |
1177 Thus you can have several "b:foo" variables, one for each buffer. | |
1178 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1179 |:bdelete|. | |
1180 | |
1181 One local buffer variable is predefined: | |
4264 | 1182 *b:changedtick* *changetick* |
7 | 1183 b:changedtick The total number of changes to the current buffer. It is |
1184 incremented for each change. An undo command is also a change | |
1185 in this case. This can be used to perform an action only when | |
1186 the buffer has changed. Example: > | |
1187 :if my_changedtick != b:changedtick | |
1621 | 1188 : let my_changedtick = b:changedtick |
1189 : call My_Update() | |
7 | 1190 :endif |
1191 < | |
4358 | 1192 *window-variable* *w:var* *w:* |
7 | 1193 A variable name that is preceded with "w:" is local to the current window. It |
1194 is deleted when the window is closed. | |
1195 | |
4437 | 1196 *tabpage-variable* *t:var* *t:* |
819 | 1197 A variable name that is preceded with "t:" is local to the current tab page, |
1198 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
|
1199 without the |+windows| feature} |
819 | 1200 |
4358 | 1201 *global-variable* *g:var* *g:* |
7 | 1202 Inside functions global variables are accessed with "g:". Omitting this will |
1621 | 1203 access a variable local to a function. But "g:" can also be used in any other |
7 | 1204 place if you like. |
1205 | |
4358 | 1206 *local-variable* *l:var* *l:* |
7 | 1207 Inside functions local variables are accessed without prepending anything. |
1156 | 1208 But you can also prepend "l:" if you like. However, without prepending "l:" |
1209 you may run into reserved variable names. For example "count". By itself it | |
1210 refers to "v:count". Using "l:count" you can have a local variable with the | |
1211 same name. | |
7 | 1212 |
1213 *script-variable* *s:var* | |
1214 In a Vim script variables starting with "s:" can be used. They cannot be | |
1215 accessed from outside of the scripts, thus are local to the script. | |
1216 | |
1217 They can be used in: | |
1218 - commands executed while the script is sourced | |
1219 - functions defined in the script | |
1220 - autocommands defined in the script | |
1221 - functions and autocommands defined in functions and autocommands which were | |
1222 defined in the script (recursively) | |
1223 - user defined commands defined in the script | |
1224 Thus not in: | |
1225 - other scripts sourced from this one | |
1226 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1227 - menus |
7 | 1228 - etc. |
1229 | |
1156 | 1230 Script variables can be used to avoid conflicts with global variable names. |
1231 Take this example: > | |
7 | 1232 |
1233 let s:counter = 0 | |
1234 function MyCounter() | |
1235 let s:counter = s:counter + 1 | |
1236 echo s:counter | |
1237 endfunction | |
1238 command Tick call MyCounter() | |
1239 | |
1240 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1241 that script will not be changed, only the "s:counter" in the script where | |
1242 "Tick" was defined is used. | |
1243 | |
1244 Another example that does the same: > | |
1245 | |
1246 let s:counter = 0 | |
1247 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1248 | |
1249 When calling a function and invoking a user-defined command, the context for | |
9 | 1250 script variables is set to the script where the function or command was |
7 | 1251 defined. |
1252 | |
1253 The script variables are also available when a function is defined inside a | |
1254 function that is defined in a script. Example: > | |
1255 | |
1256 let s:counter = 0 | |
1257 function StartCounting(incr) | |
1258 if a:incr | |
1259 function MyCounter() | |
1260 let s:counter = s:counter + 1 | |
1261 endfunction | |
1262 else | |
1263 function MyCounter() | |
1264 let s:counter = s:counter - 1 | |
1265 endfunction | |
1266 endif | |
1267 endfunction | |
1268 | |
1269 This defines the MyCounter() function either for counting up or counting down | |
1270 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1271 called, the s:counter variable will be accessible in MyCounter(). | |
1272 | |
1273 When the same script is sourced again it will use the same script variables. | |
1274 They will remain valid as long as Vim is running. This can be used to | |
1275 maintain a counter: > | |
1276 | |
1277 if !exists("s:counter") | |
1278 let s:counter = 1 | |
1279 echo "script executed for the first time" | |
1280 else | |
1281 let s:counter = s:counter + 1 | |
1282 echo "script executed " . s:counter . " times now" | |
1283 endif | |
1284 | |
1285 Note that this means that filetype plugins don't get a different set of script | |
1286 variables for each buffer. Use local buffer variables instead |b:var|. | |
1287 | |
1288 | |
4358 | 1289 Predefined Vim variables: *vim-variable* *v:var* *v:* |
7 | 1290 |
189 | 1291 *v:beval_col* *beval_col-variable* |
1292 v:beval_col The number of the column, over which the mouse pointer is. | |
1293 This is the byte index in the |v:beval_lnum| line. | |
1294 Only valid while evaluating the 'balloonexpr' option. | |
1295 | |
1296 *v:beval_bufnr* *beval_bufnr-variable* | |
1297 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1298 valid while evaluating the 'balloonexpr' option. | |
1299 | |
1300 *v:beval_lnum* *beval_lnum-variable* | |
1301 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1302 valid while evaluating the 'balloonexpr' option. | |
1303 | |
1304 *v:beval_text* *beval_text-variable* | |
374 | 1305 v:beval_text The text under or after the mouse pointer. Usually a word as |
1306 it is useful for debugging a C program. 'iskeyword' applies, | |
1307 but a dot and "->" before the position is included. When on a | |
1308 ']' the text before it is used, including the matching '[' and | |
189 | 1309 word before it. When on a Visual area within one line the |
1310 highlighted text is used. | |
1311 Only valid while evaluating the 'balloonexpr' option. | |
1312 | |
1313 *v:beval_winnr* *beval_winnr-variable* | |
1314 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1315 valid while evaluating the 'balloonexpr' option. The first |
1316 window has number zero (unlike most other places where a | |
1317 window gets a number). | |
189 | 1318 |
844 | 1319 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1320 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
|
1321 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
|
1322 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1323 |
7 | 1324 *v:charconvert_from* *charconvert_from-variable* |
1325 v:charconvert_from | |
1326 The name of the character encoding of a file to be converted. | |
1327 Only valid while evaluating the 'charconvert' option. | |
1328 | |
1329 *v:charconvert_to* *charconvert_to-variable* | |
1330 v:charconvert_to | |
1331 The name of the character encoding of a file after conversion. | |
1332 Only valid while evaluating the 'charconvert' option. | |
1333 | |
1334 *v:cmdarg* *cmdarg-variable* | |
1335 v:cmdarg This variable is used for two purposes: | |
1336 1. The extra arguments given to a file read/write command. | |
1337 Currently these are "++enc=" and "++ff=". This variable is | |
1338 set before an autocommand event for a file read/write | |
1339 command is triggered. There is a leading space to make it | |
1340 possible to append this variable directly after the | |
1621 | 1341 read/write command. Note: The "+cmd" argument isn't |
7 | 1342 included here, because it will be executed anyway. |
1343 2. When printing a PostScript file with ":hardcopy" this is | |
1344 the argument for the ":hardcopy" command. This can be used | |
1345 in 'printexpr'. | |
1346 | |
1347 *v:cmdbang* *cmdbang-variable* | |
1348 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1349 was used the value is 1, otherwise it is 0. Note that this | |
1350 can only be used in autocommands. For user commands |<bang>| | |
1351 can be used. | |
1352 | |
6909 | 1353 *v:completed_item* *completed_item-variable* |
1354 v:completed_item | |
1355 |Dictionary| containing the |complete-items| for the most | |
1356 recently completed word after |CompleteDone|. The | |
1357 |Dictionary| is empty if the completion failed. | |
1358 | |
7 | 1359 *v:count* *count-variable* |
1360 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1361 to get the count before a mapping. Read-only. Example: > |
7 | 1362 :map _x :<C-U>echo "the count is " . v:count<CR> |
1363 < Note: The <C-U> is required to remove the line range that you | |
1364 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1365 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1366 just like what happens in the command, "d6w" for the example. |
667 | 1367 Also used for evaluating the 'formatexpr' option. |
7 | 1368 "count" also works, for backwards compatibility. |
1369 | |
1370 *v:count1* *count1-variable* | |
1371 v:count1 Just like "v:count", but defaults to one when no count is | |
1372 used. | |
1373 | |
1374 *v:ctype* *ctype-variable* | |
1375 v:ctype The current locale setting for characters of the runtime | |
1376 environment. This allows Vim scripts to be aware of the | |
1377 current locale encoding. Technical: it's the value of | |
1378 LC_CTYPE. When not using a locale the value is "C". | |
1379 This variable can not be set directly, use the |:language| | |
1380 command. | |
1381 See |multi-lang|. | |
1382 | |
1383 *v:dying* *dying-variable* | |
1621 | 1384 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1385 one. When multiple signals are caught the number increases. |
1386 Can be used in an autocommand to check if Vim didn't | |
1387 terminate normally. {only works on Unix} | |
1388 Example: > | |
1389 :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
|
1390 < 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
|
1391 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
|
1392 |
7 | 1393 *v:errmsg* *errmsg-variable* |
1394 v:errmsg Last given error message. It's allowed to set this variable. | |
1395 Example: > | |
1396 :let v:errmsg = "" | |
1397 :silent! next | |
1398 :if v:errmsg != "" | |
1399 : ... handle error | |
1400 < "errmsg" also works, for backwards compatibility. | |
1401 | |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1402 *v:errors* *errors-variable* |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1403 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
|
1404 This is a list of strings. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1405 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
|
1406 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
|
1407 :let v:errors = [] |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1408 < 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
|
1409 list by the assert function. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1410 |
7 | 1411 *v:exception* *exception-variable* |
1412 v:exception The value of the exception most recently caught and not | |
1413 finished. See also |v:throwpoint| and |throw-variables|. | |
1414 Example: > | |
1415 :try | |
1416 : throw "oops" | |
1417 :catch /.*/ | |
1418 : echo "caught" v:exception | |
1419 :endtry | |
1420 < Output: "caught oops". | |
1421 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1422 *v:false* *false-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1423 v:false A Number with value zero. Used to put "false" in JSON. See |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1424 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1425 When used as a string this evaluates to "false". > |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1426 echo v:false |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1427 < false ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1428 |
179 | 1429 *v:fcs_reason* *fcs_reason-variable* |
1430 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1431 Can be used in an autocommand to decide what to do and/or what | |
1432 to set v:fcs_choice to. Possible values: | |
1433 deleted file no longer exists | |
1434 conflict file contents, mode or timestamp was | |
1435 changed and buffer is modified | |
1436 changed file contents has changed | |
1437 mode mode of file changed | |
1438 time only file timestamp changed | |
1439 | |
1440 *v:fcs_choice* *fcs_choice-variable* | |
1441 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1442 triggered. Can be used in an autocommand to tell Vim what to | |
1443 do with the affected buffer: | |
1444 reload Reload the buffer (does not work if | |
1445 the file was deleted). | |
1446 ask Ask the user what to do, as if there | |
1447 was no autocommand. Except that when | |
1448 only the timestamp changed nothing | |
1449 will happen. | |
1450 <empty> Nothing, the autocommand should do | |
1451 everything that needs to be done. | |
1452 The default is empty. If another (invalid) value is used then | |
1453 Vim behaves like it is empty, there is no warning message. | |
1454 | |
7 | 1455 *v:fname_in* *fname_in-variable* |
579 | 1456 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1457 option used for ~ |
1458 'charconvert' file to be converted | |
1459 'diffexpr' original file | |
1460 'patchexpr' original file | |
1461 'printexpr' file to be printed | |
593 | 1462 And set to the swap file name for |SwapExists|. |
7 | 1463 |
1464 *v:fname_out* *fname_out-variable* | |
1465 v:fname_out The name of the output file. Only valid while | |
1466 evaluating: | |
1467 option used for ~ | |
1468 'charconvert' resulting converted file (*) | |
1469 'diffexpr' output of diff | |
1470 'patchexpr' resulting patched file | |
1471 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1472 file") it will be equal to v:fname_in. When doing conversion |
7 | 1473 for a read command (e.g., ":e file") it will be a temporary |
1474 file and different from v:fname_in. | |
1475 | |
1476 *v:fname_new* *fname_new-variable* | |
1477 v:fname_new The name of the new version of the file. Only valid while | |
1478 evaluating 'diffexpr'. | |
1479 | |
1480 *v:fname_diff* *fname_diff-variable* | |
1481 v:fname_diff The name of the diff (patch) file. Only valid while | |
1482 evaluating 'patchexpr'. | |
1483 | |
1484 *v:folddashes* *folddashes-variable* | |
1485 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1486 fold. | |
29 | 1487 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1488 |
1489 *v:foldlevel* *foldlevel-variable* | |
1490 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1491 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1492 |
1493 *v:foldend* *foldend-variable* | |
1494 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1495 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1496 |
1497 *v:foldstart* *foldstart-variable* | |
1498 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1499 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1500 |
5460 | 1501 *v:hlsearch* *hlsearch-variable* |
6413 | 1502 v:hlsearch Variable that indicates whether search highlighting is on. |
1503 Setting it makes sense only if 'hlsearch' is enabled which | |
1504 requires |+extra_search|. Setting this variable to zero acts | |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1505 like the |:nohlsearch| command, setting it to one acts like > |
5460 | 1506 let &hlsearch = &hlsearch |
6918 | 1507 < Note that the value is restored when returning from a |
1508 function. |function-search-undo|. | |
1509 | |
11 | 1510 *v:insertmode* *insertmode-variable* |
1511 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1512 events. Values: | |
1513 i Insert mode | |
1514 r Replace mode | |
1515 v Virtual Replace mode | |
1516 | |
102 | 1517 *v:key* *key-variable* |
685 | 1518 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1519 evaluating the expression used with |map()| and |filter()|. |
1520 Read-only. | |
1521 | |
7 | 1522 *v:lang* *lang-variable* |
1523 v:lang The current locale setting for messages of the runtime | |
1524 environment. This allows Vim scripts to be aware of the | |
1525 current language. Technical: it's the value of LC_MESSAGES. | |
1526 The value is system dependent. | |
1527 This variable can not be set directly, use the |:language| | |
1528 command. | |
1529 It can be different from |v:ctype| when messages are desired | |
1530 in a different language than what is used for character | |
1531 encoding. See |multi-lang|. | |
1532 | |
1533 *v:lc_time* *lc_time-variable* | |
1534 v:lc_time The current locale setting for time messages of the runtime | |
1535 environment. This allows Vim scripts to be aware of the | |
1536 current language. Technical: it's the value of LC_TIME. | |
1537 This variable can not be set directly, use the |:language| | |
1538 command. See |multi-lang|. | |
1539 | |
1540 *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
|
1541 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
|
1542 '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
|
1543 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
|
1544 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
|
1545 |sandbox|. |
7 | 1546 |
1029 | 1547 *v:mouse_win* *mouse_win-variable* |
1548 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1549 First window has number 1, like with |winnr()|. The value is | |
1550 zero when there was no mouse button click. | |
1551 | |
1552 *v:mouse_lnum* *mouse_lnum-variable* | |
1553 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1554 This is the text line number, not the screen line number. The | |
1555 value is zero when there was no mouse button click. | |
1556 | |
1557 *v:mouse_col* *mouse_col-variable* | |
1558 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1559 This is the screen column number, like with |virtcol()|. The | |
1560 value is zero when there was no mouse button click. | |
1561 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1562 *v:none* *none-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1563 v:none An empty String. Used to put an empty item in JSON. See |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1564 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1565 When used as a number this evaluates to zero. |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1566 When used as a string this evaluates to "none". > |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1567 echo v:none |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1568 < none ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1569 |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1570 *v:null* *null-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1571 v:null An empty String. Used to put "null" in JSON. See |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1572 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1573 When used as a number this evaluates to zero. |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1574 When used as a string this evaluates to "null". > |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1575 echo v:null |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1576 < null ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1577 |
1733 | 1578 *v:oldfiles* *oldfiles-variable* |
1579 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1580 startup. These are the files that Vim remembers marks for. | |
1581 The length of the List is limited by the ' argument of the | |
1582 'viminfo' option (default is 100). | |
5618 | 1583 When the |viminfo| file is not used the List is empty. |
1733 | 1584 Also see |:oldfiles| and |c_#<|. |
1585 The List can be modified, but this has no effect on what is | |
1586 stored in the |viminfo| file later. If you use values other | |
1587 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
|
1588 {only when compiled with the |+viminfo| feature} |
1733 | 1589 |
6935 | 1590 *v:option_new* |
1591 v:option_new New value of the option. Valid while executing an |OptionSet| | |
1592 autocommand. | |
1593 *v:option_old* | |
1594 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
1595 autocommand. | |
1596 *v:option_type* | |
1597 v:option_type Scope of the set command. Valid while executing an | |
1598 |OptionSet| autocommand. Can be either "global" or "local" | |
1490 | 1599 *v:operator* *operator-variable* |
1600 v:operator The last operator given in Normal mode. This is a single | |
1601 character except for commands starting with <g> or <z>, | |
1602 in which case it is two characters. Best used alongside | |
1603 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1604 Operator-pending mode and then use the operator, e.g.: > | |
1605 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1606 < The value remains set until another operator is entered, thus | |
1607 don't expect it to be empty. | |
1608 v:operator is not set for |:delete|, |:yank| or other Ex | |
1609 commands. | |
1610 Read-only. | |
1611 | |
7 | 1612 *v:prevcount* *prevcount-variable* |
1613 v:prevcount The count given for the last but one Normal mode command. | |
1614 This is the v:count value of the previous command. Useful if | |
1490 | 1615 you want to cancel Visual or Operator-pending mode and then |
1616 use the count, e.g.: > | |
7 | 1617 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1618 < Read-only. | |
1619 | |
170 | 1620 *v:profiling* *profiling-variable* |
1621 | 1621 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1622 See |profiling|. |
1623 | |
7 | 1624 *v:progname* *progname-variable* |
1625 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 1626 invoked. Allows you to do special initialisations for |view|, |
1627 |evim| etc., or any other name you might symlink to Vim. | |
7 | 1628 Read-only. |
1629 | |
5780 | 1630 *v:progpath* *progpath-variable* |
1631 v:progpath Contains the command with which Vim was invoked, including the | |
1632 path. Useful if you want to message a Vim server using a | |
1633 |--remote-expr|. | |
5782 | 1634 To get the full path use: > |
1635 echo exepath(v:progpath) | |
1636 < NOTE: This does not work when the command is a relative path | |
1637 and the current directory has changed. | |
5780 | 1638 Read-only. |
1639 | |
7 | 1640 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1641 v:register The name of the register in effect for the current normal mode |
3492 | 1642 command (regardless of whether that command actually used a |
1643 register). Or for the currently executing normal mode mapping | |
1644 (use this in custom commands that take a register). | |
1645 If none is supplied it is the default register '"', unless | |
1646 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
1647 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1648 Also see |getreg()| and |setreg()| |
7 | 1649 |
540 | 1650 *v:scrollstart* *scrollstart-variable* |
1651 v:scrollstart String describing the script or function that caused the | |
1652 screen to scroll up. It's only set when it is empty, thus the | |
1653 first reason is remembered. It is set to "Unknown" for a | |
1654 typed command. | |
1655 This can be used to find out why your script causes the | |
1656 hit-enter prompt. | |
1657 | |
7 | 1658 *v:servername* *servername-variable* |
1659 v:servername The resulting registered |x11-clientserver| name if any. | |
1660 Read-only. | |
1661 | |
1621 | 1662 |
1663 v:searchforward *v:searchforward* *searchforward-variable* | |
1664 Search direction: 1 after a forward search, 0 after a | |
1665 backward search. It is reset to forward when directly setting | |
1666 the last search pattern, see |quote/|. | |
1667 Note that the value is restored when returning from a | |
1668 function. |function-search-undo|. | |
1669 Read-write. | |
1670 | |
7 | 1671 *v:shell_error* *shell_error-variable* |
1672 v:shell_error Result of the last shell command. When non-zero, the last | |
1673 shell command had an error. When zero, there was no problem. | |
1674 This only works when the shell returns the error code to Vim. | |
1675 The value -1 is often used when the command could not be | |
1676 executed. Read-only. | |
1677 Example: > | |
1678 :!mv foo bar | |
1679 :if v:shell_error | |
1680 : echo 'could not rename "foo" to "bar"!' | |
1681 :endif | |
1682 < "shell_error" also works, for backwards compatibility. | |
1683 | |
1684 *v:statusmsg* *statusmsg-variable* | |
1685 v:statusmsg Last given status message. It's allowed to set this variable. | |
1686 | |
579 | 1687 *v:swapname* *swapname-variable* |
1688 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1689 the swap file found. Read-only. | |
1690 | |
1691 *v:swapchoice* *swapchoice-variable* | |
1692 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1693 for handling an existing swap file: | |
1694 'o' Open read-only | |
1695 'e' Edit anyway | |
1696 'r' Recover | |
1697 'd' Delete swapfile | |
1698 'q' Quit | |
1699 'a' Abort | |
1621 | 1700 The value should be a single-character string. An empty value |
579 | 1701 results in the user being asked, as would happen when there is |
1702 no SwapExists autocommand. The default is empty. | |
1703 | |
590 | 1704 *v:swapcommand* *swapcommand-variable* |
625 | 1705 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1706 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1707 another Vim open the file and jump to the right place. For |
590 | 1708 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1709 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1710 |
7 | 1711 *v:termresponse* *termresponse-variable* |
1712 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1713 termcap entry. It is set when Vim receives an escape sequence |
7 | 1714 that starts with ESC [ or CSI and ends in a 'c', with only |
1715 digits, ';' and '.' in between. | |
1716 When this option is set, the TermResponse autocommand event is | |
1717 fired, so that you can react to the response from the | |
1718 terminal. | |
1719 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1720 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1721 patch level (since this was introduced in patch 95, it's | |
1722 always 95 or bigger). Pc is always zero. | |
1723 {only when compiled with |+termresponse| feature} | |
1724 | |
1725 *v:this_session* *this_session-variable* | |
1726 v:this_session Full filename of the last loaded or saved session file. See | |
1727 |:mksession|. It is allowed to set this variable. When no | |
1728 session file has been saved, this variable is empty. | |
1729 "this_session" also works, for backwards compatibility. | |
1730 | |
1731 *v:throwpoint* *throwpoint-variable* | |
1732 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1733 finished was thrown. Not set when commands are typed. See |
7 | 1734 also |v:exception| and |throw-variables|. |
1735 Example: > | |
1736 :try | |
1737 : throw "oops" | |
1738 :catch /.*/ | |
1739 : echo "Exception from" v:throwpoint | |
1740 :endtry | |
1741 < Output: "Exception from test.vim, line 2" | |
1742 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1743 *v:true* *true-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1744 v:true A Number with value one. Used to put "true" in JSON. See |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1745 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1746 When used as a string this evaluates to "true". > |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1747 echo v:true |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1748 < true ~ |
102 | 1749 *v:val* *val-variable* |
1621 | 1750 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1751 valid while evaluating the expression used with |map()| and |
102 | 1752 |filter()|. Read-only. |
1753 | |
7 | 1754 *v:version* *version-variable* |
1755 v:version Version number of Vim: Major version number times 100 plus | |
1756 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1757 is 501. Read-only. "version" also works, for backwards | |
1758 compatibility. | |
1759 Use |has()| to check if a certain patch was included, e.g.: > | |
5786 | 1760 if has("patch-7.4.123") |
7 | 1761 < Note that patch numbers are specific to the version, thus both |
1762 version 5.0 and 5.1 may have a patch 123, but these are | |
1763 completely different. | |
1764 | |
1765 *v:warningmsg* *warningmsg-variable* | |
1766 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1767 | |
2609 | 1768 *v:windowid* *windowid-variable* |
1769 v:windowid When any X11 based GUI is running or when running in a | |
1770 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1771 set to the window ID. |
1772 When an MS-Windows GUI is running this will be set to the | |
1773 window handle. | |
1774 Otherwise the value is zero. | |
1775 Note: for windows inside Vim use |winnr()|. | |
2609 | 1776 |
7 | 1777 ============================================================================== |
1778 4. Builtin Functions *functions* | |
1779 | |
1780 See |function-list| for a list grouped by what the function is used for. | |
1781 | |
236 | 1782 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1783 |
1784 USAGE RESULT DESCRIPTION ~ | |
1785 | |
1621 | 1786 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
|
1787 acos( {expr}) Float arc cosine of {expr} |
685 | 1788 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
|
1789 alloc_fail( {id}, {countdown}, {repeat}) |
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1790 none make memory allocation fail |
3214 | 1791 and( {expr}, {expr}) Number bitwise AND |
55 | 1792 append( {lnum}, {string}) Number append {string} below line {lnum} |
161 | 1793 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1794 argc() Number number of files in the argument list |
55 | 1795 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
|
1796 arglistid( [{winnr} [, {tabnr}]]) |
5942 | 1797 Number argument list id |
7 | 1798 argv( {nr}) String {nr} entry of the argument list |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1799 argv() List the argument list |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1800 assert_equal( {exp}, {act} [, {msg}]) none assert {exp} equals {act} |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1801 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
|
1802 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
|
1803 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
|
1804 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
|
1805 asin( {expr}) Float arc sine of {expr} |
1621 | 1806 atan( {expr}) Float arc tangent of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1807 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
7 | 1808 browse( {save}, {title}, {initdir}, {default}) |
1809 String put up a file requester | |
1621 | 1810 browsedir( {title}, {initdir}) String put up a directory requester |
7 | 1811 bufexists( {expr}) Number TRUE if buffer {expr} exists |
55 | 1812 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
1813 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
7 | 1814 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
|
1815 bufnr( {expr} [, {create}]) Number Number of the buffer {expr} |
7 | 1816 bufwinnr( {expr}) Number window number of buffer {expr} |
1817 byte2line( {byte}) Number line number at byte count {byte} | |
55 | 1818 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
5413 | 1819 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
102 | 1820 call( {func}, {arglist} [, {dict}]) |
1821 any call {func} with arguments {arglist} | |
1621 | 1822 ceil( {expr}) Float round {expr} up |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1823 ch_close( {handle}) none close {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1824 ch_evalexpr( {handle}, {expr} [, {options}]) |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1825 any evaluate {expr} on JSON {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1826 ch_evalraw( {handle}, {string} [, {options}]) |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1827 any evaluate {string} on raw {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1828 ch_getbufnr( {handle}, {what}) Number get buffer number for {handle}/{what} |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1829 ch_getjob( {channel}) Job get the Job of {channel} |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
1830 ch_info( {handle}) String info about channel {handle} |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1831 ch_log( {msg} [, {handle}]) none write {msg} in the channel log file |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1832 ch_logfile( {fname} [, {mode}]) none start logging channel activity |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1833 ch_open( {address} [, {options}]) Channel open a channel to {address} |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1834 ch_read( {handle} [, {options}]) String read from {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1835 ch_readraw( {handle} [, {options}]) String read raw from {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1836 ch_sendexpr( {handle}, {expr} [, {options}]) |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1837 any send {expr} over JSON {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1838 ch_sendraw( {handle}, {string} [, {options}]) |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1839 any send {string} over raw {handle} |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1840 ch_setoptions( {handle}, {options}) none set options for {handle} |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
1841 ch_status( {handle}) String status of channel {handle} |
1621 | 1842 changenr() Number current change number |
4051 | 1843 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
55 | 1844 cindent( {lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1845 clearmatches() none clear all matches |
7 | 1846 col( {expr}) Number column nr of cursor or mark |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1847 complete( {startcol}, {matches}) none set Insert mode completion |
464 | 1848 complete_add( {expr}) Number add completion match |
1621 | 1849 complete_check() Number check for key typed during completion |
7 | 1850 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
1851 Number number of choice picked by user | |
55 | 1852 copy( {expr}) any make a shallow copy of {expr} |
1621 | 1853 cos( {expr}) Float cosine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1854 cosh( {expr}) Float hyperbolic cosine of {expr} |
6259 | 1855 count( {list}, {expr} [, {ic} [, {start}]]) |
95 | 1856 Number count how many {expr} are in {list} |
7 | 1857 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
1858 Number checks existence of cscope connection | |
6385 | 1859 cursor( {lnum}, {col} [, {off}]) |
1860 Number move cursor to {lnum}, {col}, {off} | |
703 | 1861 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
|
1862 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
|
1863 delete( {fname} [, {flags}]) Number delete the file or directory {fname} |
7 | 1864 did_filetype() Number TRUE if FileType autocommand event used |
55 | 1865 diff_filler( {lnum}) Number diff filler lines about {lnum} |
1866 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1867 disable_char_avail_for_testing( {expr}) none test without typeahead |
85 | 1868 empty( {expr}) Number TRUE if {expr} is empty |
7 | 1869 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
205 | 1870 eval( {string}) any evaluate {string} into its value |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1871 eventhandler() Number TRUE if inside an event handler |
7 | 1872 executable( {expr}) Number 1 if executable {expr} exists |
5782 | 1873 exepath( {expr}) String full path of the command {expr} |
7 | 1874 exists( {expr}) Number TRUE if {expr} exists |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1875 extend( {expr1}, {expr2} [, {expr3}]) |
824 | 1876 List/Dict insert items of {expr2} into {expr1} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1877 exp( {expr}) Float exponential of {expr} |
3398 | 1878 expand( {expr} [, {nosuf} [, {list}]]) |
1879 any expand special keywords in {expr} | |
1621 | 1880 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
7 | 1881 filereadable( {file}) Number TRUE if {file} is a readable file |
824 | 1882 filewritable( {file}) Number TRUE if {file} is a writable file |
102 | 1883 filter( {expr}, {string}) List/Dict remove items from {expr} where |
1884 {string} is 0 | |
95 | 1885 finddir( {name}[, {path}[, {count}]]) |
824 | 1886 String find directory {name} in {path} |
19 | 1887 findfile( {name}[, {path}[, {count}]]) |
824 | 1888 String find file {name} in {path} |
1621 | 1889 float2nr( {expr}) Number convert Float {expr} to a Number |
1890 floor( {expr}) Float round {expr} down | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1891 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
1586 | 1892 fnameescape( {fname}) String escape special characters in {fname} |
7 | 1893 fnamemodify( {fname}, {mods}) String modify file name |
55 | 1894 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
1895 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
7 | 1896 foldlevel( {lnum}) Number fold level at {lnum} |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1897 foldtext() String line displayed for closed fold |
824 | 1898 foldtextresult( {lnum}) String text for closed fold at {lnum} |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1899 foreground() Number bring the Vim window to the foreground |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
1900 function({name} [, {arglist}] [, {dict}]) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
1901 Funcref reference to function {name} |
3224 | 1902 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
82 | 1903 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
102 | 1904 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
435 | 1905 getbufline( {expr}, {lnum} [, {end}]) |
1906 List lines {lnum} to {end} of buffer {expr} | |
4157 | 1907 getbufvar( {expr}, {varname} [, {def}]) |
1908 any variable {varname} in buffer {expr} | |
55 | 1909 getchar( [expr]) Number get one character from the user |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1910 getcharmod() Number modifiers for the last typed character |
7013 | 1911 getcharsearch() Dict last character search |
7 | 1912 getcmdline() String return the current command-line |
1913 getcmdpos() Number return cursor position in command-line | |
6153 | 1914 getcmdtype() String return current command-line type |
1915 getcmdwintype() String return current command-line window type | |
5944 | 1916 getcurpos() List position of the cursor |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1917 getcwd( [{winnr} [, {tabnr}]]) String get the current working directory |
5944 | 1918 getfontname( [{name}]) String name of font being used |
20 | 1919 getfperm( {fname}) String file permissions of file {fname} |
1920 getfsize( {fname}) Number size in bytes of file {fname} | |
7 | 1921 getftime( {fname}) Number last modification time of file |
20 | 1922 getftype( {fname}) String description of type of file {fname} |
161 | 1923 getline( {lnum}) String line {lnum} of current buffer |
1924 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
|
1925 getloclist( {nr}) List list of location list items |
1326 | 1926 getmatches() List list of current matches |
1548 | 1927 getpid() Number process ID of Vim |
703 | 1928 getpos( {expr}) List position of cursor, mark, etc. |
230 | 1929 getqflist() List list of quickfix items |
5796 | 1930 getreg( [{regname} [, 1 [, {list}]]]) |
1931 String or List contents of register | |
55 | 1932 getregtype( [{regname}]) String type of register |
4157 | 1933 gettabvar( {nr}, {varname} [, {def}]) |
1934 any variable {varname} in tab {nr} or {def} | |
1935 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
831 | 1936 any {name} in {winnr} in tab page {tabnr} |
7 | 1937 getwinposx() Number X coord in pixels of GUI Vim window |
1938 getwinposy() Number Y coord in pixels of GUI Vim window | |
4157 | 1939 getwinvar( {nr}, {varname} [, {def}]) |
1940 any variable {varname} in window {nr} | |
6663 | 1941 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
3398 | 1942 any expand file wildcards in {expr} |
6697 | 1943 glob2regpat( {expr}) String convert a glob pat into a search pat |
6663 | 1944 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
1754 | 1945 String do glob({expr}) for all dirs in {path} |
7 | 1946 has( {feature}) Number TRUE if feature {feature} supported |
102 | 1947 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1948 haslocaldir( [{winnr} [, {tabnr}]]) |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1949 Number TRUE if the window executed |:lcd| |
782 | 1950 hasmapto( {what} [, {mode} [, {abbr}]]) |
1951 Number TRUE if mapping to {what} exists | |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1952 histadd( {history}, {item}) String add an item to a history |
7 | 1953 histdel( {history} [, {item}]) String remove an item from a history |
1954 histget( {history} [, {index}]) String get the item {index} from a history | |
1955 histnr( {history}) Number highest index of a history | |
1956 hlexists( {name}) Number TRUE if highlight group {name} exists | |
1957 hlID( {name}) Number syntax ID of highlight group {name} | |
1958 hostname() String name of the machine Vim is running on | |
55 | 1959 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
1960 indent( {lnum}) Number indent of line {lnum} | |
95 | 1961 index( {list}, {expr} [, {start} [, {ic}]]) |
1962 Number index in {list} where {expr} appears | |
531 | 1963 input( {prompt} [, {text} [, {completion}]]) |
1964 String get input from the user | |
7 | 1965 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
824 | 1966 inputlist( {textlist}) Number let the user pick from a choice list |
55 | 1967 inputrestore() Number restore typeahead |
1968 inputsave() Number save and clear typeahead | |
7 | 1969 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
55 | 1970 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
3214 | 1971 invert( {expr}) Number bitwise invert |
7 | 1972 isdirectory( {directory}) Number TRUE if {directory} is a directory |
148 | 1973 islocked( {expr}) Number TRUE if {expr} is locked |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
1974 isnan( {expr}) Number TRUE if {expr} is NaN |
685 | 1975 items( {dict}) List key-value pairs in {dict} |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1976 job_getchannel( {job}) Channel get the channel handle for {job} |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
1977 job_info( {job}) Dict get information about {job} |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1978 job_setoptions( {job}, {options}) none set options for {job} |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1979 job_start( {command} [, {options}]) Job start a job |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1980 job_status( {job}) String get the status of {job} |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
1981 job_stop( {job} [, {how}]) Number stop {job} |
95 | 1982 join( {list} [, {sep}]) String join {list} items into one String |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
1983 js_decode( {string}) any decode JS style JSON |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
1984 js_encode( {expr}) String encode JS style JSON |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
1985 json_decode( {string}) any decode JSON |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
1986 json_encode( {expr}) String encode JSON |
685 | 1987 keys( {dict}) List keys in {dict} |
55 | 1988 len( {expr}) Number the length of {expr} |
1989 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
7 | 1990 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
1991 line( {expr}) Number line nr of cursor, last line or mark | |
1992 line2byte( {lnum}) Number byte count of line {lnum} | |
55 | 1993 lispindent( {lnum}) Number Lisp indent for line {lnum} |
7 | 1994 localtime() Number current time |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1995 log( {expr}) Float natural logarithm (base e) of {expr} |
1621 | 1996 log10( {expr}) Float logarithm of Float {expr} to base 10 |
3492 | 1997 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
102 | 1998 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
2610 | 1999 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 2000 String or Dict |
2001 rhs of mapping {name} in mode {mode} | |
782 | 2002 mapcheck( {name}[, {mode} [, {abbr}]]) |
2003 String check for mappings matching {name} | |
19 | 2004 match( {expr}, {pat}[, {start}[, {count}]]) |
7 | 2005 Number position where {pat} matches in {expr} |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2006 matchadd( {group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
1326 | 2007 Number highlight {pattern} with {group} |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2008 matchaddpos( {group}, {pos}[, {priority}[, {id}[, {dict}]]]) |
5979 | 2009 Number highlight positions with {group} |
819 | 2010 matcharg( {nr}) List arguments of |:match| |
1326 | 2011 matchdelete( {id}) Number delete match identified by {id} |
19 | 2012 matchend( {expr}, {pat}[, {start}[, {count}]]) |
7 | 2013 Number position where {pat} ends in {expr} |
158 | 2014 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
2015 List match and submatches of {pat} in {expr} | |
19 | 2016 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
2017 String {count}'th match of {pat} in {expr} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2018 max( {list}) Number maximum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2019 min( {list}) Number minimum value of items in {list} |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2020 mkdir( {name} [, {path} [, {prot}]]) |
168 | 2021 Number create directory {name} |
1621 | 2022 mode( [expr]) String current editing mode |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
2023 mzeval( {expr}) any evaluate |MzScheme| expression |
7 | 2024 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
4051 | 2025 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
3214 | 2026 or( {expr}, {expr}) Number bitwise OR |
819 | 2027 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
|
2028 perleval( {expr}) any evaluate |Perl| expression |
1621 | 2029 pow( {x}, {y}) Float {x} to the power of {y} |
7 | 2030 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
1621 | 2031 printf( {fmt}, {expr1}...) String format text |
2032 pumvisible() Number whether popup menu is visible | |
3682 | 2033 pyeval( {expr}) any evaluate |Python| expression |
2034 py3eval( {expr}) any evaluate |python3| expression | |
99 | 2035 range( {expr} [, {max} [, {stride}]]) |
2036 List items from {expr} to {max} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2037 readfile( {fname} [, {binary} [, {max}]]) |
168 | 2038 List get list of lines from file {fname} |
794 | 2039 reltime( [{start} [, {end}]]) List get time value |
2040 reltimestr( {time}) String turn time value into a String | |
7 | 2041 remote_expr( {server}, {string} [, {idvar}]) |
2042 String send expression | |
2043 remote_foreground( {server}) Number bring Vim server to the foreground | |
2044 remote_peek( {serverid} [, {retvar}]) | |
2045 Number check for reply string | |
2046 remote_read( {serverid}) String read reply string | |
2047 remote_send( {server}, {string} [, {idvar}]) | |
2048 String send key sequence | |
79 | 2049 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
856 | 2050 remove( {dict}, {key}) any remove entry {key} from {dict} |
55 | 2051 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
2052 repeat( {expr}, {count}) String repeat {expr} {count} times | |
2053 resolve( {filename}) String get filename a shortcut points to | |
82 | 2054 reverse( {list}) List reverse {list} in-place |
1621 | 2055 round( {expr}) Float round off {expr} |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
2056 screenattr( {row}, {col}) Number attribute at screen position |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
2057 screenchar( {row}, {col}) Number character at screen position |
3986 | 2058 screencol() Number current cursor column |
2059 screenrow() Number current cursor row | |
1496 | 2060 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
2061 Number search for {pattern} | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2062 searchdecl( {name} [, {global} [, {thisblock}]]) |
1621 | 2063 Number search for variable declaration |
1496 | 2064 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 2065 Number search for other end of start/end pair |
1496 | 2066 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 2067 List search for other end of start/end pair |
1496 | 2068 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 2069 List search for {pattern} |
7 | 2070 server2client( {clientid}, {string}) |
2071 Number send reply string | |
2072 serverlist() String get a list of available servers | |
2073 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
6991 | 2074 setcharsearch( {dict}) Dict set character search from {dict} |
7 | 2075 setcmdpos( {pos}) Number set cursor position in command-line |
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
2076 setfperm( {fname}, {mode}) Number set {fname} file permissions to {mode} |
7 | 2077 setline( {lnum}, {line}) Number set line {lnum} to {line} |
647 | 2078 setloclist( {nr}, {list}[, {action}]) |
2079 Number modify location list using {list} | |
1326 | 2080 setmatches( {list}) Number restore a list of matches |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2081 setpos( {expr}, {list}) Number set the {expr} position to {list} |
647 | 2082 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
55 | 2083 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
|
2084 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
831 | 2085 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
2086 {winnr} in tab page {tabnr} to {val} | |
7 | 2087 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
4126 | 2088 sha256( {string}) String SHA256 checksum of {string} |
1661 | 2089 shellescape( {string} [, {special}]) |
2090 String escape {string} for use as shell | |
985 | 2091 command argument |
3875 | 2092 shiftwidth() Number effective value of 'shiftwidth' |
55 | 2093 simplify( {filename}) String simplify filename as much as possible |
1621 | 2094 sin( {expr}) Float sine of {expr} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2095 sinh( {expr}) Float hyperbolic sine of {expr} |
2902 | 2096 sort( {list} [, {func} [, {dict}]]) |
2097 List sort {list}, using {func} to compare | |
374 | 2098 soundfold( {word}) String sound-fold {word} |
344 | 2099 spellbadword() String badly spelled word at cursor |
537 | 2100 spellsuggest( {word} [, {max} [, {capital}]]) |
2101 List spelling suggestions | |
282 | 2102 split( {expr} [, {pat} [, {keepempty}]]) |
685 | 2103 List make |List| from {pat} separated {expr} |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2104 sqrt( {expr}) Float square root of {expr} |
1621 | 2105 str2float( {expr}) Float convert String to Float |
2106 str2nr( {expr} [, {base}]) Number convert String to Number | |
6870 | 2107 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
2108 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
7 | 2109 strftime( {format}[, {time}]) String time in specified format |
133 | 2110 stridx( {haystack}, {needle}[, {start}]) |
2111 Number index of {needle} in {haystack} | |
95 | 2112 string( {expr}) String String representation of {expr} value |
7 | 2113 strlen( {expr}) Number length of the String {expr} |
2114 strpart( {src}, {start}[, {len}]) | |
2115 String {len} characters of {src} at {start} | |
140 | 2116 strridx( {haystack}, {needle} [, {start}]) |
2117 Number last index of {needle} in {haystack} | |
7 | 2118 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
|
2119 strwidth( {expr}) Number display cell length of the String {expr} |
5794 | 2120 submatch( {nr}[, {list}]) String or List |
2121 specific match in ":s" or substitute() | |
7 | 2122 substitute( {expr}, {pat}, {sub}, {flags}) |
2123 String all {pat} in {expr} replaced with {sub} | |
32 | 2124 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
7 | 2125 synIDattr( {synID}, {what} [, {mode}]) |
2126 String attribute {what} of syntax ID {synID} | |
2127 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2128 synconcealed( {lnum}, {col}) List info about concealing |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2129 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
24 | 2130 system( {expr} [, {input}]) String output of shell command/filter {expr} |
5808 | 2131 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
677 | 2132 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
2133 tabpagenr( [{arg}]) Number number of current or last tab page | |
2134 tabpagewinnr( {tabarg}[, {arg}]) | |
2135 Number number of current window in tab page | |
2136 taglist( {expr}) List list of tags matching {expr} | |
1621 | 2137 tagfiles() List tags files used |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2138 tan( {expr}) Float tangent of {expr} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2139 tanh( {expr}) Float hyperbolic tangent of {expr} |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2140 tempname() String name for a temporary file |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2141 timer_start( {time}, {callback} [, {options}]) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2142 Number create a timer |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2143 timer_stop( {timer}) none stop a timer |
7 | 2144 tolower( {expr}) String the String {expr} switched to lowercase |
2145 toupper( {expr}) String the String {expr} switched to uppercase | |
15 | 2146 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
2147 to chars in {tostr} | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2148 trunc( {expr}) Float truncate Float {expr} |
7 | 2149 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
|
2150 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
|
2151 undotree() List undo file tree |
5747 | 2152 uniq( {list} [, {func} [, {dict}]]) |
2153 List remove adjacent duplicates from a list | |
685 | 2154 values( {dict}) List values in {dict} |
7 | 2155 virtcol( {expr}) Number screen column of cursor or mark |
2156 visualmode( [expr]) String last visual mode used | |
4151 | 2157 wildmenumode() Number whether 'wildmenu' mode is active |
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
2158 win_findbuf( {bufnr}) List find windows containing {bufnr} |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
2159 win_getid( [{win} [, {tab}]]) Number get window ID for {win} in {tab} |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
2160 win_gotoid( {expr}) Number go to window with ID {expr} |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
2161 win_id2tabwin( {expr}) List get tab and window nr from window ID |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
2162 win_id2win( {expr}) Number get window nr from window ID |
7 | 2163 winbufnr( {nr}) Number buffer number of window {nr} |
2164 wincol() Number window column of the cursor | |
2165 winheight( {nr}) Number height of window {nr} | |
2166 winline() Number window line of the cursor | |
674 | 2167 winnr( [{expr}]) Number number of current window |
55 | 2168 winrestcmd() String returns command to restore window sizes |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2169 winrestview( {dict}) none restore view of current window |
712 | 2170 winsaveview() Dict save view of current window |
7 | 2171 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
|
2172 wordcount() Dict get byte/char/word statistics |
6341 | 2173 writefile( {list}, {fname} [, {flags}]) |
158 | 2174 Number write list of lines to file {fname} |
3214 | 2175 xor( {expr}, {expr}) Number bitwise XOR |
7 | 2176 |
1621 | 2177 abs({expr}) *abs()* |
2178 Return the absolute value of {expr}. When {expr} evaluates to | |
2179 a |Float| abs() returns a |Float|. When {expr} can be | |
2180 converted to a |Number| abs() returns a |Number|. Otherwise | |
2181 abs() gives an error message and returns -1. | |
2182 Examples: > | |
2183 echo abs(1.456) | |
2184 < 1.456 > | |
2185 echo abs(-5.456) | |
2186 < 5.456 > | |
2187 echo abs(-4) | |
2188 < 4 | |
2189 {only available when compiled with the |+float| feature} | |
2190 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2191 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2192 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2193 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
|
2194 |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
|
2195 {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
|
2196 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2197 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2198 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2199 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2200 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2201 < 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
|
2202 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2203 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2204 |
82 | 2205 add({list}, {expr}) *add()* |
685 | 2206 Append the item {expr} to |List| {list}. Returns the |
2207 resulting |List|. Examples: > | |
82 | 2208 :let alist = add([1, 2, 3], item) |
2209 :call add(mylist, "woodstock") | |
685 | 2210 < Note that when {expr} is a |List| it is appended as a single |
692 | 2211 item. Use |extend()| to concatenate |Lists|. |
85 | 2212 Use |insert()| to add an item at another position. |
55 | 2213 |
82 | 2214 |
7513
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2215 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
|
2216 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
|
2217 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
|
2218 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
|
2219 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
|
2220 |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2221 |
3214 | 2222 and({expr}, {expr}) *and()* |
2223 Bitwise AND on the two arguments. The arguments are converted | |
2224 to a number. A List, Dict or Float argument causes an error. | |
2225 Example: > | |
2226 :let flag = and(bits, 0x80) | |
2227 | |
2228 | |
82 | 2229 append({lnum}, {expr}) *append()* |
685 | 2230 When {expr} is a |List|: Append each item of the |List| as a |
2231 text line below line {lnum} in the current buffer. | |
153 | 2232 Otherwise append {expr} as one text line below line {lnum} in |
2233 the current buffer. | |
2234 {lnum} can be zero to insert a line before the first one. | |
82 | 2235 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2236 0 for success. Example: > |
55 | 2237 :let failed = append(line('$'), "# THE END") |
82 | 2238 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2239 < |
7 | 2240 *argc()* |
2241 argc() The result is the number of files in the argument list of the | |
2242 current window. See |arglist|. | |
2243 | |
2244 *argidx()* | |
2245 argidx() The result is the current index in the argument list. 0 is | |
2246 the first file. argc() - 1 is the last one. See |arglist|. | |
2247 | |
5942 | 2248 *arglistid()* |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2249 arglistid([{winnr} [, {tabnr}]]) |
5942 | 2250 Return the argument list ID. This is a number which |
2251 identifies the argument list being used. Zero is used for the | |
6153 | 2252 global argument list. See |arglist|. |
2253 Return -1 if the arguments are invalid. | |
5942 | 2254 |
2255 Without arguments use the current window. | |
2256 With {winnr} only use this window in the current tab page. | |
2257 With {winnr} and {tabnr} use the window in the specified tab | |
2258 page. | |
2259 | |
7 | 2260 *argv()* |
818 | 2261 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2262 current window. See |arglist|. "argv(0)" is the first one. |
2263 Example: > | |
2264 :let i = 0 | |
2265 :while i < argc() | |
1621 | 2266 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2267 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2268 : let i = i + 1 | |
2269 :endwhile | |
818 | 2270 < Without the {nr} argument a |List| with the whole |arglist| is |
2271 returned. | |
2272 | |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2273 *assert_equal()* |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2274 assert_equal({expected}, {actual} [, {msg}]) |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2275 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
|
2276 added to |v:errors|. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2277 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
|
2278 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
|
2279 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
|
2280 always matters. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2281 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
|
2282 {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
|
2283 Example: > |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2284 assert_equal('foo', 'bar') |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2285 < 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
|
2286 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
|
2287 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2288 assert_exception({error} [, {msg}]) *assert_exception()* |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2289 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
|
2290 message is added to |v:errors|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2291 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
|
2292 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
|
2293 with translations: > |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2294 try |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2295 commandthatfails |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2296 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
|
2297 catch |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2298 call assert_exception('E492:') |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2299 endtry |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2300 |
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2301 assert_fails({cmd} [, {error}]) *assert_fails()* |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2302 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
|
2303 NOT produce an error. |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2304 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
|
2305 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2306 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
|
2307 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
|
2308 |v:errors|, like with |assert_equal()|. |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2309 A value is false when it is zero. When {actual} is not a |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2310 number the assert fails. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2311 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
|
2312 got {actual}" is produced. |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2313 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2314 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
|
2315 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
|
2316 |v:errors|, like with |assert_equal()|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2317 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
|
2318 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
|
2319 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
|
2320 got {actual}" is produced. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2321 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2322 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2323 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
|
2324 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
|
2325 {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
|
2326 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2327 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2328 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2329 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2330 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2331 < -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
|
2332 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2333 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2334 |
1621 | 2335 atan({expr}) *atan()* |
2336 Return the principal value of the arc tangent of {expr}, in | |
2337 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2338 {expr} must evaluate to a |Float| or a |Number|. | |
2339 Examples: > | |
2340 :echo atan(100) | |
2341 < 1.560797 > | |
2342 :echo atan(-4.01) | |
2343 < -1.326405 | |
2344 {only available when compiled with the |+float| feature} | |
2345 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2346 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2347 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2348 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
|
2349 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
|
2350 {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
|
2351 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2352 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2353 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2354 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2355 < 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
|
2356 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2357 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2358 |
7 | 2359 *browse()* |
2360 browse({save}, {title}, {initdir}, {default}) | |
2361 Put up a file requester. This only works when "has("browse")" | |
2362 returns non-zero (only in some GUI versions). | |
2363 The input fields are: | |
2364 {save} when non-zero, select file to write | |
2365 {title} title for the requester | |
2366 {initdir} directory to start browsing in | |
2367 {default} default file name | |
2368 When the "Cancel" button is hit, something went wrong, or | |
2369 browsing is not possible, an empty string is returned. | |
2370 | |
29 | 2371 *browsedir()* |
2372 browsedir({title}, {initdir}) | |
2373 Put up a directory requester. This only works when | |
2374 "has("browse")" returns non-zero (only in some GUI versions). | |
2375 On systems where a directory browser is not supported a file | |
2376 browser is used. In that case: select a file in the directory | |
2377 to be used. | |
2378 The input fields are: | |
2379 {title} title for the requester | |
2380 {initdir} directory to start browsing in | |
2381 When the "Cancel" button is hit, something went wrong, or | |
2382 browsing is not possible, an empty string is returned. | |
2383 | |
7 | 2384 bufexists({expr}) *bufexists()* |
2385 The result is a Number, which is non-zero if a buffer called | |
2386 {expr} exists. | |
9 | 2387 If the {expr} argument is a number, buffer numbers are used. |
7 | 2388 If the {expr} argument is a string it must match a buffer name |
9 | 2389 exactly. The name can be: |
2390 - Relative to the current directory. | |
2391 - A full path. | |
1621 | 2392 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2393 - A URL name. |
7 | 2394 Unlisted buffers will be found. |
2395 Note that help files are listed by their short name in the | |
2396 output of |:buffers|, but bufexists() requires using their | |
2397 long name to be able to find them. | |
1621 | 2398 bufexists() may report a buffer exists, but to use the name |
2399 with a |:buffer| command you may need to use |expand()|. Esp | |
2400 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2401 Use "bufexists(0)" to test for the existence of an alternate |
2402 file name. | |
2403 *buffer_exists()* | |
2404 Obsolete name: buffer_exists(). | |
2405 | |
2406 buflisted({expr}) *buflisted()* | |
2407 The result is a Number, which is non-zero if a buffer called | |
2408 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2409 The {expr} argument is used like with |bufexists()|. |
7 | 2410 |
2411 bufloaded({expr}) *bufloaded()* | |
2412 The result is a Number, which is non-zero if a buffer called | |
2413 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2414 The {expr} argument is used like with |bufexists()|. |
7 | 2415 |
2416 bufname({expr}) *bufname()* | |
2417 The result is the name of a buffer, as it is displayed by the | |
2418 ":ls" command. | |
2419 If {expr} is a Number, that buffer number's name is given. | |
2420 Number zero is the alternate buffer for the current window. | |
2421 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2422 with the buffer names. This is always done like 'magic' is |
7 | 2423 set and 'cpoptions' is empty. When there is more than one |
2424 match an empty string is returned. | |
2425 "" or "%" can be used for the current buffer, "#" for the | |
2426 alternate buffer. | |
2427 A full match is preferred, otherwise a match at the start, end | |
1156 | 2428 or middle of the buffer name is accepted. If you only want a |
2429 full match then put "^" at the start and "$" at the end of the | |
2430 pattern. | |
7 | 2431 Listed buffers are found first. If there is a single match |
2432 with a listed buffer, that one is returned. Next unlisted | |
2433 buffers are searched for. | |
2434 If the {expr} is a String, but you want to use it as a buffer | |
2435 number, force it to be a Number by adding zero to it: > | |
2436 :echo bufname("3" + 0) | |
2437 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2438 string is returned. > | |
2439 bufname("#") alternate buffer name | |
2440 bufname(3) name of buffer 3 | |
2441 bufname("%") name of current buffer | |
2442 bufname("file2") name of buffer where "file2" matches. | |
2443 < *buffer_name()* | |
2444 Obsolete name: buffer_name(). | |
2445 | |
2446 *bufnr()* | |
707 | 2447 bufnr({expr} [, {create}]) |
2448 The result is the number of a buffer, as it is displayed by | |
7 | 2449 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2450 above. |
2451 If the buffer doesn't exist, -1 is returned. Or, if the | |
2452 {create} argument is present and not zero, a new, unlisted, | |
2453 buffer is created and its number is returned. | |
7 | 2454 bufnr("$") is the last buffer: > |
2455 :let last_buffer = bufnr("$") | |
2456 < The result is a Number, which is the highest buffer number | |
2457 of existing buffers. Note that not all buffers with a smaller | |
2458 number necessarily exist, because ":bwipeout" may have removed | |
2459 them. Use bufexists() to test for the existence of a buffer. | |
2460 *buffer_number()* | |
2461 Obsolete name: buffer_number(). | |
2462 *last_buffer_nr()* | |
2463 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2464 | |
2465 bufwinnr({expr}) *bufwinnr()* | |
2466 The result is a Number, which is the number of the first | |
2467 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2468 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2469 there is no such window, -1 is returned. Example: > |
2470 | |
2471 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2472 | |
2473 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2474 |:wincmd|. | |
1156 | 2475 Only deals with the current tab page. |
7 | 2476 |
2477 byte2line({byte}) *byte2line()* | |
2478 Return the line number that contains the character at byte | |
2479 count {byte} in the current buffer. This includes the | |
2480 end-of-line character, depending on the 'fileformat' option | |
2481 for the current buffer. The first character has byte count | |
2482 one. | |
2483 Also see |line2byte()|, |go| and |:goto|. | |
2484 {not available when compiled without the |+byte_offset| | |
2485 feature} | |
2486 | |
18 | 2487 byteidx({expr}, {nr}) *byteidx()* |
2488 Return byte index of the {nr}'th character in the string | |
2489 {expr}. Use zero for the first character, it returns zero. | |
2490 This function is only useful when there are multibyte | |
2491 characters, otherwise the returned value is equal to {nr}. | |
5413 | 2492 Composing characters are not counted separately, their byte |
2493 length is added to the preceding base character. See | |
2494 |byteidxcomp()| below for counting composing characters | |
2495 separately. | |
18 | 2496 Example : > |
2497 echo matchstr(str, ".", byteidx(str, 3)) | |
2498 < will display the fourth character. Another way to do the | |
2499 same: > | |
2500 let s = strpart(str, byteidx(str, 3)) | |
2501 echo strpart(s, 0, byteidx(s, 1)) | |
2502 < If there are less than {nr} characters -1 is returned. | |
2503 If there are exactly {nr} characters the length of the string | |
5413 | 2504 in bytes is returned. |
2505 | |
2506 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
2507 Like byteidx(), except that a composing character is counted | |
2508 as a separate character. Example: > | |
2509 let s = 'e' . nr2char(0x301) | |
2510 echo byteidx(s, 1) | |
2511 echo byteidxcomp(s, 1) | |
2512 echo byteidxcomp(s, 2) | |
2513 < The first and third echo result in 3 ('e' plus composing | |
2514 character is 3 bytes), the second echo results in 1 ('e' is | |
2515 one byte). | |
2516 Only works different from byteidx() when 'encoding' is set to | |
2517 a Unicode encoding. | |
18 | 2518 |
102 | 2519 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2520 Call function {func} with the items in |List| {arglist} as |
79 | 2521 arguments. |
685 | 2522 {func} can either be a |Funcref| or the name of a function. |
79 | 2523 a:firstline and a:lastline are set to the cursor line. |
2524 Returns the return value of the called function. | |
102 | 2525 {dict} is for functions with the "dict" attribute. It will be |
2526 used to set the local variable "self". |Dictionary-function| | |
79 | 2527 |
1621 | 2528 ceil({expr}) *ceil()* |
2529 Return the smallest integral value greater than or equal to | |
2530 {expr} as a |Float| (round up). | |
2531 {expr} must evaluate to a |Float| or a |Number|. | |
2532 Examples: > | |
2533 echo ceil(1.456) | |
2534 < 2.0 > | |
2535 echo ceil(-5.456) | |
2536 < -5.0 > | |
2537 echo ceil(4.0) | |
2538 < 4.0 | |
2539 {only available when compiled with the |+float| feature} | |
2540 | |
777 | 2541 changenr() *changenr()* |
2542 Return the number of the most recent change. This is the same | |
2543 number as what is displayed with |:undolist| and can be used | |
2544 with the |:undo| command. | |
2545 When a change was made it is the number of that change. After | |
2546 redo it is the number of the redone change. After undo it is | |
2547 one less than the number of the undone change. | |
2548 | |
4051 | 2549 char2nr({expr}[, {utf8}]) *char2nr()* |
7 | 2550 Return number value of the first char in {expr}. Examples: > |
2551 char2nr(" ") returns 32 | |
2552 char2nr("ABC") returns 65 | |
4051 | 2553 < When {utf8} is omitted or zero, the current 'encoding' is used. |
2554 Example for "utf-8": > | |
1156 | 2555 char2nr("á") returns 225 |
2556 char2nr("á"[0]) returns 195 | |
4051 | 2557 < With {utf8} set to 1, always treat as utf-8 characters. |
2558 A combining character is a separate character. | |
2965 | 2559 |nr2char()| does the opposite. |
7 | 2560 |
2561 cindent({lnum}) *cindent()* | |
2562 Get the amount of indent for line {lnum} according the C | |
2563 indenting rules, as with 'cindent'. | |
2564 The indent is counted in spaces, the value of 'tabstop' is | |
2565 relevant. {lnum} is used just like in |getline()|. | |
2566 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2567 feature, -1 is returned. | |
548 | 2568 See |C-indenting|. |
7 | 2569 |
1326 | 2570 clearmatches() *clearmatches()* |
2571 Clears all matches previously defined by |matchadd()| and the | |
2572 |:match| commands. | |
2573 | |
7 | 2574 *col()* |
24 | 2575 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2576 position given with {expr}. The accepted positions are: |
2577 . the cursor position | |
2578 $ the end of the cursor line (the result is the | |
3513 | 2579 number of bytes in the cursor line plus one) |
7 | 2580 'x position of mark x (if the mark is not set, 0 is |
2581 returned) | |
6447 | 2582 v In Visual mode: the start of the Visual area (the |
2583 cursor is the end). When not in Visual mode | |
2584 returns the cursor position. Differs from |'<| in | |
2585 that it's updated right away. | |
1317 | 2586 Additionally {expr} can be [lnum, col]: a |List| with the line |
2587 and column number. Most useful when the column is "$", to get | |
1621 | 2588 the last column of a specific line. When "lnum" or "col" is |
1317 | 2589 out of range then col() returns zero. |
1156 | 2590 To get the line number use |line()|. To get both use |
703 | 2591 |getpos()|. |
7 | 2592 For the screen column position use |virtcol()|. |
2593 Note that only marks in the current file can be used. | |
2594 Examples: > | |
2595 col(".") column of cursor | |
2596 col("$") length of cursor line plus one | |
2597 col("'t") column of mark t | |
2598 col("'" . markname) column of mark markname | |
1621 | 2599 < The first column is 1. 0 is returned for an error. |
1156 | 2600 For an uppercase mark the column may actually be in another |
2601 buffer. | |
7 | 2602 For the cursor position, when 'virtualedit' is active, the |
2603 column is one higher if the cursor is after the end of the | |
2604 line. This can be used to obtain the column in Insert mode: > | |
2605 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2606 \<C-O>:set ve=all<CR> | |
2607 \<C-O>:echo col(".") . "\n" <Bar> | |
2608 \let &ve = save_ve<CR> | |
2609 < | |
464 | 2610 |
724 | 2611 complete({startcol}, {matches}) *complete()* *E785* |
2612 Set the matches for Insert mode completion. | |
2613 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2614 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2615 with an expression mapping. | |
724 | 2616 {startcol} is the byte offset in the line where the completed |
2617 text start. The text up to the cursor is the original text | |
2618 that will be replaced by the matches. Use col('.') for an | |
2619 empty string. "col('.') - 1" will replace one character by a | |
2620 match. | |
2621 {matches} must be a |List|. Each |List| item is one match. | |
2622 See |complete-items| for the kind of items that are possible. | |
2623 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
|
2624 inserting anything that would cause completion to stop. |
724 | 2625 The match can be selected with CTRL-N and CTRL-P as usual with |
2626 Insert mode completion. The popup menu will appear if | |
2627 specified, see |ins-completion-menu|. | |
2628 Example: > | |
1156 | 2629 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2630 |
2631 func! ListMonths() | |
2632 call complete(col('.'), ['January', 'February', 'March', | |
2633 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2634 \ 'October', 'November', 'December']) | |
2635 return '' | |
2636 endfunc | |
2637 < This isn't very useful, but it shows how it works. Note that | |
2638 an empty string is returned to avoid a zero being inserted. | |
2639 | |
464 | 2640 complete_add({expr}) *complete_add()* |
2641 Add {expr} to the list of matches. Only to be used by the | |
2642 function specified with the 'completefunc' option. | |
2643 Returns 0 for failure (empty string or out of memory), | |
2644 1 when the match was added, 2 when the match was already in | |
2645 the list. | |
1621 | 2646 See |complete-functions| for an explanation of {expr}. It is |
786 | 2647 the same as one item in the list that 'omnifunc' would return. |
464 | 2648 |
2649 complete_check() *complete_check()* | |
2650 Check for a key typed while looking for completion matches. | |
2651 This is to be used when looking for matches takes some time. | |
2652 Returns non-zero when searching for matches is to be aborted, | |
2653 zero otherwise. | |
2654 Only to be used by the function specified with the | |
2655 'completefunc' option. | |
2656 | |
7 | 2657 *confirm()* |
2658 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2659 Confirm() offers the user a dialog, from which a choice can be | |
2660 made. It returns the number of the choice. For the first | |
2661 choice this is 1. | |
2662 Note: confirm() is only supported when compiled with dialog | |
2663 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
|
2664 |
7 | 2665 {msg} is displayed in a |dialog| with {choices} as the |
2666 alternatives. When {choices} is missing or empty, "&OK" is | |
2667 used (and translated). | |
2668 {msg} is a String, use '\n' to include a newline. Only on | |
2669 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
|
2670 |
7 | 2671 {choices} is a String, with the individual choices separated |
2672 by '\n', e.g. > | |
2673 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2674 < The letter after the '&' is the shortcut key for that choice. | |
2675 Thus you can type 'c' to select "Cancel". The shortcut does | |
2676 not need to be the first letter: > | |
2677 confirm("file has been modified", "&Save\nSave &All") | |
2678 < For the console, the first letter of each choice is used as | |
2679 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
|
2680 |
7 | 2681 The optional {default} argument is the number of the choice |
2682 that is made if the user hits <CR>. Use 1 to make the first | |
2683 choice the default one. Use 0 to not set a default. If | |
2684 {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
|
2685 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2686 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
|
2687 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
|
2688 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
|
2689 "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
|
2690 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
|
2691 |
7 | 2692 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2693 or another valid interrupt key, confirm() returns 0. | |
2694 | |
2695 An example: > | |
2696 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2697 :if choice == 0 | |
2698 : echo "make up your mind!" | |
2699 :elseif choice == 3 | |
2700 : echo "tasteful" | |
2701 :else | |
2702 : echo "I prefer bananas myself." | |
2703 :endif | |
2704 < In a GUI dialog, buttons are used. The layout of the buttons | |
2705 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2706 the buttons are always put vertically. Otherwise, confirm() |
7 | 2707 tries to put the buttons in one horizontal line. If they |
2708 don't fit, a vertical layout is used anyway. For some systems | |
2709 the horizontal layout is always used. | |
2710 | |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2711 ch_close({handle}) *ch_close()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2712 Close {handle}. See |channel-close|. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2713 {handle} can be Channel or a Job that has a Channel. |
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2714 |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2715 Note that a channel is closed in three stages: |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2716 - The I/O ends, log message: "Closing channel". There can |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2717 still be queued messages to read or callbacks to invoke. |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2718 - The readahead is cleared, log message: "Clearing channel". |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2719 Some variables may still reference the channel. |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2720 - The channel is freed, log message: "Freeing channel". |
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2721 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2722 {only available when compiled with the |+channel| feature} |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2723 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2724 ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2725 Send {expr} over {handle}. The {expr} is encoded |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2726 according to the type of channel. The function cannot be used |
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8291
diff
changeset
|
2727 with a raw channel. See |channel-use|. |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2728 {handle} can be Channel or a Job that has a Channel. |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2729 *E917* |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2730 {options} must be a Dictionary. It must not have a "callback" |
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2731 entry. It can have a "timeout" entry. |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2732 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2733 ch_evalexpr() waits for a response and returns the decoded |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2734 expression. When there is an error or timeout it returns an |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2735 empty string. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2736 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2737 {only available when compiled with the |+channel| feature} |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2738 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2739 ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2740 Send {string} over {handle}. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2741 {handle} can be Channel or a Job that has a Channel. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2742 |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2743 Works like |ch_evalexpr()|, but does not encode the request or |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2744 decode the response. The caller is responsible for the |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2745 correct contents. Also does not add a newline for a channel |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2746 in NL mode, the caller must do that. The NL in the response |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2747 is removed. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2748 See |channel-use|. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2749 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2750 {only available when compiled with the |+channel| feature} |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2751 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2752 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2753 Get the buffer number that {handle} is using for {what}. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2754 {handle} can be Channel or a Job that has a Channel. |
8291
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2755 {what} can be "err" for stderr, "out" for stdout or empty for |
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2756 socket output. |
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2757 Returns -1 when there is no buffer. |
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2758 {only available when compiled with the |+channel| feature} |
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2759 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2760 ch_getjob({channel}) *ch_getjob()* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2761 Get the Job associated with {channel}. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2762 If there is no job calling |job_status()| on the returned Job |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2763 will result in "fail". |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2764 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2765 {only available when compiled with the |+channel| and |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2766 |+job| features} |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2767 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2768 ch_info({handle}) *ch_info()* |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2769 Returns a Dictionary with information about {handle}. The |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2770 items are: |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2771 "id" number of the channel |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2772 "status" "open" (any part is open) or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2773 When opened with ch_open(): |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2774 "hostname" the hostname of the address |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2775 "port" the port of the address |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2776 "sock_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2777 "sock_mode" "NL", "RAW", "JSON" or "JS" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2778 "sock_io" "socket" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2779 "sock_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2780 When opened with job_start(): |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2781 "out_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2782 "out_mode" "NL", "RAW", "JSON" or "JS" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2783 "out_io" "null", "pipe", "file" or "buffer" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2784 "out_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2785 "err_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2786 "err_mode" "NL", "RAW", "JSON" or "JS" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2787 "err_io" "out", "null", "pipe", "file" or "buffer" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2788 "err_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2789 "in_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2790 "in_mode" "NL", "RAW", "JSON" or "JS" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2791 "in_io" "null", "pipe", "file" or "buffer" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2792 "in_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2793 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2794 ch_log({msg} [, {handle}]) *ch_log()* |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2795 Write {msg} in the channel log file, if it was opened with |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2796 |ch_logfile()|. |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2797 When {handle} is passed the channel number is used for the |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2798 message. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2799 {handle} can be Channel or a Job that has a Channel. The |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2800 Channel must open. |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2801 |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2802 ch_logfile({fname} [, {mode}]) *ch_logfile()* |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2803 Start logging channel activity to {fname}. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2804 When {fname} is an empty string: stop logging. |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2805 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2806 When {mode} is omitted or "a" append to the file. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2807 When {mode} is "w" start with an empty file. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2808 |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2809 The file is flushed after every message, on Unix you can use |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2810 "tail -f" to see what is going on in real time. |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2811 |
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2812 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2813 ch_open({address} [, {options}]) *ch_open()* |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2814 Open a channel to {address}. See |channel|. |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2815 Returns a Channel. Use |ch_status()| to check for |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2816 failure. |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2817 |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2818 {address} has the form "hostname:port", e.g., |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2819 "localhost:8765". |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2820 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2821 If {options} is given it must be a |Dictionary|. The optional |
7935
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2822 items are: |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
2823 mode "raw", "js" or "json". |
7935
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2824 Default "json". |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2825 callback function to call for requests with a zero |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2826 sequence number. See |channel-callback|. |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2827 Default: none. |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2828 waittime Specify connect timeout as milliseconds. |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2829 Negative means forever. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2830 Default: 0 (don't wait) |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2831 timeout Specify response read timeout value in |
7935
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2832 milliseconds. |
3f2e0b62003d
commit https://github.com/vim/vim/commit/4d919d748e4e435edb135aa5ccf6ee7de9212023
Christian Brabandt <cb@256bit.org>
parents:
7924
diff
changeset
|
2833 Default: 2000. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2834 {only available when compiled with the |+channel| feature} |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2835 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2836 ch_read({handle} [, {options}]) *ch_read()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2837 Read from {handle} and return the received message. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2838 {handle} can be Channel or a Job that has a Channel. |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2839 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2840 This uses the channel timeout. When there is nothing to read |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2841 within that time an empty string is returned. To specify a |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2842 different timeout in msec use the "timeout" option: |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2843 {"timeout": 123} ~ |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2844 To read from the error output use the "part" option: |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2845 {"part": "err"} ~ |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2846 To read a message with a specific ID, on a JS or JSON channel: |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2847 {"id": 99} ~ |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2848 When no ID is specified or the ID is -1, the first message is |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2849 returned. This overrules any callback waiting for this |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2850 message. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2851 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2852 For a RAW channel this returns whatever is available, since |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2853 Vim does not know where a message ends. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2854 For a NL channel this returns one message. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2855 For a JS or JSON channel this returns one decoded message. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2856 This includes any sequence number. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2857 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2858 ch_readraw({handle} [, {options}]) *ch_readraw()* |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2859 Like ch_read() but for a JS and JSON channel does not decode |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2860 the message. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2861 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2862 ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2863 Send {expr} over {handle}. The {expr} is encoded |
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
2864 according to the type of channel. The function cannot be used |
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8291
diff
changeset
|
2865 with a raw channel. See |channel-use|. *E912* |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2866 {handle} can be Channel or a Job that has a Channel. |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2867 |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2868 {options} must be a Dictionary. The "callback" item is a |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2869 Funcref or the name of a function it is invoked when the |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2870 response is received. See |channel-callback|. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2871 Without "callback" the channel handler is invoked, otherwise |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2872 any received message is dropped. |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2873 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2874 {only available when compiled with the |+channel| feature} |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2875 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2876 ch_sendraw({handle}, {string} [, {options}]) *ch_sendraw()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2877 Send {string} over {handle}. |
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
2878 Works like |ch_sendexpr()|, but does not encode the request or |
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
2879 decode the response. The caller is responsible for the |
8094
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
2880 correct contents. Also does not add a newline for a channel |
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
2881 in NL mode, the caller must do that. The NL in the response |
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
2882 is removed. |
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
2883 See |channel-use|. |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2884 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2885 {only available when compiled with the |+channel| feature} |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2886 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2887 ch_setoptions({handle}, {options}) *ch_setoptions()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2888 Set options on {handle}: |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2889 "callback" the channel callback |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2890 "timeout" default read timeout in msec |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2891 "mode" mode for the whole channel |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2892 See |ch_open()| for more explanation. |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2893 {handle} can be Channel or a Job that has a Channel. |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2894 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2895 Note that changing the mode may cause queued messages to be |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2896 lost. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2897 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2898 These options cannot be changed: |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2899 "waittime" only applies to "ch_open()| |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2900 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2901 ch_status({handle}) *ch_status()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2902 Return the status of {handle}: |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2903 "fail" failed to open the channel |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2904 "open" channel can be used |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2905 "closed" channel can not be used |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2906 {handle} can be Channel or a Job that has a Channel. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2907 |
55 | 2908 *copy()* |
1621 | 2909 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2910 different from using {expr} directly. |
685 | 2911 When {expr} is a |List| a shallow copy is created. This means |
2912 that the original |List| can be changed without changing the | |
1621 | 2913 copy, and vice versa. But the items are identical, thus |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
2914 changing an item changes the contents of both |Lists|. |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
2915 A |Dictionary| is copied in a similar way as a |List|. |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
2916 Also see |deepcopy()|. |
55 | 2917 |
1621 | 2918 cos({expr}) *cos()* |
2919 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2920 {expr} must evaluate to a |Float| or a |Number|. | |
2921 Examples: > | |
2922 :echo cos(100) | |
2923 < 0.862319 > | |
2924 :echo cos(-4.01) | |
2925 < -0.646043 | |
2926 {only available when compiled with the |+float| feature} | |
2927 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2928 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2929 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2930 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
|
2931 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2932 {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
|
2933 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2934 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2935 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2936 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2937 < -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
|
2938 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2939 |
1621 | 2940 |
102 | 2941 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2942 Return the number of times an item with value {expr} appears |
685 | 2943 in |List| or |Dictionary| {comp}. |
102 | 2944 If {start} is given then start with the item with this index. |
685 | 2945 {start} can only be used with a |List|. |
79 | 2946 When {ic} is given and it's non-zero then case is ignored. |
2947 | |
2948 | |
7 | 2949 *cscope_connection()* |
2950 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2951 Checks for the existence of a |cscope| connection. If no | |
2952 parameters are specified, then the function returns: | |
2953 0, if cscope was not available (not compiled in), or | |
2954 if there are no cscope connections; | |
2955 1, if there is at least one cscope connection. | |
2956 | |
2957 If parameters are specified, then the value of {num} | |
2958 determines how existence of a cscope connection is checked: | |
2959 | |
2960 {num} Description of existence check | |
2961 ----- ------------------------------ | |
2962 0 Same as no parameters (e.g., "cscope_connection()"). | |
2963 1 Ignore {prepend}, and use partial string matches for | |
2964 {dbpath}. | |
2965 2 Ignore {prepend}, and use exact string matches for | |
2966 {dbpath}. | |
2967 3 Use {prepend}, use partial string matches for both | |
2968 {dbpath} and {prepend}. | |
2969 4 Use {prepend}, use exact string matches for both | |
2970 {dbpath} and {prepend}. | |
2971 | |
2972 Note: All string comparisons are case sensitive! | |
2973 | |
2974 Examples. Suppose we had the following (from ":cs show"): > | |
2975 | |
2976 # pid database name prepend path | |
2977 0 27664 cscope.out /usr/local | |
2978 < | |
2979 Invocation Return Val ~ | |
2980 ---------- ---------- > | |
2981 cscope_connection() 1 | |
2982 cscope_connection(1, "out") 1 | |
2983 cscope_connection(2, "out") 0 | |
2984 cscope_connection(3, "out") 0 | |
2985 cscope_connection(3, "out", "local") 1 | |
2986 cscope_connection(4, "out") 0 | |
2987 cscope_connection(4, "out", "local") 0 | |
2988 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
2989 < | |
703 | 2990 cursor({lnum}, {col} [, {off}]) *cursor()* |
2991 cursor({list}) | |
1156 | 2992 Positions the cursor at the column (byte count) {col} in the |
2993 line {lnum}. The first column is one. | |
5938 | 2994 |
703 | 2995 When there is one argument {list} this is used as a |List| |
5938 | 2996 with two, three or four item: |
2997 [{lnum}, {col}, {off}] | |
2998 [{lnum}, {col}, {off}, {curswant}] | |
6009 | 2999 This is like the return value of |getpos()| or |getcurpos()|, |
5944 | 3000 but without the first item. |
5938 | 3001 |
7 | 3002 Does not change the jumplist. |
3003 If {lnum} is greater than the number of lines in the buffer, | |
3004 the cursor will be positioned at the last line in the buffer. | |
3005 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 3006 If {col} is greater than the number of bytes in the line, |
7 | 3007 the cursor will be positioned at the last character in the |
3008 line. | |
3009 If {col} is zero, the cursor will stay in the current column. | |
5944 | 3010 If {curswant} is given it is used to set the preferred column |
6180 | 3011 for vertical movement. Otherwise {col} is used. |
6385 | 3012 |
703 | 3013 When 'virtualedit' is used {off} specifies the offset in |
3014 screen columns from the start of the character. E.g., a | |
1266 | 3015 position within a <Tab> or after the last character. |
1851 | 3016 Returns 0 when the position could be set, -1 otherwise. |
7 | 3017 |
55 | 3018 |
164 | 3019 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 3020 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 3021 different from using {expr} directly. |
685 | 3022 When {expr} is a |List| a full copy is created. This means |
3023 that the original |List| can be changed without changing the | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3024 copy, and vice versa. When an item is a |List| or |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3025 |Dictionary|, a copy for it is made, recursively. Thus |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3026 changing an item in the copy does not change the contents of |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3027 the original |List|. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3028 A |Dictionary| is copied in a similar way as a |List|. |
685 | 3029 When {noref} is omitted or zero a contained |List| or |
3030 |Dictionary| is only copied once. All references point to | |
3031 this single copy. With {noref} set to 1 every occurrence of a | |
3032 |List| or |Dictionary| results in a new copy. This also means | |
3033 that a cyclic reference causes deepcopy() to fail. | |
114 | 3034 *E724* |
3035 Nesting is possible up to 100 levels. When there is an item | |
164 | 3036 that refers back to a higher level making a deep copy with |
3037 {noref} set to 1 will fail. | |
55 | 3038 Also see |copy()|. |
3039 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3040 delete({fname} [, {flags}]) *delete()* |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3041 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
|
3042 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
|
3043 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3044 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
|
3045 {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
|
3046 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3047 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
|
3048 {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
|
3049 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
|
3050 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3051 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
|
3052 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
|
3053 |
685 | 3054 Use |remove()| to delete an item from a |List|. |
4229 | 3055 To delete a line from the buffer use |:delete|. Use |:exe| |
3056 when the line number is in a variable. | |
7 | 3057 |
3058 *did_filetype()* | |
3059 did_filetype() Returns non-zero when autocommands are being executed and the | |
3060 FileType event has been triggered at least once. Can be used | |
3061 to avoid triggering the FileType event again in the scripts | |
3062 that detect the file type. |FileType| | |
3063 When editing another file, the counter is reset, thus this | |
3064 really checks if the FileType event has been triggered for the | |
3065 current buffer. This allows an autocommand that starts | |
3066 editing another buffer to set 'filetype' and load a syntax | |
3067 file. | |
3068 | |
32 | 3069 diff_filler({lnum}) *diff_filler()* |
3070 Returns the number of filler lines above line {lnum}. | |
3071 These are the lines that were inserted at this point in | |
3072 another diff'ed window. These filler lines are shown in the | |
3073 display but don't exist in the buffer. | |
3074 {lnum} is used like with |getline()|. Thus "." is the current | |
3075 line, "'m" mark m, etc. | |
3076 Returns 0 if the current window is not in diff mode. | |
3077 | |
3078 diff_hlID({lnum}, {col}) *diff_hlID()* | |
3079 Returns the highlight ID for diff mode at line {lnum} column | |
3080 {col} (byte index). When the current line does not have a | |
3081 diff change zero is returned. | |
3082 {lnum} is used like with |getline()|. Thus "." is the current | |
3083 line, "'m" mark m, etc. | |
3084 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
3085 line. | |
3086 The highlight ID can be used with |synIDattr()| to obtain | |
3087 syntax information about the highlighting. | |
3088 | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3089 *disable_char_avail_for_testing()* |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3090 disable_char_avail_for_testing({expr}) |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3091 When {expr} is 1 the internal char_avail() function will |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3092 return FALSE. When {expr} is 0 the char_avail() function will |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3093 function normally. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3094 Only use this for a test where typeahead causes the test not |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3095 to work. E.g., to trigger the CursorMovedI autocommand event. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3096 |
85 | 3097 empty({expr}) *empty()* |
3098 Return the Number 1 if {expr} is empty, zero otherwise. | |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3099 - A |List| or |Dictionary| is empty when it does not have any |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3100 items. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3101 - A Number and Float is empty when its value is zero. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3102 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3103 - A Job is empty when it failed to start. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3104 - A Channel is empty when it is closed. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3105 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3106 For a long |List| this is much faster than comparing the |
685 | 3107 length with zero. |
85 | 3108 |
7 | 3109 escape({string}, {chars}) *escape()* |
3110 Escape the characters in {chars} that occur in {string} with a | |
3111 backslash. Example: > | |
3112 :echo escape('c:\program files\vim', ' \') | |
3113 < results in: > | |
3114 c:\\program\ files\\vim | |
1621 | 3115 < Also see |shellescape()|. |
3116 | |
3117 *eval()* | |
95 | 3118 eval({string}) Evaluate {string} and return the result. Especially useful to |
3119 turn the result of |string()| back into the original value. | |
1621 | 3120 This works for Numbers, Floats, Strings and composites of |
3121 them. Also works for |Funcref|s that refer to existing | |
3122 functions. | |
95 | 3123 |
7 | 3124 eventhandler() *eventhandler()* |
3125 Returns 1 when inside an event handler. That is that Vim got | |
3126 interrupted while waiting for the user to type a character, | |
3127 e.g., when dropping a file on Vim. This means interactive | |
3128 commands cannot be used. Otherwise zero is returned. | |
3129 | |
3130 executable({expr}) *executable()* | |
3131 This function checks if an executable with the name {expr} | |
3132 exists. {expr} must be the name of the program without any | |
10 | 3133 arguments. |
3134 executable() uses the value of $PATH and/or the normal | |
3135 searchpath for programs. *PATHEXT* | |
3136 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
3137 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 3138 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
3139 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 3140 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 3141 the name without an extension. When 'shell' looks like a |
10 | 3142 Unix shell, then the name is also tried without adding an |
3143 extension. | |
3144 On MS-DOS and MS-Windows it only checks if the file exists and | |
3145 is not a directory, not if it's really executable. | |
819 | 3146 On MS-Windows an executable in the same directory as Vim is |
3147 always found. Since this directory is added to $PATH it | |
3148 should also work to execute it |win32-PATH|. | |
7 | 3149 The result is a Number: |
3150 1 exists | |
3151 0 does not exist | |
3152 -1 not implemented on this system | |
3153 | |
5782 | 3154 exepath({expr}) *exepath()* |
3155 If {expr} is an executable and is either an absolute path, a | |
3156 relative path or found in $PATH, return the full path. | |
3157 Note that the current directory is used when {expr} starts | |
3158 with "./", which may be a problem for Vim: > | |
3159 echo exepath(v:progpath) | |
5814 | 3160 < If {expr} cannot be found in $PATH or is not executable then |
5782 | 3161 an empty string is returned. |
3162 | |
7 | 3163 *exists()* |
3164 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
3165 defined, zero otherwise. The {expr} argument is a string, | |
3166 which contains one of these: | |
3167 &option-name Vim option (only checks if it exists, | |
3168 not if it really works) | |
3169 +option-name Vim option that works. | |
3170 $ENVNAME environment variable (could also be | |
3171 done by comparing with an empty | |
3172 string) | |
3173 *funcname built-in function (see |functions|) | |
3174 or user defined function (see | |
5862 | 3175 |user-functions|). Also works for a |
3176 variable that is a Funcref. | |
7 | 3177 varname internal variable (see |
1621 | 3178 |internal-variables|). Also works |
685 | 3179 for |curly-braces-names|, |Dictionary| |
3180 entries, |List| items, etc. Beware | |
1668 | 3181 that evaluating an index may cause an |
3182 error message for an invalid | |
3183 expression. E.g.: > | |
3184 :let l = [1, 2, 3] | |
3185 :echo exists("l[5]") | |
3186 < 0 > | |
3187 :echo exists("l[xx]") | |
3188 < E121: Undefined variable: xx | |
3189 0 | |
7 | 3190 :cmdname Ex command: built-in command, user |
3191 command or command modifier |:command|. | |
3192 Returns: | |
3193 1 for match with start of a command | |
3194 2 full match with a command | |
3195 3 matches several user commands | |
3196 To check for a supported command | |
3197 always check the return value to be 2. | |
864 | 3198 :2match The |:2match| command. |
3199 :3match The |:3match| command. | |
7 | 3200 #event autocommand defined for this event |
3201 #event#pattern autocommand defined for this event and | |
3202 pattern (the pattern is taken | |
3203 literally and compared to the | |
3204 autocommand patterns character by | |
3205 character) | |
613 | 3206 #group autocommand group exists |
3207 #group#event autocommand defined for this group and | |
3208 event. | |
3209 #group#event#pattern | |
856 | 3210 autocommand defined for this group, |
613 | 3211 event and pattern. |
615 | 3212 ##event autocommand for this event is |
3213 supported. | |
7 | 3214 For checking for a supported feature use |has()|. |
3215 | |
3216 Examples: > | |
3217 exists("&shortname") | |
3218 exists("$HOSTNAME") | |
3219 exists("*strftime") | |
3220 exists("*s:MyFunc") | |
3221 exists("bufcount") | |
3222 exists(":Make") | |
613 | 3223 exists("#CursorHold") |
7 | 3224 exists("#BufReadPre#*.gz") |
613 | 3225 exists("#filetypeindent") |
3226 exists("#filetypeindent#FileType") | |
3227 exists("#filetypeindent#FileType#*") | |
615 | 3228 exists("##ColorScheme") |
7 | 3229 < There must be no space between the symbol (&/$/*/#) and the |
3230 name. | |
867 | 3231 There must be no extra characters after the name, although in |
3232 a few cases this is ignored. That may become more strict in | |
3233 the future, thus don't count on it! | |
3234 Working example: > | |
3235 exists(":make") | |
3236 < NOT working example: > | |
3237 exists(":make install") | |
859 | 3238 |
3239 < Note that the argument must be a string, not the name of the | |
3240 variable itself. For example: > | |
7 | 3241 exists(bufcount) |
3242 < This doesn't check for existence of the "bufcount" variable, | |
853 | 3243 but gets the value of "bufcount", and checks if that exists. |
7 | 3244 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3245 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3246 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
|
3247 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3248 {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
|
3249 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3250 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3251 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3252 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3253 < 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
|
3254 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3255 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3256 |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3257 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
7 | 3258 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
|
3259 'wildignorecase' applies. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3260 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3261 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
|
3262 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
|
3263 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
|
3264 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
|
3265 file name contains a space] |
7 | 3266 |
1621 | 3267 If the expansion fails, the result is an empty string. A name |
4869 | 3268 for a non-existing file is not included, unless {expr} does |
3269 not start with '%', '#' or '<', see below. | |
7 | 3270 |
3271 When {expr} starts with '%', '#' or '<', the expansion is done | |
3272 like for the |cmdline-special| variables with their associated | |
3273 modifiers. Here is a short overview: | |
3274 | |
3275 % current file name | |
3276 # alternate file name | |
3277 #n alternate file name n | |
3278 <cfile> file name under the cursor | |
3279 <afile> autocmd file name | |
3280 <abuf> autocmd buffer number (as a String!) | |
3281 <amatch> autocmd matched name | |
5734 | 3282 <sfile> sourced script file or function name |
2662 | 3283 <slnum> sourced script file line number |
7 | 3284 <cword> word under the cursor |
3285 <cWORD> WORD under the cursor | |
3286 <client> the {clientid} of the last received | |
3287 message |server2client()| | |
3288 Modifiers: | |
3289 :p expand to full path | |
3290 :h head (last path component removed) | |
3291 :t tail (last path component only) | |
3292 :r root (one extension removed) | |
3293 :e extension only | |
3294 | |
3295 Example: > | |
3296 :let &tags = expand("%:p:h") . "/tags" | |
3297 < Note that when expanding a string that starts with '%', '#' or | |
3298 '<', any following text is ignored. This does NOT work: > | |
3299 :let doesntwork = expand("%:h.bak") | |
3300 < Use this: > | |
3301 :let doeswork = expand("%:h") . ".bak" | |
3302 < Also note that expanding "<cfile>" and others only returns the | |
3303 referenced file name without further expansion. If "<cfile>" | |
3304 is "~/.cshrc", you need to do another expand() to have the | |
3305 "~/" expanded into the path of the home directory: > | |
3306 :echo expand(expand("<cfile>")) | |
3307 < | |
3308 There cannot be white space between the variables and the | |
3309 following modifier. The |fnamemodify()| function can be used | |
3310 to modify normal file names. | |
3311 | |
3312 When using '%' or '#', and the current or alternate file name | |
3313 is not defined, an empty string is used. Using "%:p" in a | |
3314 buffer with no name, results in the current directory, with a | |
3315 '/' added. | |
3316 | |
3317 When {expr} does not start with '%', '#' or '<', it is | |
3318 expanded like a file name is expanded on the command line. | |
3319 'suffixes' and 'wildignore' are used, unless the optional | |
3398 | 3320 {nosuf} argument is given and it is non-zero. |
3321 Names for non-existing files are included. The "**" item can | |
3322 be used to search in a directory tree. For example, to find | |
3323 all "README" files in the current directory and below: > | |
444 | 3324 :echo expand("**/README") |
3325 < | |
7 | 3326 Expand() can also be used to expand variables and environment |
3327 variables that are only known in a shell. But this can be | |
6180 | 3328 slow, because a shell may be used to do the expansion. See |
3329 |expr-env-expand|. | |
7 | 3330 The expanded variable is still handled like a list of file |
1621 | 3331 names. When an environment variable cannot be expanded, it is |
7 | 3332 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
3333 "$FOOBAR". | |
3334 | |
3335 See |glob()| for finding existing files. See |system()| for | |
3336 getting the raw output of an external command. | |
3337 | |
102 | 3338 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 3339 {expr1} and {expr2} must be both |Lists| or both |
3340 |Dictionaries|. | |
3341 | |
3342 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 3343 If {expr3} is given insert the items of {expr2} before item |
3344 {expr3} in {expr1}. When {expr3} is zero insert before the | |
3345 first item. When {expr3} is equal to len({expr1}) then | |
3346 {expr2} is appended. | |
79 | 3347 Examples: > |
3348 :echo sort(extend(mylist, [7, 5])) | |
3349 :call extend(mylist, [2, 3], 1) | |
1699 | 3350 < When {expr1} is the same List as {expr2} then the number of |
3351 items copied is equal to the original length of the List. | |
3352 E.g., when {expr3} is 1 you get N new copies of the first item | |
3353 (where N is the original length of the List). | |
3354 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 3355 two lists into a new list use the + operator: > |
79 | 3356 :let newlist = [1, 2, 3] + [4, 5] |
102 | 3357 < |
692 | 3358 If they are |Dictionaries|: |
102 | 3359 Add all entries from {expr2} to {expr1}. |
3360 If a key exists in both {expr1} and {expr2} then {expr3} is | |
3361 used to decide what to do: | |
3362 {expr3} = "keep": keep the value of {expr1} | |
3363 {expr3} = "force": use the value of {expr2} | |
856 | 3364 {expr3} = "error": give an error message *E737* |
102 | 3365 When {expr3} is omitted then "force" is assumed. |
3366 | |
3367 {expr1} is changed when {expr2} is not empty. If necessary | |
3368 make a copy of {expr1} first. | |
3369 {expr2} remains unchanged. | |
6823 | 3370 When {expr1} is locked and {expr2} is not empty the operation |
3371 fails. | |
102 | 3372 Returns {expr1}. |
3373 | |
79 | 3374 |
842 | 3375 feedkeys({string} [, {mode}]) *feedkeys()* |
3376 Characters in {string} are queued for processing as if they | |
6549 | 3377 come from a mapping or were typed by the user. |
3378 By default the string is added to the end of the typeahead | |
3379 buffer, thus if a mapping is still being executed the | |
3380 characters come after them. Use the 'i' flag to insert before | |
3381 other characters, they will be executed next, before any | |
3382 characters from a mapping. | |
842 | 3383 The function does not wait for processing of keys contained in |
3384 {string}. | |
3385 To include special keys into {string}, use double-quotes | |
3386 and "\..." notation |expr-quote|. For example, | |
1215 | 3387 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 3388 feedkeys('\<CR>') pushes 5 characters. |
3389 If {mode} is absent, keys are remapped. | |
3390 {mode} is a String, which can contain these character flags: | |
843 | 3391 'm' Remap keys. This is default. |
3392 'n' Do not remap keys. | |
3393 't' Handle keys as if typed; otherwise they are handled as | |
3394 if coming from a mapping. This matters for undo, | |
3395 opening folds, etc. | |
6549 | 3396 'i' Insert the string instead of appending (see above). |
7703
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3397 'x' Execute commands until typeahead is empty. This is |
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3398 similar to using ":normal!". You can call feedkeys() |
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3399 several times without 'x' and then one time with 'x' |
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3400 (possibly with an empty {string}) to execute all the |
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3401 typeahead. |
842 | 3402 Return value is always 0. |
3403 | |
7 | 3404 filereadable({file}) *filereadable()* |
3405 The result is a Number, which is TRUE when a file with the | |
3406 name {file} exists, and can be read. If {file} doesn't exist, | |
3407 or is a directory, the result is FALSE. {file} is any | |
3408 expression, which is used as a String. | |
1156 | 3409 If you don't care about the file being readable you can use |
3410 |glob()|. | |
7 | 3411 *file_readable()* |
3412 Obsolete name: file_readable(). | |
3413 | |
95 | 3414 |
1156 | 3415 filewritable({file}) *filewritable()* |
3416 The result is a Number, which is 1 when a file with the | |
3417 name {file} exists, and can be written. If {file} doesn't | |
1621 | 3418 exist, or is not writable, the result is 0. If {file} is a |
1156 | 3419 directory, and we can write to it, the result is 2. |
3420 | |
3421 | |
102 | 3422 filter({expr}, {string}) *filter()* |
685 | 3423 {expr} must be a |List| or a |Dictionary|. |
102 | 3424 For each item in {expr} evaluate {string} and when the result |
685 | 3425 is zero remove the item from the |List| or |Dictionary|. |
102 | 3426 Inside {string} |v:val| has the value of the current item. |
685 | 3427 For a |Dictionary| |v:key| has the key of the current item. |
102 | 3428 Examples: > |
3429 :call filter(mylist, 'v:val !~ "OLD"') | |
3430 < Removes the items where "OLD" appears. > | |
3431 :call filter(mydict, 'v:key >= 8') | |
3432 < Removes the items with a key below 8. > | |
3433 :call filter(var, 0) | |
685 | 3434 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 3435 |
102 | 3436 Note that {string} is the result of expression and is then |
3437 used as an expression again. Often it is good to use a | |
3438 |literal-string| to avoid having to double backslashes. | |
3439 | |
685 | 3440 The operation is done in-place. If you want a |List| or |
3441 |Dictionary| to remain unmodified make a copy first: > | |
650 | 3442 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 3443 |
685 | 3444 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3445 When an error is encountered while evaluating {string} no |
3446 further items in {expr} are processed. | |
95 | 3447 |
3448 | |
19 | 3449 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 3450 Find directory {name} in {path}. Supports both downwards and |
3451 upwards recursive directory searches. See |file-searching| | |
3452 for the syntax of {path}. | |
3453 Returns the path of the first found match. When the found | |
3454 directory is below the current directory a relative path is | |
3455 returned. Otherwise a full path is returned. | |
19 | 3456 If {path} is omitted or empty then 'path' is used. |
3457 If the optional {count} is given, find {count}'s occurrence of | |
794 | 3458 {name} in {path} instead of the first one. |
809 | 3459 When {count} is negative return all the matches in a |List|. |
19 | 3460 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
|
3461 {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
|
3462 feature} |
794 | 3463 |
3464 findfile({name}[, {path}[, {count}]]) *findfile()* | |
3465 Just like |finddir()|, but find a file instead of a directory. | |
3466 Uses 'suffixesadd'. | |
19 | 3467 Example: > |
3468 :echo findfile("tags.vim", ".;") | |
1156 | 3469 < Searches from the directory of the current file upwards until |
3470 it finds the file "tags.vim". | |
7 | 3471 |
1621 | 3472 float2nr({expr}) *float2nr()* |
3473 Convert {expr} to a Number by omitting the part after the | |
3474 decimal point. | |
3475 {expr} must evaluate to a |Float| or a Number. | |
3476 When the value of {expr} is out of range for a |Number| the | |
3477 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
3478 in -0x80000000. | |
3479 Examples: > | |
3480 echo float2nr(3.95) | |
3481 < 3 > | |
3482 echo float2nr(-23.45) | |
3483 < -23 > | |
3484 echo float2nr(1.0e100) | |
3485 < 2147483647 > | |
3486 echo float2nr(-1.0e150) | |
3487 < -2147483647 > | |
3488 echo float2nr(1.0e-100) | |
3489 < 0 | |
3490 {only available when compiled with the |+float| feature} | |
3491 | |
3492 | |
3493 floor({expr}) *floor()* | |
3494 Return the largest integral value less than or equal to | |
3495 {expr} as a |Float| (round down). | |
3496 {expr} must evaluate to a |Float| or a |Number|. | |
3497 Examples: > | |
3498 echo floor(1.856) | |
3499 < 1.0 > | |
3500 echo floor(-5.456) | |
3501 < -6.0 > | |
3502 echo floor(4.0) | |
3503 < 4.0 | |
3504 {only available when compiled with the |+float| feature} | |
3505 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3506 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3507 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3508 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3509 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3510 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
|
3511 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
|
3512 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
|
3513 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
|
3514 {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
|
3515 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3516 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3517 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3518 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3519 < -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
|
3520 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3521 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3522 |
1586 | 3523 fnameescape({string}) *fnameescape()* |
1621 | 3524 Escape {string} for use as file name command argument. All |
1586 | 3525 characters that have a special meaning, such as '%' and '|' |
3526 are escaped with a backslash. | |
1621 | 3527 For most systems the characters escaped are |
3528 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3529 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3530 A leading '+' and '>' is also escaped (special after |:edit| |
3531 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3532 Example: > |
1700 | 3533 :let fname = '+some str%nge|name' |
1586 | 3534 :exe "edit " . fnameescape(fname) |
3535 < results in executing: > | |
1700 | 3536 edit \+some\ str\%nge\|name |
1586 | 3537 |
7 | 3538 fnamemodify({fname}, {mods}) *fnamemodify()* |
3539 Modify file name {fname} according to {mods}. {mods} is a | |
3540 string of characters like it is used for file names on the | |
3541 command line. See |filename-modifiers|. | |
3542 Example: > | |
3543 :echo fnamemodify("main.c", ":p:h") | |
3544 < results in: > | |
3545 /home/mool/vim/vim/src | |
1621 | 3546 < Note: Environment variables don't work in {fname}, use |
7 | 3547 |expand()| first then. |
3548 | |
3549 foldclosed({lnum}) *foldclosed()* | |
3550 The result is a Number. If the line {lnum} is in a closed | |
3551 fold, the result is the number of the first line in that fold. | |
3552 If the line {lnum} is not in a closed fold, -1 is returned. | |
3553 | |
3554 foldclosedend({lnum}) *foldclosedend()* | |
3555 The result is a Number. If the line {lnum} is in a closed | |
3556 fold, the result is the number of the last line in that fold. | |
3557 If the line {lnum} is not in a closed fold, -1 is returned. | |
3558 | |
3559 foldlevel({lnum}) *foldlevel()* | |
3560 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3561 in the current buffer. For nested folds the deepest level is |
7 | 3562 returned. If there is no fold at line {lnum}, zero is |
3563 returned. It doesn't matter if the folds are open or closed. | |
3564 When used while updating folds (from 'foldexpr') -1 is | |
3565 returned for lines where folds are still to be updated and the | |
3566 foldlevel is unknown. As a special case the level of the | |
3567 previous line is usually available. | |
3568 | |
3569 *foldtext()* | |
3570 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3571 the default function used for the 'foldtext' option and should | |
3572 only be called from evaluating 'foldtext'. It uses the | |
3573 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3574 The returned string looks like this: > | |
3575 +-- 45 lines: abcdef | |
1621 | 3576 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3577 the number of lines in the fold. "abcdef" is the text in the |
3578 first non-blank line of the fold. Leading white space, "//" | |
3579 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3580 options is removed. | |
3581 {not available when compiled without the |+folding| feature} | |
3582 | |
29 | 3583 foldtextresult({lnum}) *foldtextresult()* |
3584 Returns the text that is displayed for the closed fold at line | |
3585 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3586 When there is no closed fold at {lnum} an empty string is | |
3587 returned. | |
3588 {lnum} is used like with |getline()|. Thus "." is the current | |
3589 line, "'m" mark m, etc. | |
3590 Useful when exporting folded text, e.g., to HTML. | |
3591 {not available when compiled without the |+folding| feature} | |
3592 | |
7 | 3593 *foreground()* |
1621 | 3594 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3595 a client to a Vim server. |remote_send()| |
3596 On Win32 systems this might not work, the OS does not always | |
3597 allow a window to bring itself to the foreground. Use | |
3598 |remote_foreground()| instead. | |
3599 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3600 Win32 console version} | |
3601 | |
82 | 3602 |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3603 *function()* *E700* *E922* *E923* |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3604 function({name} [, {arglist}] [, {dict}]) |
685 | 3605 Return a |Funcref| variable that refers to function {name}. |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3606 {name} can be the name of a user defined function or an |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3607 internal function. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3608 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3609 {name} can also be a Funcref, also a partial. When it is a |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3610 partial the dict stored in it will be used and the {dict} |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3611 argument is not allowed. E.g.: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3612 let FuncWithArg = function(dict.Func, [arg]) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3613 let Broken = function(dict.Func, [arg], dict) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3614 < |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3615 When {arglist} or {dict} is present this creates a partial. |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3616 That mans the argument list and/or the dictionary is stored in |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3617 the Funcref and will be used when the Funcref is called. |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3618 |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3619 The arguments are passed to the function in front of other |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3620 arguments. Example: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3621 func Callback(arg1, arg2, name) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3622 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3623 let Func = function('Callback', ['one', 'two']) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3624 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3625 call Func('name') |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3626 < Invokes the function as with: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3627 call Callback('one', 'two', 'name') |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3628 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3629 < The function() call can be nested to add more arguments to the |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3630 Funcref. The extra arguments are appended to the list of |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3631 arguments. Example: > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3632 func Callback(arg1, arg2, name) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3633 ... |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3634 let Func = function('Callback', ['one']) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3635 let Func2 = function(Func, ['two']) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3636 ... |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3637 call Func2('name') |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3638 < Invokes the function as with: > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3639 call Callback('one', 'two', 'name') |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3640 |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3641 < The Dictionary is only useful when calling a "dict" function. |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3642 In that case the {dict} is passed in as "self". Example: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3643 function Callback() dict |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3644 echo "called for " . self.name |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3645 endfunction |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3646 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3647 let context = {"name": "example"} |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3648 let Func = function('Callback', context) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3649 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3650 call Func() " will echo: called for example |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3651 < The use of function() is not needed when there are no extra |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3652 arguments, these two are equivalent: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3653 let Func = function('Callback', context) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3654 let Func = context.Callback |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3655 |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3656 < The argument list and the Dictionary can be combined: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3657 function Callback(arg1, count) dict |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3658 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3659 let context = {"name": "example"} |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3660 let Func = function('Callback', ['one'], context) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3661 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3662 call Func(500) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3663 < Invokes the function as with: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3664 call context.Callback('one', 500) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3665 |
82 | 3666 |
3224 | 3667 garbagecollect([{atexit}]) *garbagecollect()* |
692 | 3668 Cleanup unused |Lists| and |Dictionaries| that have circular |
370 | 3669 references. There is hardly ever a need to invoke this |
3670 function, as it is automatically done when Vim runs out of | |
3671 memory or is waiting for the user to press a key after | |
3672 'updatetime'. Items without circular references are always | |
3673 freed when they become unused. | |
685 | 3674 This is useful if you have deleted a very big |List| and/or |
3675 |Dictionary| with circular references in a script that runs | |
3676 for a long time. | |
3224 | 3677 When the optional {atexit} argument is one, garbage |
1405 | 3678 collection will also be done when exiting Vim, if it wasn't |
3679 done before. This is useful when checking for memory leaks. | |
370 | 3680 |
140 | 3681 get({list}, {idx} [, {default}]) *get()* |
685 | 3682 Get item {idx} from |List| {list}. When this item is not |
82 | 3683 available return {default}. Return zero when {default} is |
3684 omitted. | |
102 | 3685 get({dict}, {key} [, {default}]) |
685 | 3686 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3687 item is not available return {default}. Return zero when |
3688 {default} is omitted. | |
3689 | |
435 | 3690 *getbufline()* |
3691 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3692 Return a |List| with the lines starting from {lnum} to {end} |
3693 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3694 |List| with only the line {lnum} is returned. | |
435 | 3695 |
3696 For the use of {expr}, see |bufname()| above. | |
3697 | |
448 | 3698 For {lnum} and {end} "$" can be used for the last line of the |
3699 buffer. Otherwise a number must be used. | |
435 | 3700 |
3701 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3702 lines in the buffer, an empty |List| is returned. |
435 | 3703 |
3704 When {end} is greater than the number of lines in the buffer, | |
3705 it is treated as {end} is set to the number of lines in the | |
685 | 3706 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3707 returned. |
3708 | |
448 | 3709 This function works only for loaded buffers. For unloaded and |
685 | 3710 non-existing buffers, an empty |List| is returned. |
435 | 3711 |
3712 Example: > | |
3713 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3714 |
4157 | 3715 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
82 | 3716 The result is the value of option or local buffer variable |
3717 {varname} in buffer {expr}. Note that the name without "b:" | |
3718 must be used. | |
1668 | 3719 When {varname} is empty returns a dictionary with all the |
3720 buffer-local variables. | |
216 | 3721 This also works for a global or buffer-local option, but it |
3722 doesn't work for a global variable, window-local variable or | |
3723 window-local option. | |
82 | 3724 For the use of {expr}, see |bufname()| above. |
4157 | 3725 When the buffer or variable doesn't exist {def} or an empty |
3726 string is returned, there is no error message. | |
82 | 3727 Examples: > |
3728 :let bufmodified = getbufvar(1, "&mod") | |
3729 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3730 < | |
7 | 3731 getchar([expr]) *getchar()* |
867 | 3732 Get a single character from the user or input stream. |
7 | 3733 If [expr] is omitted, wait until a character is available. |
3734 If [expr] is 0, only get a character when one is available. | |
867 | 3735 Return zero otherwise. |
7 | 3736 If [expr] is 1, only check if a character is available, it is |
867 | 3737 not consumed. Return zero if no character available. |
3738 | |
5555 | 3739 Without [expr] and when [expr] is 0 a whole character or |
867 | 3740 special key is returned. If it is an 8-bit character, the |
3741 result is a number. Use nr2char() to convert it to a String. | |
3742 Otherwise a String is returned with the encoded character. | |
3743 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3744 (decimal: 128). This is the same value as the string |
3745 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3746 String when a modifier (shift, control, alt) was used that is | |
3747 not included in the character. | |
867 | 3748 |
5968 | 3749 When [expr] is 0 and Esc is typed, there will be a short delay |
3750 while Vim waits to see if this is the start of an escape | |
3751 sequence. | |
3752 | |
5555 | 3753 When [expr] is 1 only the first byte is returned. For a |
872 | 3754 one-byte character it is the character itself as a number. |
3755 Use nr2char() to convert it to a String. | |
867 | 3756 |
3224 | 3757 Use getcharmod() to obtain any additional modifiers. |
3758 | |
1029 | 3759 When the user clicks a mouse button, the mouse event will be |
3760 returned. The position can then be found in |v:mouse_col|, | |
3761 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3762 mouse as it would normally happen: > | |
3763 let c = getchar() | |
1621 | 3764 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3765 exe v:mouse_win . "wincmd w" |
3766 exe v:mouse_lnum | |
3767 exe "normal " . v:mouse_col . "|" | |
3768 endif | |
3769 < | |
7 | 3770 There is no prompt, you will somehow have to make clear to the |
3771 user that a character has to be typed. | |
3772 There is no mapping for the character. | |
3773 Key codes are replaced, thus when the user presses the <Del> | |
3774 key you get the code for the <Del> key, not the raw character | |
3775 sequence. Examples: > | |
3776 getchar() == "\<Del>" | |
3777 getchar() == "\<S-Left>" | |
3778 < This example redefines "f" to ignore case: > | |
3779 :nmap f :call FindChar()<CR> | |
3780 :function FindChar() | |
3781 : let c = nr2char(getchar()) | |
3782 : while col('.') < col('$') - 1 | |
3783 : normal l | |
3784 : if getline('.')[col('.') - 1] ==? c | |
3785 : break | |
3786 : endif | |
3787 : endwhile | |
3788 :endfunction | |
6421 | 3789 < |
6647 | 3790 You may also receive synthetic characters, such as |
6421 | 3791 |<CursorHold>|. Often you will want to ignore this and get |
3792 another character: > | |
3793 :function GetKey() | |
3794 : let c = getchar() | |
3795 : while c == "\<CursorHold>" | |
3796 : let c = getchar() | |
3797 : endwhile | |
3798 : return c | |
3799 :endfunction | |
7 | 3800 |
3801 getcharmod() *getcharmod()* | |
3802 The result is a Number which is the state of the modifiers for | |
3803 the last obtained character with getchar() or in another way. | |
3804 These values are added together: | |
3805 2 shift | |
3806 4 control | |
3807 8 alt (meta) | |
3224 | 3808 16 meta (when it's different from ALT) |
3809 32 mouse double click | |
3810 64 mouse triple click | |
3811 96 mouse quadruple click (== 32 + 64) | |
3812 128 command (Macintosh only) | |
7 | 3813 Only the modifiers that have not been included in the |
1621 | 3814 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3815 without a modifier. |
7 | 3816 |
6991 | 3817 getcharsearch() *getcharsearch()* |
3818 Return the current character search information as a {dict} | |
3819 with the following entries: | |
3820 | |
3821 char character previously used for a character | |
3822 search (|t|, |f|, |T|, or |F|); empty string | |
3823 if no character search has been performed | |
3824 forward direction of character search; 1 for forward, | |
3825 0 for backward | |
3826 until type of character search; 1 for a |t| or |T| | |
3827 character search, 0 for an |f| or |F| | |
3828 character search | |
3829 | |
3830 This can be useful to always have |;| and |,| search | |
3831 forward/backward regardless of the direction of the previous | |
3832 character search: > | |
3833 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
3834 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
3835 < Also see |setcharsearch()|. | |
3836 | |
7 | 3837 getcmdline() *getcmdline()* |
3838 Return the current command-line. Only works when the command | |
3839 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3840 |c_CTRL-R_=|. | |
3841 Example: > | |
3842 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3843 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3844 |
95 | 3845 getcmdpos() *getcmdpos()* |
7 | 3846 Return the position of the cursor in the command line as a |
3847 byte count. The first column is 1. | |
3848 Only works when editing the command line, thus requires use of | |
3456 | 3849 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3850 Returns 0 otherwise. | |
531 | 3851 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3852 | |
3853 getcmdtype() *getcmdtype()* | |
3854 Return the current command-line type. Possible return values | |
3855 are: | |
532 | 3856 : normal Ex command |
3857 > debug mode command |debug-mode| | |
3858 / forward search command | |
3859 ? backward search command | |
3860 @ |input()| command | |
3861 - |:insert| or |:append| command | |
6213 | 3862 = |i_CTRL-R_=| |
531 | 3863 Only works when editing the command line, thus requires use of |
3456 | 3864 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3865 Returns an empty string otherwise. | |
531 | 3866 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
7 | 3867 |
6153 | 3868 getcmdwintype() *getcmdwintype()* |
3869 Return the current |command-line-window| type. Possible return | |
3870 values are the same as |getcmdtype()|. Returns an empty string | |
3871 when not in the command-line window. | |
3872 | |
5944 | 3873 *getcurpos()* |
3874 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
3875 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
|
3876 [bufnum, lnum, col, off, curswant] ~ |
5944 | 3877 The "curswant" number is the preferred column when moving the |
3878 cursor vertically. | |
3879 This can be used to save and restore the cursor position: > | |
3880 let save_cursor = getcurpos() | |
3881 MoveTheCursorAround | |
3882 call setpos('.', save_cursor) | |
6153 | 3883 < |
7 | 3884 *getcwd()* |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3885 getcwd([{winnr} [, {tabnr}]]) |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3886 The result is a String, which is the name of the current |
7 | 3887 working directory. |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3888 Without arguments, for the current window. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3889 |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3890 With {winnr} return the local current directory of this window |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3891 in the current tab page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3892 With {winnr} and {tabnr} return the local current directory of |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3893 the window in the specified tab page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3894 Return an empty string if the arguments are invalid. |
7 | 3895 |
3896 getfsize({fname}) *getfsize()* | |
3897 The result is a Number, which is the size in bytes of the | |
3898 given file {fname}. | |
3899 If {fname} is a directory, 0 is returned. | |
3900 If the file {fname} can't be found, -1 is returned. | |
1293 | 3901 If the size of {fname} is too big to fit in a Number then -2 |
3902 is returned. | |
7 | 3903 |
37 | 3904 getfontname([{name}]) *getfontname()* |
3905 Without an argument returns the name of the normal font being | |
3906 used. Like what is used for the Normal highlight group | |
3907 |hl-Normal|. | |
3908 With an argument a check is done whether {name} is a valid | |
3909 font name. If not then an empty string is returned. | |
3910 Otherwise the actual font name is returned, or {name} if the | |
3911 GUI does not support obtaining the real name. | |
824 | 3912 Only works when the GUI is running, thus not in your vimrc or |
819 | 3913 gvimrc file. Use the |GUIEnter| autocommand to use this |
3914 function just after the GUI has started. | |
37 | 3915 Note that the GTK 2 GUI accepts any font name, thus checking |
3916 for a valid name does not work. | |
3917 | |
20 | 3918 getfperm({fname}) *getfperm()* |
3919 The result is a String, which is the read, write, and execute | |
3920 permissions of the given file {fname}. | |
3921 If {fname} does not exist or its directory cannot be read, an | |
3922 empty string is returned. | |
3923 The result is of the form "rwxrwxrwx", where each group of | |
3924 "rwx" flags represent, in turn, the permissions of the owner | |
3925 of the file, the group the file belongs to, and other users. | |
3926 If a user does not have a given permission the flag for this | |
3750 | 3927 is replaced with the string "-". Examples: > |
20 | 3928 :echo getfperm("/etc/passwd") |
3750 | 3929 :echo getfperm(expand("~/.vimrc")) |
20 | 3930 < This will hopefully (from a security point of view) display |
3931 the string "rw-r--r--" or even "rw-------". | |
205 | 3932 |
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
3933 For setting permissins use |setfperm()|. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
3934 |
7 | 3935 getftime({fname}) *getftime()* |
3936 The result is a Number, which is the last modification time of | |
3937 the given file {fname}. The value is measured as seconds | |
3938 since 1st Jan 1970, and may be passed to strftime(). See also | |
3939 |localtime()| and |strftime()|. | |
3940 If the file {fname} can't be found -1 is returned. | |
3941 | |
20 | 3942 getftype({fname}) *getftype()* |
3943 The result is a String, which is a description of the kind of | |
3944 file of the given file {fname}. | |
3945 If {fname} does not exist an empty string is returned. | |
3946 Here is a table over different kinds of files and their | |
3947 results: | |
3948 Normal file "file" | |
3949 Directory "dir" | |
3950 Symbolic link "link" | |
3951 Block device "bdev" | |
3952 Character device "cdev" | |
3953 Socket "socket" | |
3954 FIFO "fifo" | |
3955 All other "other" | |
3956 Example: > | |
3957 getftype("/home") | |
3958 < Note that a type such as "link" will only be returned on | |
3959 systems that support it. On some systems only "dir" and | |
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
3960 "file" are returned. On MS-Windows a symbolic link to a |
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
3961 directory returns "dir" instead of "link". |
20 | 3962 |
7 | 3963 *getline()* |
82 | 3964 getline({lnum} [, {end}]) |
3965 Without {end} the result is a String, which is line {lnum} | |
3966 from the current buffer. Example: > | |
7 | 3967 getline(1) |
3968 < When {lnum} is a String that doesn't start with a | |
3969 digit, line() is called to translate the String into a Number. | |
3970 To get the line under the cursor: > | |
3971 getline(".") | |
3972 < When {lnum} is smaller than 1 or bigger than the number of | |
3973 lines in the buffer, an empty string is returned. | |
3974 | |
685 | 3975 When {end} is given the result is a |List| where each item is |
3976 a line from the current buffer in the range {lnum} to {end}, | |
82 | 3977 including line {end}. |
3978 {end} is used in the same way as {lnum}. | |
3979 Non-existing lines are silently omitted. | |
685 | 3980 When {end} is before {lnum} an empty |List| is returned. |
82 | 3981 Example: > |
3982 :let start = line('.') | |
3983 :let end = search("^$") - 1 | |
3984 :let lines = getline(start, end) | |
3985 | |
1156 | 3986 < To get lines from another buffer see |getbufline()| |
3987 | |
647 | 3988 getloclist({nr}) *getloclist()* |
3989 Returns a list with all the entries in the location list for | |
3990 window {nr}. When {nr} is zero the current window is used. | |
3991 For a location list window, the displayed location list is | |
648 | 3992 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
|
3993 returned. Otherwise, same as |getqflist()|. |
82 | 3994 |
1326 | 3995 getmatches() *getmatches()* |
3996 Returns a |List| with all matches previously defined by | |
3997 |matchadd()| and the |:match| commands. |getmatches()| is | |
3998 useful in combination with |setmatches()|, as |setmatches()| | |
3999 can restore a list of matches saved by |getmatches()|. | |
4000 Example: > | |
4001 :echo getmatches() | |
4002 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
4003 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
4004 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
4005 :let m = getmatches() | |
4006 :call clearmatches() | |
4007 :echo getmatches() | |
4008 < [] > | |
4009 :call setmatches(m) | |
4010 :echo getmatches() | |
4011 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
4012 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
4013 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
4014 :unlet m | |
4015 < | |
5968 | 4016 *getpid()* |
4017 getpid() Return a Number which is the process ID of the Vim process. | |
4018 On Unix and MS-Windows this is a unique number, until Vim | |
4019 exits. On MS-DOS it's always zero. | |
4020 | |
4021 *getpos()* | |
4022 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
4023 see |line()|. For getting the cursor position see | |
4024 |getcurpos()|. | |
4025 The result is a |List| with four numbers: | |
4026 [bufnum, lnum, col, off] | |
4027 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
4028 is the buffer number of the mark. | |
4029 "lnum" and "col" are the position in the buffer. The first | |
4030 column is 1. | |
4031 The "off" number is zero, unless 'virtualedit' is used. Then | |
4032 it is the offset in screen columns from the start of the | |
4033 character. E.g., a position within a <Tab> or after the last | |
4034 character. | |
4035 Note that for '< and '> Visual mode matters: when it is "V" | |
4036 (visual line mode) the column of '< is zero and the column of | |
4037 '> is a large number. | |
4038 This can be used to save and restore the position of a mark: > | |
4039 let save_a_mark = getpos("'a") | |
4040 ... | |
6421 | 4041 call setpos("'a", save_a_mark) |
5968 | 4042 < Also see |getcurpos()| and |setpos()|. |
4043 | |
1326 | 4044 |
230 | 4045 getqflist() *getqflist()* |
4046 Returns a list with all the current quickfix errors. Each | |
4047 list item is a dictionary with these entries: | |
4048 bufnr number of buffer that has the file name, use | |
4049 bufname() to get the name | |
4050 lnum line number in the buffer (first line is 1) | |
4051 col column number (first column is 1) | |
233 | 4052 vcol non-zero: "col" is visual column |
4053 zero: "col" is byte index | |
230 | 4054 nr error number |
1065 | 4055 pattern search pattern used to locate the error |
230 | 4056 text description of the error |
4057 type type of the error, 'E', '1', etc. | |
4058 valid non-zero: recognized error message | |
4059 | |
515 | 4060 When there is no error list or it's empty an empty list is |
1065 | 4061 returned. Quickfix list entries with non-existing buffer |
4062 number are returned with "bufnr" set to zero. | |
515 | 4063 |
230 | 4064 Useful application: Find pattern matches in multiple files and |
4065 do something with them: > | |
4066 :vimgrep /theword/jg *.c | |
4067 :for d in getqflist() | |
4068 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
4069 :endfor | |
4070 | |
4071 | |
5796 | 4072 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
7 | 4073 The result is a String, which is the contents of register |
236 | 4074 {regname}. Example: > |
7 | 4075 :let cliptext = getreg('*') |
4076 < getreg('=') returns the last evaluated value of the expression | |
236 | 4077 register. (For use in maps.) |
282 | 4078 getreg('=', 1) returns the expression itself, so that it can |
4079 be restored with |setreg()|. For other registers the extra | |
4080 argument is ignored, thus you can always give it. | |
5796 | 4081 If {list} is present and non-zero result type is changed to |
4082 |List|. Each list item is one text line. Use it if you care | |
4083 about zero bytes possibly present inside register: without | |
4084 third argument both NLs and zero bytes are represented as NLs | |
4085 (see |NL-used-for-Nul|). | |
7 | 4086 If {regname} is not specified, |v:register| is used. |
4087 | |
82 | 4088 |
7 | 4089 getregtype([{regname}]) *getregtype()* |
4090 The result is a String, which is type of register {regname}. | |
4091 The value will be one of: | |
4092 "v" for |characterwise| text | |
4093 "V" for |linewise| text | |
4094 "<CTRL-V>{width}" for |blockwise-visual| text | |
5596 | 4095 "" for an empty or unknown register |
7 | 4096 <CTRL-V> is one character with value 0x16. |
4097 If {regname} is not specified, |v:register| is used. | |
4098 | |
4157 | 4099 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4100 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
|
4101 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4102 Tabs are numbered starting with one. |
6197 | 4103 When {varname} is empty a dictionary with all tab-local |
4104 variables is returned. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4105 Note that the name without "t:" must be used. |
4157 | 4106 When the tab or variable doesn't exist {def} or an empty |
4107 string is returned, there is no error message. | |
4108 | |
4109 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
1156 | 4110 Get the value of window-local variable {varname} in window |
4111 {winnr} in tab page {tabnr}. | |
4112 When {varname} starts with "&" get the value of a window-local | |
4113 option. | |
4157 | 4114 When {varname} is empty a dictionary with all window-local |
4115 variables is returned. | |
4116 Note that {varname} must be the name without "w:". | |
831 | 4117 Tabs are numbered starting with one. For the current tabpage |
4118 use |getwinvar()|. | |
4119 When {winnr} is zero the current window is used. | |
4120 This also works for a global option, buffer-local option and | |
4121 window-local option, but it doesn't work for a global variable | |
4122 or buffer-local variable. | |
4157 | 4123 When the tab, window or variable doesn't exist {def} or an |
4124 empty string is returned, there is no error message. | |
831 | 4125 Examples: > |
4126 :let list_is_on = gettabwinvar(1, 2, '&list') | |
4127 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 4128 < |
7 | 4129 *getwinposx()* |
4130 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
4131 the left hand side of the GUI Vim window. The result will be | |
4132 -1 if the information is not available. | |
4133 | |
4134 *getwinposy()* | |
4135 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 4136 the top of the GUI Vim window. The result will be -1 if the |
7 | 4137 information is not available. |
4138 | |
4157 | 4139 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
831 | 4140 Like |gettabwinvar()| for the current tabpage. |
7 | 4141 Examples: > |
4142 :let list_is_on = getwinvar(2, '&list') | |
4143 :echo "myvar = " . getwinvar(1, 'myvar') | |
4144 < | |
6663 | 4145 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
1754 | 4146 Expand the file wildcards in {expr}. See |wildcards| for the |
1156 | 4147 use of special characters. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4148 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4149 Unless the optional {nosuf} argument is given and is non-zero, |
1754 | 4150 the 'suffixes' and 'wildignore' options apply: Names matching |
4151 one of the patterns in 'wildignore' will be skipped and | |
4152 'suffixes' affect the ordering of matches. | |
2662 | 4153 'wildignorecase' always applies. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4154 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4155 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
|
4156 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
|
4157 you also get filenames containing newlines correctly. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4158 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
|
4159 matches, they are separated by <NL> characters. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4160 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4161 If the expansion fails, the result is an empty String or List. |
6663 | 4162 |
3445 | 4163 A name for a non-existing file is not included. A symbolic |
4164 link is only included if it points to an existing file. | |
6663 | 4165 However, when the {alllinks} argument is present and it is |
4166 non-zero then all symbolic links are included. | |
7 | 4167 |
4168 For most systems backticks can be used to get files names from | |
4169 any external command. Example: > | |
4170 :let tagfiles = glob("`find . -name tags -print`") | |
4171 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
4172 < The result of the program inside the backticks should be one | |
1621 | 4173 item per line. Spaces inside an item are allowed. |
7 | 4174 |
4175 See |expand()| for expanding special Vim variables. See | |
4176 |system()| for getting the raw output of an external command. | |
4177 | |
6697 | 4178 glob2regpat({expr}) *glob2regpat()* |
4179 Convert a file pattern, as used by glob(), into a search | |
4180 pattern. The result can be used to match with a string that | |
4181 is a file name. E.g. > | |
4182 if filename =~ glob2regpat('Make*.mak') | |
4183 < This is equivalent to: > | |
4184 if filename =~ '^Make.*\.mak$' | |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4185 < When {expr} is an empty string the result is "^$", match an |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4186 empty string. |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4187 |
6663 | 4188 *globpath()* |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4189 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
7 | 4190 Perform glob() on all directories in {path} and concatenate |
4191 the results. Example: > | |
4192 :echo globpath(&rtp, "syntax/c.vim") | |
5873 | 4193 < |
4194 {path} is a comma-separated list of directory names. Each | |
7 | 4195 directory name is prepended to {expr} and expanded like with |
1754 | 4196 |glob()|. A path separator is inserted when needed. |
7 | 4197 To add a comma inside a directory name escape it with a |
4198 backslash. Note that on MS-Windows a directory may have a | |
4199 trailing backslash, remove it if you put a comma after it. | |
4200 If the expansion fails for one of the directories, there is no | |
4201 error message. | |
5873 | 4202 |
4203 Unless the optional {nosuf} argument is given and is non-zero, | |
1754 | 4204 the 'suffixes' and 'wildignore' options apply: Names matching |
4205 one of the patterns in 'wildignore' will be skipped and | |
4206 'suffixes' affect the ordering of matches. | |
7 | 4207 |
5873 | 4208 When {list} is present and it is non-zero the result is a List |
4209 with all matching files. The advantage of using a List is, you | |
4210 also get filenames containing newlines correctly. Otherwise | |
4211 the result is a String and when there are several matches, | |
4212 they are separated by <NL> characters. Example: > | |
4213 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
4214 < | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4215 {alllinks} is used as with |glob()|. |
6663 | 4216 |
444 | 4217 The "**" item can be used to search in a directory tree. |
4218 For example, to find all "README.txt" files in the directories | |
4219 in 'runtimepath' and below: > | |
4220 :echo globpath(&rtp, "**/README.txt") | |
1668 | 4221 < Upwards search and limiting the depth of "**" is not |
4222 supported, thus using 'path' will not always work properly. | |
4223 | |
7 | 4224 *has()* |
4225 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
4226 supported, zero otherwise. The {feature} argument is a | |
4227 string. See |feature-list| below. | |
4228 Also see |exists()|. | |
4229 | |
102 | 4230 |
4231 has_key({dict}, {key}) *has_key()* | |
685 | 4232 The result is a Number, which is 1 if |Dictionary| {dict} has |
4233 an entry with key {key}. Zero otherwise. | |
102 | 4234 |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4235 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4236 The result is a Number, which is 1 when the window has set a |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4237 local path via |:lcd|, and 0 otherwise. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4238 |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4239 Without arguments use the current window. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4240 With {winnr} use this window in the current tab page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4241 With {winnr} and {tabnr} use the window in the specified tab |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4242 page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4243 Return 0 if the arguments are invalid. |
102 | 4244 |
782 | 4245 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 4246 The result is a Number, which is 1 if there is a mapping that |
4247 contains {what} in somewhere in the rhs (what it is mapped to) | |
4248 and this mapping exists in one of the modes indicated by | |
4249 {mode}. | |
782 | 4250 When {abbr} is there and it is non-zero use abbreviations |
786 | 4251 instead of mappings. Don't forget to specify Insert and/or |
4252 Command-line mode. | |
7 | 4253 Both the global mappings and the mappings local to the current |
4254 buffer are checked for a match. | |
4255 If no matching mapping is found 0 is returned. | |
4256 The following characters are recognized in {mode}: | |
4257 n Normal mode | |
4258 v Visual mode | |
4259 o Operator-pending mode | |
4260 i Insert mode | |
4261 l Language-Argument ("r", "f", "t", etc.) | |
4262 c Command-line mode | |
4263 When {mode} is omitted, "nvo" is used. | |
4264 | |
4265 This function is useful to check if a mapping already exists | |
1621 | 4266 to a function in a Vim script. Example: > |
7 | 4267 :if !hasmapto('\ABCdoit') |
4268 : map <Leader>d \ABCdoit | |
4269 :endif | |
4270 < This installs the mapping to "\ABCdoit" only if there isn't | |
4271 already a mapping to "\ABCdoit". | |
4272 | |
4273 histadd({history}, {item}) *histadd()* | |
4274 Add the String {item} to the history {history} which can be | |
4275 one of: *hist-names* | |
4276 "cmd" or ":" command line history | |
4277 "search" or "/" search pattern history | |
1621 | 4278 "expr" or "=" typed expression history |
7 | 4279 "input" or "@" input line history |
3682 | 4280 "debug" or ">" debug command history |
4281 The {history} string does not need to be the whole name, one | |
4282 character is sufficient. | |
7 | 4283 If {item} does already exist in the history, it will be |
4284 shifted to become the newest entry. | |
4285 The result is a Number: 1 if the operation was successful, | |
4286 otherwise 0 is returned. | |
4287 | |
4288 Example: > | |
4289 :call histadd("input", strftime("%Y %b %d")) | |
4290 :let date=input("Enter date: ") | |
4291 < This function is not available in the |sandbox|. | |
4292 | |
4293 histdel({history} [, {item}]) *histdel()* | |
236 | 4294 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 4295 for the possible values of {history}. |
4296 | |
1668 | 4297 If the parameter {item} evaluates to a String, it is used as a |
4298 regular expression. All entries matching that expression will | |
4299 be removed from the history (if there are any). | |
7 | 4300 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 4301 If {item} evaluates to a Number, it will be interpreted as |
4302 an index, see |:history-indexing|. The respective entry will | |
4303 be removed if it exists. | |
7 | 4304 |
4305 The result is a Number: 1 for a successful operation, | |
4306 otherwise 0 is returned. | |
4307 | |
4308 Examples: | |
4309 Clear expression register history: > | |
4310 :call histdel("expr") | |
4311 < | |
4312 Remove all entries starting with "*" from the search history: > | |
4313 :call histdel("/", '^\*') | |
4314 < | |
4315 The following three are equivalent: > | |
4316 :call histdel("search", histnr("search")) | |
4317 :call histdel("search", -1) | |
4318 :call histdel("search", '^'.histget("search", -1).'$') | |
4319 < | |
4320 To delete the last search pattern and use the last-but-one for | |
4321 the "n" command and 'hlsearch': > | |
4322 :call histdel("search", -1) | |
4323 :let @/ = histget("search", -1) | |
4324 | |
4325 histget({history} [, {index}]) *histget()* | |
4326 The result is a String, the entry with Number {index} from | |
4327 {history}. See |hist-names| for the possible values of | |
4328 {history}, and |:history-indexing| for {index}. If there is | |
4329 no such entry, an empty String is returned. When {index} is | |
4330 omitted, the most recent item from the history is used. | |
4331 | |
4332 Examples: | |
4333 Redo the second last search from history. > | |
4334 :execute '/' . histget("search", -2) | |
4335 | |
4336 < Define an Ex command ":H {num}" that supports re-execution of | |
4337 the {num}th entry from the output of |:history|. > | |
4338 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
4339 < | |
4340 histnr({history}) *histnr()* | |
4341 The result is the Number of the current entry in {history}. | |
4342 See |hist-names| for the possible values of {history}. | |
4343 If an error occurred, -1 is returned. | |
4344 | |
4345 Example: > | |
4346 :let inp_index = histnr("expr") | |
4347 < | |
4348 hlexists({name}) *hlexists()* | |
4349 The result is a Number, which is non-zero if a highlight group | |
4350 called {name} exists. This is when the group has been | |
4351 defined in some way. Not necessarily when highlighting has | |
4352 been defined for it, it may also have been used for a syntax | |
4353 item. | |
4354 *highlight_exists()* | |
4355 Obsolete name: highlight_exists(). | |
4356 | |
4357 *hlID()* | |
4358 hlID({name}) The result is a Number, which is the ID of the highlight group | |
4359 with name {name}. When the highlight group doesn't exist, | |
4360 zero is returned. | |
4361 This can be used to retrieve information about the highlight | |
1621 | 4362 group. For example, to get the background color of the |
7 | 4363 "Comment" group: > |
4364 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
4365 < *highlightID()* | |
4366 Obsolete name: highlightID(). | |
4367 | |
4368 hostname() *hostname()* | |
4369 The result is a String, which is the name of the machine on | |
236 | 4370 which Vim is currently running. Machine names greater than |
7 | 4371 256 characters long are truncated. |
4372 | |
4373 iconv({expr}, {from}, {to}) *iconv()* | |
4374 The result is a String, which is the text {expr} converted | |
4375 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4376 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4377 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4378 are replaced with "?". |
7 | 4379 The encoding names are whatever the iconv() library function |
4380 can accept, see ":!man 3 iconv". | |
4381 Most conversions require Vim to be compiled with the |+iconv| | |
4382 feature. Otherwise only UTF-8 to latin1 conversion and back | |
4383 can be done. | |
4384 This can be used to display messages with special characters, | |
4385 no matter what 'encoding' is set to. Write the message in | |
4386 UTF-8 and use: > | |
4387 echo iconv(utf8_str, "utf-8", &enc) | |
4388 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
4389 from/to UCS-2 is automatically changed to use UTF-8. You | |
4390 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
|
4391 {only available when compiled with the |+multi_byte| feature} |
7 | 4392 |
4393 *indent()* | |
4394 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
4395 current buffer. The indent is counted in spaces, the value | |
4396 of 'tabstop' is relevant. {lnum} is used just like in | |
4397 |getline()|. | |
4398 When {lnum} is invalid -1 is returned. | |
4399 | |
79 | 4400 |
95 | 4401 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 4402 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
|
4403 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4404 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
|
4405 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
|
4406 is not used here, case always matters. |
153 | 4407 If {start} is given then start looking at the item with index |
4408 {start} (may be negative for an item relative to the end). | |
79 | 4409 When {ic} is given and it is non-zero, ignore case. Otherwise |
4410 case must match. | |
4411 -1 is returned when {expr} is not found in {list}. | |
4412 Example: > | |
4413 :let idx = index(words, "the") | |
87 | 4414 :if index(numbers, 123) >= 0 |
79 | 4415 |
4416 | |
531 | 4417 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 4418 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
|
4419 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4420 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
|
4421 in the prompt to start a new line. |
531 | 4422 The highlighting set with |:echohl| is used for the prompt. |
4423 The input is entered just like a command-line, with the same | |
1621 | 4424 editing commands and mappings. There is a separate history |
531 | 4425 for lines typed for input(). |
4426 Example: > | |
4427 :if input("Coffee or beer? ") == "beer" | |
4428 : echo "Cheers!" | |
4429 :endif | |
4430 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4431 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4432 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
|
4433 Example: > |
531 | 4434 :let color = input("Color? ", "white") |
4435 | |
4436 < The optional {completion} argument specifies the type of | |
4437 completion supported for the input. Without it completion is | |
1621 | 4438 not performed. The supported completion types are the same as |
531 | 4439 that can be supplied to a user-defined command using the |
1621 | 4440 "-complete=" argument. Refer to |:command-completion| for |
531 | 4441 more information. Example: > |
4442 let fname = input("File: ", "", "file") | |
4443 < | |
4444 NOTE: This function must not be used in a startup file, for | |
4445 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 4446 Note: When input() is called from within a mapping it will |
4447 consume remaining characters from that mapping, because a | |
4448 mapping is handled like the characters were typed. | |
4449 Use |inputsave()| before input() and |inputrestore()| | |
4450 after input() to avoid that. Another solution is to avoid | |
4451 that further characters follow in the mapping, e.g., by using | |
4452 |:execute| or |:normal|. | |
4453 | |
531 | 4454 Example with a mapping: > |
7 | 4455 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
4456 :function GetFoo() | |
4457 : call inputsave() | |
4458 : let g:Foo = input("enter search pattern: ") | |
4459 : call inputrestore() | |
4460 :endfunction | |
4461 | |
4462 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4463 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4464 are supported, a dialog window pops up to input the text. |
7 | 4465 Example: > |
3875 | 4466 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
4467 :if n != "" | |
4468 : let &sw = n | |
4469 :endif | |
7 | 4470 < When the dialog is cancelled {cancelreturn} is returned. When |
4471 omitted an empty string is returned. | |
4472 Hitting <Enter> works like pressing the OK button. Hitting | |
4473 <Esc> works like pressing the Cancel button. | |
531 | 4474 NOTE: Command-line completion is not supported. |
7 | 4475 |
519 | 4476 inputlist({textlist}) *inputlist()* |
819 | 4477 {textlist} must be a |List| of strings. This |List| is |
4478 displayed, one string per line. The user will be prompted to | |
4479 enter a number, which is returned. | |
519 | 4480 The user can also select an item by clicking on it with the |
1621 | 4481 mouse. For the first string 0 is returned. When clicking |
519 | 4482 above the first item a negative number is returned. When |
4483 clicking on the prompt one more than the length of {textlist} | |
4484 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4485 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 4486 it won't work. It's a good idea to put the entry number at |
1156 | 4487 the start of the string. And put a prompt in the first item. |
4488 Example: > | |
519 | 4489 let color = inputlist(['Select color:', '1. red', |
4490 \ '2. green', '3. blue']) | |
4491 | |
7 | 4492 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4493 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 4494 Should be called the same number of times inputsave() is |
4495 called. Calling it more often is harmless though. | |
4496 Returns 1 when there is nothing to restore, 0 otherwise. | |
4497 | |
4498 inputsave() *inputsave()* | |
4499 Preserve typeahead (also from mappings) and clear it, so that | |
4500 a following prompt gets input from the user. Should be | |
4501 followed by a matching inputrestore() after the prompt. Can | |
4502 be used several times, in which case there must be just as | |
4503 many inputrestore() calls. | |
4504 Returns 1 when out of memory, 0 otherwise. | |
4505 | |
4506 inputsecret({prompt} [, {text}]) *inputsecret()* | |
4507 This function acts much like the |input()| function with but | |
4508 two exceptions: | |
4509 a) the user's response will be displayed as a sequence of | |
4510 asterisks ("*") thereby keeping the entry secret, and | |
4511 b) the user's response will not be recorded on the input | |
4512 |history| stack. | |
4513 The result is a String, which is whatever the user actually | |
4514 typed on the command-line in response to the issued prompt. | |
531 | 4515 NOTE: Command-line completion is not supported. |
7 | 4516 |
55 | 4517 insert({list}, {item} [, {idx}]) *insert()* |
685 | 4518 Insert {item} at the start of |List| {list}. |
55 | 4519 If {idx} is specified insert {item} before the item with index |
1621 | 4520 {idx}. If {idx} is zero it goes before the first item, just |
55 | 4521 like omitting {idx}. A negative {idx} is also possible, see |
4522 |list-index|. -1 inserts just before the last item. | |
685 | 4523 Returns the resulting |List|. Examples: > |
55 | 4524 :let mylist = insert([2, 3, 5], 1) |
4525 :call insert(mylist, 4, -1) | |
4526 :call insert(mylist, 6, len(mylist)) | |
82 | 4527 < The last example can be done simpler with |add()|. |
685 | 4528 Note that when {item} is a |List| it is inserted as a single |
692 | 4529 item. Use |extend()| to concatenate |Lists|. |
55 | 4530 |
3214 | 4531 invert({expr}) *invert()* |
4532 Bitwise invert. The argument is converted to a number. A | |
4533 List, Dict or Float argument causes an error. Example: > | |
4534 :let bits = invert(bits) | |
4535 | |
7 | 4536 isdirectory({directory}) *isdirectory()* |
4537 The result is a Number, which is non-zero when a directory | |
4538 with the name {directory} exists. If {directory} doesn't | |
4539 exist, or isn't a directory, the result is FALSE. {directory} | |
4540 is any expression, which is used as a String. | |
4541 | |
819 | 4542 islocked({expr}) *islocked()* *E786* |
148 | 4543 The result is a Number, which is non-zero when {expr} is the |
4544 name of a locked variable. | |
685 | 4545 {expr} must be the name of a variable, |List| item or |
4546 |Dictionary| entry, not the variable itself! Example: > | |
148 | 4547 :let alist = [0, ['a', 'b'], 2, 3] |
4548 :lockvar 1 alist | |
4549 :echo islocked('alist') " 1 | |
4550 :echo islocked('alist[1]') " 0 | |
4551 | |
4552 < When {expr} is a variable that does not exist you get an error | |
843 | 4553 message. Use |exists()| to check for existence. |
148 | 4554 |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4555 isnan({expr}) *isnan()* |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4556 Return non-zero if {expr} is a float with value NaN. > |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4557 echo isnan(0.0 / 0.0) |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4558 < 1 ~ |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4559 |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4560 {only available when compiled with the |+float| feature} |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4561 |
140 | 4562 items({dict}) *items()* |
685 | 4563 Return a |List| with all the key-value pairs of {dict}. Each |
4564 |List| item is a list with two items: the key of a {dict} | |
4565 entry and the value of this entry. The |List| is in arbitrary | |
4566 order. | |
140 | 4567 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4568 job_getchannel({job}) *job_getchannel()* |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4569 Get the channel handle that {job} is using. |
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
4570 To check if the job has no channel: > |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
4571 if string(job_getchannel()) == 'channel fail' |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
4572 < |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4573 {only available when compiled with the |+job| feature} |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4574 |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4575 job_info({job}) *job_info()* |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4576 Returns a Dictionary with information about {job}: |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4577 "status" what |job_status()| returns |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4578 "channel" what |job_getchannel()| returns |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4579 "exitval" only valid when "status" is "dead" |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4580 "exit_cb" function to be called on exit |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4581 "stoponexit" |job-stoponexit| |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4582 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4583 job_setoptions({job}, {options}) *job_setoptions()* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4584 Change options for {job}. Supported are: |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4585 "stoponexit" |job-stoponexit| |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4586 "exit_cb" |job-exit_cb| |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4587 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4588 job_start({command} [, {options}]) *job_start()* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4589 Start a job and return a Job object. Unlike |system()| and |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4590 |:!cmd| this does not wait for the job to finish. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4591 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4592 {command} can be a String. This works best on MS-Windows. On |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4593 Unix it is split up in white-separated parts to be passed to |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4594 execvp(). Arguments in double quotes can contain white space. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4595 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4596 {command} can be a List, where the first item is the executable |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4597 and further items are the arguments. All items are converted |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4598 to String. This works best on Unix. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4599 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4600 On MS-Windows, job_start() makes a GUI application hidden. If |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4601 want to show it, Use |:!start| instead. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4602 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4603 The command is executed directly, not through a shell, the |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4604 'shell' option is not used. To use the shell: > |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4605 let job = job_start(["/bin/sh", "-c", "echo hello"]) |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4606 < Or: > |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4607 let job = job_start('/bin/sh -c "echo hello"') |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4608 < Note that this will start two processes, the shell and the |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4609 command it executes. If you don't want this use the "exec" |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4610 shell command. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4611 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4612 On Unix $PATH is used to search for the executable only when |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4613 the command does not contain a slash. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4614 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4615 The job will use the same terminal as Vim. If it reads from |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4616 stdin the job and Vim will be fighting over input, that |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4617 doesn't work. Redirect stdin and stdout to avoid problems: > |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4618 let job = job_start(['sh', '-c', "myserver </dev/null >/dev/null"]) |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4619 < |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4620 The returned Job object can be used to get the status with |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4621 |job_status()| and stop the job with |job_stop()|. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4622 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4623 {options} must be a Dictionary. It can contain many optional |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4624 items, see |job-options|. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4625 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4626 {only available when compiled with the |+job| feature} |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4627 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4628 job_status({job}) *job_status()* *E916* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4629 Returns a String with the status of {job}: |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4630 "run" job is running |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4631 "fail" job failed to start |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4632 "dead" job died or was stopped after running |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4633 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4634 If an exit callback was set with the "exit-cb" option and the |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4635 job is now detected to be "dead" the callback will be invoked. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4636 |
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
4637 For more information see |job_info()|. |
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
4638 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4639 {only available when compiled with the |+job| feature} |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4640 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4641 job_stop({job} [, {how}]) *job_stop()* |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4642 Stop the {job}. This can also be used to signal the job. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4643 |
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4644 When {how} is omitted or is "term" the job will be terminated. |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4645 For Unix SIGTERM is sent. On MS-Windows the job will be |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4646 terminated forcedly (there is no "gentle" way). |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4647 This goes to the process group, thus children may also be |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4648 affected. |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4649 |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4650 Effect for Unix: |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4651 "term" SIGTERM (default) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4652 "hup" SIGHUP |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4653 "quit" SIGQUIT |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4654 "int" SIGINT |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4655 "kill" SIGKILL (strongest way to stop) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4656 number signal with that number |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4657 |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4658 Effect for MS-Windows: |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4659 "term" terminate process forcedly (default) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4660 "hup" CTRL_BREAK |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4661 "quit" CTRL_BREAK |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4662 "int" CTRL_C |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4663 "kill" terminate process forcedly |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4664 Others CTRL_BREAK |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4665 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4666 On Unix the signal is sent to the process group. This means |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4667 that when the job is "sh -c command" it affects both the shell |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4668 and the command. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4669 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4670 The result is a Number: 1 if the operation could be executed, |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4671 0 if "how" is not supported on the system. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4672 Note that even when the operation was executed, whether the |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4673 job was actually stopped needs to be checked with |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4674 job_status(). |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4675 The status of the job isn't checked, the operation will even |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4676 be done when Vim thinks the job isn't running. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4677 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4678 {only available when compiled with the |+job| feature} |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4679 |
95 | 4680 join({list} [, {sep}]) *join()* |
4681 Join the items in {list} together into one String. | |
4682 When {sep} is specified it is put in between the items. If | |
4683 {sep} is omitted a single space is used. | |
4684 Note that {sep} is not added at the end. You might want to | |
4685 add it there too: > | |
4686 let lines = join(mylist, "\n") . "\n" | |
692 | 4687 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 4688 converted into a string like with |string()|. |
4689 The opposite function is |split()|. | |
4690 | |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4691 js_decode({string}) *js_decode()* |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4692 This is similar to |json_decode()| with these differences: |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4693 - Object key names do not have to be in quotes. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4694 - Empty items in an array (between two commas) are allowed and |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4695 result in v:none items. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4696 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4697 js_encode({expr}) *js_encode()* |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4698 This is similar to |json_encode()| with these differences: |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4699 - Object key names are not in quotes. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4700 - v:none items in an array result in an empty item between |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4701 commas. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4702 For example, the Vim object: |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4703 [1,v:none,{"one":1},v:none] ~ |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4704 Will be encoded as: |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4705 [1,,{one:1},,] ~ |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4706 While json_encode() would produce: |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4707 [1,null,{"one":1},null] ~ |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4708 This encoding is valid for JavaScript. It is more efficient |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4709 than JSON, especially when using an array with optional items. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4710 |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4711 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4712 json_decode({string}) *json_decode()* |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4713 This parses a JSON formatted string and returns the equivalent |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4714 in Vim values. See |json_encode()| for the relation between |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4715 JSON and Vim values. |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4716 The decoding is permissive: |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4717 - A trailing comma in an array and object is ignored. |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4718 - More floating point numbers are recognized, e.g. "1." for |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4719 "1.0". |
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4720 The result must be a valid Vim type: |
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4721 - An empty object member name is not allowed. |
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4722 - Duplicate object member names are not allowed. |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4723 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4724 json_encode({expr}) *json_encode()* |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4725 Encode {expr} as JSON and return this as a string. |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4726 The encoding is specified in: |
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4727 https://tools.ietf.org/html/rfc7159.html |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4728 Vim values are converted as follows: |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4729 Number decimal number |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4730 Float floating point number |
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4731 Float nan "NaN" |
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4732 Float inf "Infinity" |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4733 String in double quotes (possibly null) |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4734 Funcref not possible, error |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4735 List as an array (possibly null); when |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4736 used recursively: [] |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4737 Dict as an object (possibly null); when |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4738 used recursively: {} |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4739 v:false "false" |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4740 v:true "true" |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4741 v:none "null" |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4742 v:null "null" |
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4743 Note that NaN and Infinity are passed on as values. This is |
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4744 missing in the JSON standard, but several implementations do |
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4745 allow it. If not then you will get an error. |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4746 |
99 | 4747 keys({dict}) *keys()* |
685 | 4748 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 4749 arbitrary order. |
4750 | |
85 | 4751 *len()* *E701* |
55 | 4752 len({expr}) The result is a Number, which is the length of the argument. |
4753 When {expr} is a String or a Number the length in bytes is | |
4754 used, as with |strlen()|. | |
685 | 4755 When {expr} is a |List| the number of items in the |List| is |
55 | 4756 returned. |
685 | 4757 When {expr} is a |Dictionary| the number of entries in the |
4758 |Dictionary| is returned. | |
55 | 4759 Otherwise an error is given. |
4760 | |
7 | 4761 *libcall()* *E364* *E368* |
4762 libcall({libname}, {funcname}, {argument}) | |
4763 Call function {funcname} in the run-time library {libname} | |
4764 with single argument {argument}. | |
4765 This is useful to call functions in a library that you | |
4766 especially made to be used with Vim. Since only one argument | |
4767 is possible, calling standard library functions is rather | |
4768 limited. | |
4769 The result is the String returned by the function. If the | |
4770 function returns NULL, this will appear as an empty string "" | |
4771 to Vim. | |
4772 If the function returns a number, use libcallnr()! | |
4773 If {argument} is a number, it is passed to the function as an | |
4774 int; if {argument} is a string, it is passed as a | |
4775 null-terminated string. | |
4776 This function will fail in |restricted-mode|. | |
4777 | |
4778 libcall() allows you to write your own 'plug-in' extensions to | |
4779 Vim without having to recompile the program. It is NOT a | |
4780 means to call system functions! If you try to do so Vim will | |
4781 very probably crash. | |
4782 | |
4783 For Win32, the functions you write must be placed in a DLL | |
4784 and use the normal C calling convention (NOT Pascal which is | |
4785 used in Windows System DLLs). The function must take exactly | |
4786 one parameter, either a character pointer or a long integer, | |
4787 and must return a character pointer or NULL. The character | |
4788 pointer returned must point to memory that will remain valid | |
4789 after the function has returned (e.g. in static data in the | |
4790 DLL). If it points to allocated memory, that memory will | |
4791 leak away. Using a static buffer in the function should work, | |
4792 it's then freed when the DLL is unloaded. | |
4793 | |
4794 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 4795 crash! This also happens if the function returns a number, |
7 | 4796 because Vim thinks it's a pointer. |
4797 For Win32 systems, {libname} should be the filename of the DLL | |
4798 without the ".DLL" suffix. A full path is only required if | |
4799 the DLL is not in the usual places. | |
4800 For Unix: When compiling your own plugins, remember that the | |
4801 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4802 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 4803 feature is present} |
4804 Examples: > | |
4805 :echo libcall("libc.so", "getenv", "HOME") | |
4806 < | |
4807 *libcallnr()* | |
4808 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4809 Just like |libcall()|, but used for a function that returns an |
7 | 4810 int instead of a string. |
4811 {only in Win32 on some Unix versions, when the |+libcall| | |
4812 feature is present} | |
1621 | 4813 Examples: > |
4814 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 4815 :call libcallnr("libc.so", "printf", "Hello World!\n") |
4816 :call libcallnr("libc.so", "sleep", 10) | |
4817 < | |
4818 *line()* | |
4819 line({expr}) The result is a Number, which is the line number of the file | |
4820 position given with {expr}. The accepted positions are: | |
4821 . the cursor position | |
4822 $ the last line in the current buffer | |
4823 'x position of mark x (if the mark is not set, 0 is | |
4824 returned) | |
665 | 4825 w0 first line visible in current window |
4826 w$ last line visible in current window | |
1609 | 4827 v In Visual mode: the start of the Visual area (the |
4828 cursor is the end). When not in Visual mode | |
4829 returns the cursor position. Differs from |'<| in | |
4830 that it's updated right away. | |
1156 | 4831 Note that a mark in another file can be used. The line number |
4832 then applies to another buffer. | |
703 | 4833 To get the column number use |col()|. To get both use |
4834 |getpos()|. | |
7 | 4835 Examples: > |
4836 line(".") line number of the cursor | |
4837 line("'t") line number of mark t | |
4838 line("'" . marker) line number of mark marker | |
4839 < *last-position-jump* | |
4840 This autocommand jumps to the last known position in a file | |
4841 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4842 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 4843 |
7 | 4844 line2byte({lnum}) *line2byte()* |
4845 Return the byte count from the start of the buffer for line | |
4846 {lnum}. This includes the end-of-line character, depending on | |
4847 the 'fileformat' option for the current buffer. The first | |
3237 | 4848 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 4849 This can also be used to get the byte count for the line just |
4850 below the last line: > | |
4851 line2byte(line("$") + 1) | |
3237 | 4852 < This is the buffer size plus one. If 'fileencoding' is empty |
4853 it is the file size plus one. | |
7 | 4854 When {lnum} is invalid, or the |+byte_offset| feature has been |
4855 disabled at compile time, -1 is returned. | |
4856 Also see |byte2line()|, |go| and |:goto|. | |
4857 | |
4858 lispindent({lnum}) *lispindent()* | |
4859 Get the amount of indent for line {lnum} according the lisp | |
4860 indenting rules, as with 'lisp'. | |
4861 The indent is counted in spaces, the value of 'tabstop' is | |
4862 relevant. {lnum} is used just like in |getline()|. | |
4863 When {lnum} is invalid or Vim was not compiled the | |
4864 |+lispindent| feature, -1 is returned. | |
4865 | |
4866 localtime() *localtime()* | |
4867 Return the current time, measured as seconds since 1st Jan | |
4868 1970. See also |strftime()| and |getftime()|. | |
4869 | |
95 | 4870 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4871 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4872 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
|
4873 {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
|
4874 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4875 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4876 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4877 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4878 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4879 < 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
|
4880 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4881 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4882 |
1621 | 4883 log10({expr}) *log10()* |
4884 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
4885 {expr} must evaluate to a |Float| or a |Number|. | |
4886 Examples: > | |
4887 :echo log10(1000) | |
4888 < 3.0 > | |
4889 :echo log10(0.01) | |
4890 < -2.0 | |
4891 {only available when compiled with the |+float| feature} | |
4892 | |
3492 | 4893 luaeval({expr}[, {expr}]) *luaeval()* |
4894 Evaluate Lua expression {expr} and return its result converted | |
4895 to Vim data structures. Second {expr} may hold additional | |
4896 argument accessible as _A inside first {expr}. | |
4897 Strings are returned as they are. | |
4898 Boolean objects are converted to numbers. | |
4899 Numbers are converted to |Float| values if vim was compiled | |
4900 with |+float| and to numbers otherwise. | |
4901 Dictionaries and lists obtained by vim.eval() are returned | |
4902 as-is. | |
4903 Other objects are returned as zero without any errors. | |
4904 See |lua-luaeval| for more details. | |
4905 {only available when compiled with the |+lua| feature} | |
4906 | |
102 | 4907 map({expr}, {string}) *map()* |
685 | 4908 {expr} must be a |List| or a |Dictionary|. |
102 | 4909 Replace each item in {expr} with the result of evaluating |
4910 {string}. | |
4911 Inside {string} |v:val| has the value of the current item. | |
1998 | 4912 For a |Dictionary| |v:key| has the key of the current item |
4913 and for a |List| |v:key| has the index of the current item. | |
102 | 4914 Example: > |
4915 :call map(mylist, '"> " . v:val . " <"') | |
95 | 4916 < This puts "> " before and " <" after each item in "mylist". |
102 | 4917 |
158 | 4918 Note that {string} is the result of an expression and is then |
102 | 4919 used as an expression again. Often it is good to use a |
158 | 4920 |literal-string| to avoid having to double backslashes. You |
4921 still have to double ' quotes | |
102 | 4922 |
685 | 4923 The operation is done in-place. If you want a |List| or |
4924 |Dictionary| to remain unmodified make a copy first: > | |
3682 | 4925 :let tlist = map(copy(mylist), ' v:val . "\t"') |
102 | 4926 |
685 | 4927 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4928 When an error is encountered while evaluating {string} no |
4929 further items in {expr} are processed. | |
95 | 4930 |
4931 | |
2610 | 4932 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4933 When {dict} is omitted or zero: Return the rhs of mapping | |
4934 {name} in mode {mode}. The returned String has special | |
4935 characters translated like in the output of the ":map" command | |
4936 listing. | |
4937 | |
4938 When there is no mapping for {name}, an empty String is | |
4939 returned. | |
4940 | |
4941 The {name} can have special key names, like in the ":map" | |
4942 command. | |
4943 | |
644 | 4944 {mode} can be one of these strings: |
7 | 4945 "n" Normal |
2610 | 4946 "v" Visual (including Select) |
7 | 4947 "o" Operator-pending |
4948 "i" Insert | |
4949 "c" Cmd-line | |
2610 | 4950 "s" Select |
4951 "x" Visual | |
7 | 4952 "l" langmap |language-mapping| |
4953 "" Normal, Visual and Operator-pending | |
644 | 4954 When {mode} is omitted, the modes for "" are used. |
2610 | 4955 |
782 | 4956 When {abbr} is there and it is non-zero use abbreviations |
4957 instead of mappings. | |
2610 | 4958 |
4959 When {dict} is there and it is non-zero return a dictionary | |
4960 containing all the information of the mapping with the | |
4961 following items: | |
4962 "lhs" The {lhs} of the mapping. | |
4963 "rhs" The {rhs} of the mapping as typed. | |
4964 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 4965 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 4966 "expr" 1 for an expression mapping (|:map-<expr>|). |
4967 "buffer" 1 for a buffer local mapping (|:map-local|). | |
4968 "mode" Modes for which the mapping is defined. In | |
4969 addition to the modes mentioned above, these | |
4970 characters will be used: | |
4971 " " Normal, Visual and Operator-pending | |
4972 "!" Insert and Commandline mode | |
2642 | 4973 (|mapmode-ic|) |
2625 | 4974 "sid" The script local ID, used for <sid> mappings |
4975 (|<SID>|). | |
5555 | 4976 "nowait" Do not wait for other, longer mappings. |
4977 (|:map-<nowait>|). | |
2610 | 4978 |
7 | 4979 The mappings local to the current buffer are checked first, |
4980 then the global mappings. | |
626 | 4981 This function can be used to map a key even when it's already |
4982 mapped, and have it do the original mapping too. Sketch: > | |
4983 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
4984 | |
7 | 4985 |
782 | 4986 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 4987 Check if there is a mapping that matches with {name} in mode |
4988 {mode}. See |maparg()| for {mode} and special names in | |
4989 {name}. | |
782 | 4990 When {abbr} is there and it is non-zero use abbreviations |
4991 instead of mappings. | |
7 | 4992 A match happens with a mapping that starts with {name} and |
4993 with a mapping which is equal to the start of {name}. | |
4994 | |
1621 | 4995 matches mapping "a" "ab" "abc" ~ |
7 | 4996 mapcheck("a") yes yes yes |
4997 mapcheck("abc") yes yes yes | |
4998 mapcheck("ax") yes no no | |
4999 mapcheck("b") no no no | |
5000 | |
5001 The difference with maparg() is that mapcheck() finds a | |
5002 mapping that matches with {name}, while maparg() only finds a | |
5003 mapping for {name} exactly. | |
5004 When there is no mapping that starts with {name}, an empty | |
5005 String is returned. If there is one, the rhs of that mapping | |
5006 is returned. If there are several mappings that start with | |
5007 {name}, the rhs of one of them is returned. | |
5008 The mappings local to the current buffer are checked first, | |
5009 then the global mappings. | |
5010 This function can be used to check if a mapping can be added | |
5011 without being ambiguous. Example: > | |
5012 :if mapcheck("_vv") == "" | |
5013 : map _vv :set guifont=7x13<CR> | |
5014 :endif | |
5015 < This avoids adding the "_vv" mapping when there already is a | |
5016 mapping for "_v" or for "_vvv". | |
5017 | |
19 | 5018 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 5019 When {expr} is a |List| then this returns the index of the |
5020 first item where {pat} matches. Each item is used as a | |
692 | 5021 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 5022 Otherwise, {expr} is used as a String. The result is a |
95 | 5023 Number, which gives the index (byte offset) in {expr} where |
5024 {pat} matches. | |
685 | 5025 A match at the first character or |List| item returns zero. |
19 | 5026 If there is no match -1 is returned. |
2833 | 5027 For getting submatches see |matchlist()|. |
19 | 5028 Example: > |
95 | 5029 :echo match("testing", "ing") " results in 4 |
714 | 5030 :echo match([1, 'x'], '\a') " results in 1 |
95 | 5031 < See |string-match| for how {pat} is used. |
170 | 5032 *strpbrk()* |
1621 | 5033 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 5034 :let sepidx = match(line, '[.,;: \t]') |
5035 < *strcasestr()* | |
5036 Vim doesn't have a strcasestr() function. But you can add | |
5037 "\c" to the pattern to ignore case: > | |
5038 :let idx = match(haystack, '\cneedle') | |
5039 < | |
95 | 5040 If {start} is given, the search starts from byte index |
685 | 5041 {start} in a String or item {start} in a |List|. |
7 | 5042 The result, however, is still the index counted from the |
236 | 5043 first character/item. Example: > |
7 | 5044 :echo match("testing", "ing", 2) |
5045 < result is again "4". > | |
5046 :echo match("testing", "ing", 4) | |
5047 < result is again "4". > | |
5048 :echo match("testing", "t", 2) | |
5049 < result is "3". | |
694 | 5050 For a String, if {start} > 0 then it is like the string starts |
703 | 5051 {start} bytes later, thus "^" will match at {start}. Except |
5052 when {count} is given, then it's like matches before the | |
5053 {start} byte are ignored (this is a bit complicated to keep it | |
5054 backwards compatible). | |
95 | 5055 For a String, if {start} < 0, it will be set to 0. For a list |
5056 the index is counted from the end. | |
697 | 5057 If {start} is out of range ({start} > strlen({expr}) for a |
5058 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 5059 |
694 | 5060 When {count} is given use the {count}'th match. When a match |
697 | 5061 is found in a String the search for the next one starts one |
694 | 5062 character further. Thus this example results in 1: > |
5063 echo match("testing", "..", 0, 2) | |
5064 < In a |List| the search continues in the next item. | |
703 | 5065 Note that when {count} is added the way {start} works changes, |
5066 see above. | |
694 | 5067 |
7 | 5068 See |pattern| for the patterns that are accepted. |
5069 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 5070 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 5071 done like 'magic' is set and 'cpoptions' is empty. |
5072 | |
1326 | 5073 *matchadd()* *E798* *E799* *E801* |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5074 matchadd({group}, {pattern}[, {priority}[, {id}[, {dict}]]]) |
1326 | 5075 Defines a pattern to be highlighted in the current window (a |
5076 "match"). It will be highlighted with {group}. Returns an | |
5077 identification number (ID), which can be used to delete the | |
5078 match using |matchdelete()|. | |
5466 | 5079 Matching is case sensitive and magic, unless case sensitivity |
5080 or magicness are explicitly overridden in {pattern}. The | |
5081 'magic', 'smartcase' and 'ignorecase' options are not used. | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5082 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
|
5083 concealed. |
1326 | 5084 |
5085 The optional {priority} argument assigns a priority to the | |
1621 | 5086 match. A match with a high priority will have its |
1326 | 5087 highlighting overrule that of a match with a lower priority. |
5088 A priority is specified as an integer (negative numbers are no | |
5089 exception). If the {priority} argument is not specified, the | |
5090 default priority is 10. The priority of 'hlsearch' is zero, | |
5091 hence all matches with a priority greater than zero will | |
5092 overrule it. Syntax highlighting (see 'syntax') is a separate | |
5093 mechanism, and regardless of the chosen priority a match will | |
5094 always overrule syntax highlighting. | |
5095 | |
5096 The optional {id} argument allows the request for a specific | |
5097 match ID. If a specified ID is already taken, an error | |
5098 message will appear and the match will not be added. An ID | |
5099 is specified as a positive integer (zero excluded). IDs 1, 2 | |
5100 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
6947 | 5101 respectively. If the {id} argument is not specified or -1, |
1326 | 5102 |matchadd()| automatically chooses a free ID. |
5103 | |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5104 The optional {dict} argument allows for further custom |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5105 values. Currently this is used to specify a match specific |
6947 | 5106 conceal character that will be shown for |hl-Conceal| |
5107 highlighted matches. The dict can have the following members: | |
5108 | |
5109 conceal Special character to show instead of the | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5110 match (only for |hl-Conceal| highlighted |
6947 | 5111 matches, see |:syn-cchar|) |
5112 | |
1326 | 5113 The number of matches is not limited, as it is the case with |
5114 the |:match| commands. | |
5115 | |
5116 Example: > | |
5117 :highlight MyGroup ctermbg=green guibg=green | |
5118 :let m = matchadd("MyGroup", "TODO") | |
5119 < Deletion of the pattern: > | |
5120 :call matchdelete(m) | |
5121 | |
5122 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 5123 available from |getmatches()|. All matches can be deleted in |
1326 | 5124 one operation by |clearmatches()|. |
819 | 5125 |
6947 | 5126 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
5979 | 5127 Same as |matchadd()|, but requires a list of positions {pos} |
5128 instead of a pattern. This command is faster than |matchadd()| | |
5129 because it does not require to handle regular expressions and | |
5130 sets buffer line boundaries to redraw screen. It is supposed | |
5131 to be used when fast match additions and deletions are | |
5132 required, for example to highlight matching parentheses. | |
5133 | |
5134 The list {pos} can contain one of these items: | |
6007 | 5135 - A number. This whole line will be highlighted. The first |
5979 | 5136 line has number 1. |
5137 - A list with one number, e.g., [23]. The whole line with this | |
5138 number will be highlighted. | |
5139 - A list with two numbers, e.g., [23, 11]. The first number is | |
6007 | 5140 the line number, the second one is the column number (first |
5141 column is 1, the value must correspond to the byte index as | |
5142 |col()| would return). The character at this position will | |
5143 be highlighted. | |
5979 | 5144 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
6007 | 5145 the third number gives the length of the highlight in bytes. |
5979 | 5146 |
5147 The maximum number of positions is 8. | |
5148 | |
5149 Example: > | |
5150 :highlight MyGroup ctermbg=green guibg=green | |
5151 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
5152 < Deletion of the pattern: > | |
5153 :call matchdelete(m) | |
5154 | |
5155 < Matches added by |matchaddpos()| are returned by | |
5156 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
5157 value a list like the {pos} item. | |
5158 These matches cannot be set via |setmatches()|, however they | |
5159 can still be deleted by |clearmatches()|. | |
5160 | |
819 | 5161 matcharg({nr}) *matcharg()* |
856 | 5162 Selects the {nr} match item, as set with a |:match|, |
819 | 5163 |:2match| or |:3match| command. |
5164 Return a |List| with two elements: | |
5165 The name of the highlight group used | |
5166 The pattern used. | |
5167 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
5168 When there is no match item set returns ['', '']. | |
1326 | 5169 This is useful to save and restore a |:match|. |
5170 Highlighting matches using the |:match| commands are limited | |
5171 to three matches. |matchadd()| does not have this limitation. | |
5172 | |
5173 matchdelete({id}) *matchdelete()* *E802* *E803* | |
5174 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 5175 or one of the |:match| commands. Returns 0 if successful, |
1326 | 5176 otherwise -1. See example for |matchadd()|. All matches can |
5177 be deleted in one operation by |clearmatches()|. | |
819 | 5178 |
19 | 5179 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5180 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5181 after the match. Example: > |
7 | 5182 :echo matchend("testing", "ing") |
5183 < results in "7". | |
170 | 5184 *strspn()* *strcspn()* |
5185 Vim doesn't have a strspn() or strcspn() function, but you can | |
5186 do it with matchend(): > | |
5187 :let span = matchend(line, '[a-zA-Z]') | |
5188 :let span = matchend(line, '[^a-zA-Z]') | |
5189 < Except that -1 is returned when there are no matches. | |
5190 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5191 The {start}, if given, has the same meaning as for |match()|. > |
7 | 5192 :echo matchend("testing", "ing", 2) |
5193 < results in "7". > | |
5194 :echo matchend("testing", "ing", 5) | |
5195 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5196 When {expr} is a |List| the result is equal to |match()|. |
7 | 5197 |
158 | 5198 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5199 Same as |match()|, but return a |List|. The first item in the |
158 | 5200 list is the matched string, same as what matchstr() would |
5201 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 5202 in |:substitute|. When an optional submatch didn't match an |
5203 empty string is used. Example: > | |
5204 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
5205 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 5206 When there is no match an empty list is returned. |
5207 | |
19 | 5208 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 5209 Same as |match()|, but return the matched string. Example: > |
7 | 5210 :echo matchstr("testing", "ing") |
5211 < results in "ing". | |
5212 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5213 The {start}, if given, has the same meaning as for |match()|. > |
7 | 5214 :echo matchstr("testing", "ing", 2) |
5215 < results in "ing". > | |
5216 :echo matchstr("testing", "ing", 5) | |
5217 < result is "". | |
685 | 5218 When {expr} is a |List| then the matching item is returned. |
95 | 5219 The type isn't changed, it's not necessarily a String. |
7 | 5220 |
87 | 5221 *max()* |
5222 max({list}) Return the maximum value of all items in {list}. | |
5223 If {list} is not a list or one of the items in {list} cannot | |
5224 be used as a Number this results in an error. | |
685 | 5225 An empty |List| results in zero. |
87 | 5226 |
5227 *min()* | |
1215 | 5228 min({list}) Return the minimum value of all items in {list}. |
87 | 5229 If {list} is not a list or one of the items in {list} cannot |
5230 be used as a Number this results in an error. | |
685 | 5231 An empty |List| results in zero. |
87 | 5232 |
843 | 5233 *mkdir()* *E739* |
168 | 5234 mkdir({name} [, {path} [, {prot}]]) |
5235 Create directory {name}. | |
5236 If {path} is "p" then intermediate directories are created as | |
5237 necessary. Otherwise it must be "". | |
5238 If {prot} is given it is used to set the protection bits of | |
5239 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 5240 the user readable for others). Use 0700 to make it unreadable |
1702 | 5241 for others. This is only used for the last part of {name}. |
5242 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
5243 with 0755. | |
5244 Example: > | |
5245 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
5246 < This function is not available in the |sandbox|. | |
168 | 5247 Not available on all systems. To check use: > |
5248 :if exists("*mkdir") | |
5249 < | |
7 | 5250 *mode()* |
1621 | 5251 mode([expr]) Return a string that indicates the current mode. |
1661 | 5252 If [expr] is supplied and it evaluates to a non-zero Number or |
5253 a non-empty String (|non-zero-arg|), then the full mode is | |
5254 returned, otherwise only the first letter is returned. Note | |
5255 that " " and "0" are also non-empty strings. | |
1621 | 5256 |
7 | 5257 n Normal |
1621 | 5258 no Operator-pending |
7 | 5259 v Visual by character |
5260 V Visual by line | |
5261 CTRL-V Visual blockwise | |
5262 s Select by character | |
5263 S Select by line | |
5264 CTRL-S Select blockwise | |
5265 i Insert | |
1621 | 5266 R Replace |R| |
5267 Rv Virtual Replace |gR| | |
7 | 5268 c Command-line |
1621 | 5269 cv Vim Ex mode |gQ| |
5270 ce Normal Ex mode |Q| | |
7 | 5271 r Hit-enter prompt |
1621 | 5272 rm The -- more -- prompt |
5273 r? A |:confirm| query of some sort | |
5274 ! Shell or external command is executing | |
5275 This is useful in the 'statusline' option or when used | |
5276 with |remote_expr()| In most other places it always returns | |
5277 "c" or "n". | |
5278 Also see |visualmode()|. | |
7 | 5279 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5280 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5281 Evaluate MzScheme expression {expr} and return its result |
3492 | 5282 converted to Vim data structures. |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5283 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5284 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
|
5285 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5286 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
|
5287 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5288 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
|
5289 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5290 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5291 :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
|
5292 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5293 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5294 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5295 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5296 |
7 | 5297 nextnonblank({lnum}) *nextnonblank()* |
5298 Return the line number of the first line at or below {lnum} | |
5299 that is not blank. Example: > | |
5300 if getline(nextnonblank(1)) =~ "Java" | |
5301 < When {lnum} is invalid or there is no non-blank line at or | |
5302 below it, zero is returned. | |
5303 See also |prevnonblank()|. | |
5304 | |
4051 | 5305 nr2char({expr}[, {utf8}]) *nr2char()* |
7 | 5306 Return a string with a single character, which has the number |
5307 value {expr}. Examples: > | |
5308 nr2char(64) returns "@" | |
5309 nr2char(32) returns " " | |
4051 | 5310 < When {utf8} is omitted or zero, the current 'encoding' is used. |
5311 Example for "utf-8": > | |
7 | 5312 nr2char(300) returns I with bow character |
4051 | 5313 < With {utf8} set to 1, always return utf-8 characters. |
5314 Note that a NUL character in the file is specified with | |
7 | 5315 nr2char(10), because NULs are represented with newline |
5316 characters. nr2char(0) is a real NUL and terminates the | |
119 | 5317 string, thus results in an empty string. |
7 | 5318 |
3214 | 5319 or({expr}, {expr}) *or()* |
5320 Bitwise OR on the two arguments. The arguments are converted | |
5321 to a number. A List, Dict or Float argument causes an error. | |
5322 Example: > | |
5323 :let bits = or(bits, 0x80) | |
5324 | |
5325 | |
819 | 5326 pathshorten({expr}) *pathshorten()* |
5327 Shorten directory names in the path {expr} and return the | |
5328 result. The tail, the file name, is kept as-is. The other | |
5329 components in the path are reduced to single letters. Leading | |
5330 '~' and '.' characters are kept. Example: > | |
5331 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
5332 < ~/.v/a/myfile.vim ~ | |
5333 It doesn't matter if the path exists or not. | |
5334 | |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5335 perleval({expr}) *perleval()* |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5336 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
|
5337 its result converted to Vim data structures. If value can't be |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5338 converted, it is returned as a string Perl representation. |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5339 Note: If you want an array or hash, {expr} must return a |
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5340 reference to it. |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5341 Example: > |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5342 :echo perleval('[1 .. 4]') |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5343 < [1, 2, 3, 4] |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5344 {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
|
5345 |
1621 | 5346 pow({x}, {y}) *pow()* |
5347 Return the power of {x} to the exponent {y} as a |Float|. | |
5348 {x} and {y} must evaluate to a |Float| or a |Number|. | |
5349 Examples: > | |
5350 :echo pow(3, 3) | |
5351 < 27.0 > | |
5352 :echo pow(2, 16) | |
5353 < 65536.0 > | |
5354 :echo pow(32, 0.20) | |
5355 < 2.0 | |
5356 {only available when compiled with the |+float| feature} | |
5357 | |
667 | 5358 prevnonblank({lnum}) *prevnonblank()* |
5359 Return the line number of the first line at or above {lnum} | |
5360 that is not blank. Example: > | |
5361 let ind = indent(prevnonblank(v:lnum - 1)) | |
5362 < When {lnum} is invalid or there is no non-blank line at or | |
5363 above it, zero is returned. | |
5364 Also see |nextnonblank()|. | |
5365 | |
5366 | |
449 | 5367 printf({fmt}, {expr1} ...) *printf()* |
5368 Return a String with {fmt}, where "%" items are replaced by | |
5369 the formatted form of their respective arguments. Example: > | |
452 | 5370 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 5371 < May result in: |
452 | 5372 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 5373 |
5374 Often used items are: | |
856 | 5375 %s string |
3914 | 5376 %6S string right-aligned in 6 display cells |
653 | 5377 %6s string right-aligned in 6 bytes |
1621 | 5378 %.9s string truncated to 9 bytes |
5379 %c single byte | |
5380 %d decimal number | |
5381 %5d decimal number padded with spaces to 5 characters | |
5382 %x hex number | |
5383 %04x hex number padded with zeros to at least 4 characters | |
5384 %X hex number using upper case letters | |
5385 %o octal number | |
5386 %f floating point number in the form 123.456 | |
5387 %e floating point number in the form 1.234e3 | |
5388 %E floating point number in the form 1.234E3 | |
5389 %g floating point number, as %f or %e depending on value | |
5390 %G floating point number, as %f or %E depending on value | |
5391 %% the % character itself | |
449 | 5392 |
5393 Conversion specifications start with '%' and end with the | |
5394 conversion type. All other characters are copied unchanged to | |
5395 the result. | |
5396 | |
5397 The "%" starts a conversion specification. The following | |
452 | 5398 arguments appear in sequence: |
5399 | |
5400 % [flags] [field-width] [.precision] type | |
5401 | |
856 | 5402 flags |
452 | 5403 Zero or more of the following flags: |
5404 | |
449 | 5405 # The value should be converted to an "alternate |
5406 form". For c, d, and s conversions, this option | |
5407 has no effect. For o conversions, the precision | |
5408 of the number is increased to force the first | |
5409 character of the output string to a zero (except | |
5410 if a zero value is printed with an explicit | |
5411 precision of zero). | |
5412 For x and X conversions, a non-zero result has | |
5413 the string "0x" (or "0X" for X conversions) | |
5414 prepended to it. | |
452 | 5415 |
449 | 5416 0 (zero) Zero padding. For all conversions the converted |
5417 value is padded on the left with zeros rather | |
5418 than blanks. If a precision is given with a | |
5419 numeric conversion (d, o, x, and X), the 0 flag | |
5420 is ignored. | |
452 | 5421 |
449 | 5422 - A negative field width flag; the converted value |
5423 is to be left adjusted on the field boundary. | |
5424 The converted value is padded on the right with | |
5425 blanks, rather than on the left with blanks or | |
5426 zeros. A - overrides a 0 if both are given. | |
452 | 5427 |
449 | 5428 ' ' (space) A blank should be left before a positive |
5429 number produced by a signed conversion (d). | |
452 | 5430 |
449 | 5431 + A sign must always be placed before a number |
1621 | 5432 produced by a signed conversion. A + overrides |
449 | 5433 a space if both are used. |
452 | 5434 |
5435 field-width | |
5436 An optional decimal digit string specifying a minimum | |
653 | 5437 field width. If the converted value has fewer bytes |
5438 than the field width, it will be padded with spaces on | |
5439 the left (or right, if the left-adjustment flag has | |
5440 been given) to fill out the field width. | |
452 | 5441 |
5442 .precision | |
5443 An optional precision, in the form of a period '.' | |
5444 followed by an optional digit string. If the digit | |
5445 string is omitted, the precision is taken as zero. | |
5446 This gives the minimum number of digits to appear for | |
5447 d, o, x, and X conversions, or the maximum number of | |
653 | 5448 bytes to be printed from a string for s conversions. |
1621 | 5449 For floating point it is the number of digits after |
5450 the decimal point. | |
452 | 5451 |
5452 type | |
5453 A character that specifies the type of conversion to | |
5454 be applied, see below. | |
5455 | |
449 | 5456 A field width or precision, or both, may be indicated by an |
5457 asterisk '*' instead of a digit string. In this case, a | |
1621 | 5458 Number argument supplies the field width or precision. A |
449 | 5459 negative field width is treated as a left adjustment flag |
5460 followed by a positive field width; a negative precision is | |
5461 treated as though it were missing. Example: > | |
452 | 5462 :echo printf("%d: %.*s", nr, width, line) |
449 | 5463 < This limits the length of the text used from "line" to |
452 | 5464 "width" bytes. |
449 | 5465 |
856 | 5466 The conversion specifiers and their meanings are: |
452 | 5467 |
1621 | 5468 *printf-d* *printf-o* *printf-x* *printf-X* |
5469 doxX The Number argument is converted to signed decimal | |
449 | 5470 (d), unsigned octal (o), or unsigned hexadecimal (x |
5471 and X) notation. The letters "abcdef" are used for | |
5472 x conversions; the letters "ABCDEF" are used for X | |
452 | 5473 conversions. |
5474 The precision, if any, gives the minimum number of | |
5475 digits that must appear; if the converted value | |
5476 requires fewer digits, it is padded on the left with | |
5477 zeros. | |
5478 In no case does a non-existent or small field width | |
5479 cause truncation of a numeric field; if the result of | |
5480 a conversion is wider than the field width, the field | |
5481 is expanded to contain the conversion result. | |
5482 | |
1621 | 5483 *printf-c* |
452 | 5484 c The Number argument is converted to a byte, and the |
5485 resulting character is written. | |
5486 | |
1621 | 5487 *printf-s* |
452 | 5488 s The text of the String argument is used. If a |
5489 precision is specified, no more bytes than the number | |
5490 specified are used. | |
6583 | 5491 *printf-S* |
3914 | 5492 S The text of the String argument is used. If a |
5493 precision is specified, no more display cells than the | |
5494 number specified are used. Without the |+multi_byte| | |
5495 feature works just like 's'. | |
452 | 5496 |
1621 | 5497 *printf-f* *E807* |
5498 f The Float argument is converted into a string of the | |
5499 form 123.456. The precision specifies the number of | |
5500 digits after the decimal point. When the precision is | |
5501 zero the decimal point is omitted. When the precision | |
5502 is not specified 6 is used. A really big number | |
5503 (out of range or dividing by zero) results in "inf". | |
5504 "0.0 / 0.0" results in "nan". | |
5505 Example: > | |
5506 echo printf("%.2f", 12.115) | |
5507 < 12.12 | |
5508 Note that roundoff depends on the system libraries. | |
5509 Use |round()| when in doubt. | |
5510 | |
5511 *printf-e* *printf-E* | |
5512 e E The Float argument is converted into a string of the | |
5513 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
5514 precision specifies the number of digits after the | |
5515 decimal point, like with 'f'. | |
5516 | |
5517 *printf-g* *printf-G* | |
5518 g G The Float argument is converted like with 'f' if the | |
5519 value is between 0.001 (inclusive) and 10000000.0 | |
5520 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
5521 for 'G'. When no precision is specified superfluous | |
5522 zeroes and '+' signs are removed, except for the zero | |
5523 immediately after the decimal point. Thus 10000000.0 | |
5524 results in 1.0e7. | |
5525 | |
5526 *printf-%* | |
449 | 5527 % A '%' is written. No argument is converted. The |
5528 complete conversion specification is "%%". | |
452 | 5529 |
1668 | 5530 When a Number argument is expected a String argument is also |
5531 accepted and automatically converted. | |
5532 When a Float or String argument is expected a Number argument | |
5533 is also accepted and automatically converted. | |
5534 Any other argument type results in an error message. | |
449 | 5535 |
459 | 5536 *E766* *E767* |
449 | 5537 The number of {exprN} arguments must exactly match the number |
5538 of "%" items. If there are not sufficient or too many | |
452 | 5539 arguments an error is given. Up to 18 arguments can be used. |
449 | 5540 |
5541 | |
667 | 5542 pumvisible() *pumvisible()* |
5543 Returns non-zero when the popup menu is visible, zero | |
5544 otherwise. See |ins-completion-menu|. | |
712 | 5545 This can be used to avoid some things that would remove the |
5546 popup menu. | |
7 | 5547 |
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
5548 *E860* |
3682 | 5549 py3eval({expr}) *py3eval()* |
5550 Evaluate Python expression {expr} and return its result | |
5551 converted to Vim data structures. | |
5552 Numbers and strings are returned as they are (strings are | |
6647 | 5553 copied though, Unicode strings are additionally converted to |
3682 | 5554 'encoding'). |
5555 Lists are represented as Vim |List| type. | |
5556 Dictionaries are represented as Vim |Dictionary| type with | |
5557 keys converted to strings. | |
5558 {only available when compiled with the |+python3| feature} | |
5559 | |
5560 *E858* *E859* | |
5561 pyeval({expr}) *pyeval()* | |
5562 Evaluate Python expression {expr} and return its result | |
5563 converted to Vim data structures. | |
5564 Numbers and strings are returned as they are (strings are | |
5565 copied though). | |
5566 Lists are represented as Vim |List| type. | |
3830 | 5567 Dictionaries are represented as Vim |Dictionary| type, |
5568 non-string keys result in error. | |
3682 | 5569 {only available when compiled with the |+python| feature} |
5570 | |
114 | 5571 *E726* *E727* |
99 | 5572 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 5573 Returns a |List| with Numbers: |
99 | 5574 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
5575 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
5576 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
5577 {max}] (increasing {expr} with {stride} each time, not | |
5578 producing a value past {max}). | |
336 | 5579 When the maximum is one before the start the result is an |
5580 empty list. When the maximum is more than one before the | |
5581 start this is an error. | |
99 | 5582 Examples: > |
856 | 5583 range(4) " [0, 1, 2, 3] |
99 | 5584 range(2, 4) " [2, 3, 4] |
5585 range(2, 9, 3) " [2, 5, 8] | |
856 | 5586 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 5587 range(0) " [] |
5588 range(2, 0) " error! | |
99 | 5589 < |
158 | 5590 *readfile()* |
168 | 5591 readfile({fname} [, {binary} [, {max}]]) |
685 | 5592 Read file {fname} and return a |List|, each line of the file |
5593 as an item. Lines broken at NL characters. Macintosh files | |
158 | 5594 separated with CR will result in a single long line (unless a |
5595 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
|
5596 All NUL characters are replaced with a NL character. |
6918 | 5597 When {binary} contains "b" binary mode is used: |
158 | 5598 - When the last line ends in a NL an extra empty list item is |
5599 added. | |
5600 - No CR characters are removed. | |
5601 Otherwise: | |
5602 - CR characters that appear before a NL are removed. | |
5603 - 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
|
5604 - 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
|
5605 removed from the text. |
168 | 5606 When {max} is given this specifies the maximum number of lines |
5607 to be read. Useful if you only want to check the first ten | |
5608 lines of a file: > | |
5609 :for line in readfile(fname, '', 10) | |
5610 : if line =~ 'Date' | echo line | endif | |
5611 :endfor | |
233 | 5612 < When {max} is negative -{max} lines from the end of the file |
5613 are returned, or as many as there are. | |
5614 When {max} is zero the result is an empty list. | |
168 | 5615 Note that without {max} the whole file is read into memory. |
5616 Also note that there is no recognition of encoding. Read a | |
5617 file into a buffer if you need to. | |
158 | 5618 When the file can't be opened an error message is given and |
5619 the result is an empty list. | |
5620 Also see |writefile()|. | |
5621 | |
794 | 5622 reltime([{start} [, {end}]]) *reltime()* |
5623 Return an item that represents a time value. The format of | |
5624 the item depends on the system. It can be passed to | |
5625 |reltimestr()| to convert it to a string. | |
5626 Without an argument it returns the current time. | |
5627 With one argument is returns the time passed since the time | |
5628 specified in the argument. | |
843 | 5629 With two arguments it returns the time passed between {start} |
794 | 5630 and {end}. |
5631 The {start} and {end} arguments must be values returned by | |
5632 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5633 {only available when compiled with the |+reltime| feature} |
794 | 5634 |
5635 reltimestr({time}) *reltimestr()* | |
5636 Return a String that represents the time value of {time}. | |
5637 This is the number of seconds, a dot and the number of | |
5638 microseconds. Example: > | |
5639 let start = reltime() | |
5640 call MyFunction() | |
5641 echo reltimestr(reltime(start)) | |
5642 < Note that overhead for the commands will be added to the time. | |
5643 The accuracy depends on the system. | |
1156 | 5644 Leading spaces are used to make the string align nicely. You |
5645 can use split() to remove it. > | |
5646 echo split(reltimestr(reltime(start)))[0] | |
5647 < 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
|
5648 {only available when compiled with the |+reltime| feature} |
794 | 5649 |
7 | 5650 *remote_expr()* *E449* |
5651 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 5652 Send the {string} to {server}. The string is sent as an |
7 | 5653 expression and the result is returned after evaluation. |
714 | 5654 The result must be a String or a |List|. A |List| is turned |
5655 into a String by joining the items with a line break in | |
5656 between (not at the end), like with join(expr, "\n"). | |
7 | 5657 If {idvar} is present, it is taken as the name of a |
5658 variable and a {serverid} for later use with | |
5659 remote_read() is stored there. | |
5660 See also |clientserver| |RemoteReply|. | |
5661 This function is not available in the |sandbox|. | |
5662 {only available when compiled with the |+clientserver| feature} | |
5663 Note: Any errors will cause a local error message to be issued | |
5664 and the result will be the empty string. | |
5665 Examples: > | |
5666 :echo remote_expr("gvim", "2+2") | |
5667 :echo remote_expr("gvim1", "b:current_syntax") | |
5668 < | |
5669 | |
5670 remote_foreground({server}) *remote_foreground()* | |
5671 Move the Vim server with the name {server} to the foreground. | |
5672 This works like: > | |
5673 remote_expr({server}, "foreground()") | |
5674 < Except that on Win32 systems the client does the work, to work | |
5675 around the problem that the OS doesn't always allow the server | |
5676 to bring itself to the foreground. | |
574 | 5677 Note: This does not restore the window if it was minimized, |
5678 like foreground() does. | |
7 | 5679 This function is not available in the |sandbox|. |
5680 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
5681 Win32 console version} | |
5682 | |
5683 | |
5684 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
5685 Returns a positive number if there are available strings | |
5686 from {serverid}. Copies any reply string into the variable | |
1621 | 5687 {retvar} if specified. {retvar} must be a string with the |
7 | 5688 name of a variable. |
5689 Returns zero if none are available. | |
5690 Returns -1 if something is wrong. | |
5691 See also |clientserver|. | |
5692 This function is not available in the |sandbox|. | |
5693 {only available when compiled with the |+clientserver| feature} | |
5694 Examples: > | |
5695 :let repl = "" | |
5696 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
5697 | |
5698 remote_read({serverid}) *remote_read()* | |
5699 Return the oldest available reply from {serverid} and consume | |
5700 it. It blocks until a reply is available. | |
5701 See also |clientserver|. | |
5702 This function is not available in the |sandbox|. | |
5703 {only available when compiled with the |+clientserver| feature} | |
5704 Example: > | |
5705 :echo remote_read(id) | |
5706 < | |
5707 *remote_send()* *E241* | |
5708 remote_send({server}, {string} [, {idvar}]) | |
1621 | 5709 Send the {string} to {server}. The string is sent as input |
22 | 5710 keys and the function returns immediately. At the Vim server |
5711 the keys are not mapped |:map|. | |
667 | 5712 If {idvar} is present, it is taken as the name of a variable |
5713 and a {serverid} for later use with remote_read() is stored | |
5714 there. | |
7 | 5715 See also |clientserver| |RemoteReply|. |
5716 This function is not available in the |sandbox|. | |
5717 {only available when compiled with the |+clientserver| feature} | |
5718 Note: Any errors will be reported in the server and may mess | |
5719 up the display. | |
5720 Examples: > | |
5721 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
5722 \ remote_read(serverid) | |
5723 | |
5724 :autocmd NONE RemoteReply * | |
5725 \ echo remote_read(expand("<amatch>")) | |
5726 :echo remote_send("gvim", ":sleep 10 | echo ". | |
5727 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 5728 < |
79 | 5729 remove({list}, {idx} [, {end}]) *remove()* |
685 | 5730 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
|
5731 return the item. |
79 | 5732 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5733 return a List with these items. When {idx} points to the same |
79 | 5734 item as {end} a list with one item is returned. When {end} |
5735 points to an item before {idx} this is an error. | |
5736 See |list-index| for possible values of {idx} and {end}. | |
55 | 5737 Example: > |
5738 :echo "last item: " . remove(mylist, -1) | |
79 | 5739 :call remove(mylist, 0, 9) |
99 | 5740 remove({dict}, {key}) |
5741 Remove the entry from {dict} with key {key}. Example: > | |
5742 :echo "removed " . remove(dict, "one") | |
5743 < If there is no {key} in {dict} this is an error. | |
5744 | |
5745 Use |delete()| to remove a file. | |
55 | 5746 |
7 | 5747 rename({from}, {to}) *rename()* |
5748 Rename the file by the name {from} to the name {to}. This | |
5749 should also work to move files across file systems. The | |
5750 result is a Number, which is 0 if the file was renamed | |
5751 successfully, and non-zero when the renaming failed. | |
1851 | 5752 NOTE: If {to} exists it is overwritten without warning. |
7 | 5753 This function is not available in the |sandbox|. |
5754 | |
18 | 5755 repeat({expr}, {count}) *repeat()* |
5756 Repeat {expr} {count} times and return the concatenated | |
5757 result. Example: > | |
843 | 5758 :let separator = repeat('-', 80) |
18 | 5759 < When {count} is zero or negative the result is empty. |
685 | 5760 When {expr} is a |List| the result is {expr} concatenated |
1621 | 5761 {count} times. Example: > |
79 | 5762 :let longlist = repeat(['a', 'b'], 3) |
5763 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 5764 |
82 | 5765 |
7 | 5766 resolve({filename}) *resolve()* *E655* |
5767 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
5768 returns the path the shortcut points to in a simplified form. | |
5769 On Unix, repeat resolving symbolic links in all path | |
5770 components of {filename} and return the simplified result. | |
5771 To cope with link cycles, resolving of symbolic links is | |
5772 stopped after 100 iterations. | |
5773 On other systems, return the simplified {filename}. | |
5774 The simplification step is done as by |simplify()|. | |
5775 resolve() keeps a leading path component specifying the | |
5776 current directory (provided the result is still a relative | |
5777 path name) and also keeps a trailing path separator. | |
5778 | |
82 | 5779 *reverse()* |
1621 | 5780 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 5781 {list}. |
5782 If you want a list to remain unmodified make a copy first: > | |
5783 :let revlist = reverse(copy(mylist)) | |
5784 | |
1621 | 5785 round({expr}) *round()* |
1668 | 5786 Round off {expr} to the nearest integral value and return it |
1621 | 5787 as a |Float|. If {expr} lies halfway between two integral |
5788 values, then use the larger one (away from zero). | |
5789 {expr} must evaluate to a |Float| or a |Number|. | |
5790 Examples: > | |
5791 echo round(0.456) | |
5792 < 0.0 > | |
5793 echo round(4.5) | |
5794 < 5.0 > | |
5795 echo round(-4.5) | |
5796 < -5.0 | |
5797 {only available when compiled with the |+float| feature} | |
3996 | 5798 |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5799 screenattr(row, col) *screenattr()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5800 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
|
5801 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
|
5802 attribute at other positions. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5803 |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5804 screenchar(row, col) *screenchar()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5805 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
|
5806 [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
|
5807 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
|
5808 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
|
5809 The character excludes composing characters. For double-byte |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5810 encodings it may only be the first byte. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5811 This is mainly to be used for testing. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5812 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
|
5813 |
3996 | 5814 screencol() *screencol()* |
5815 The result is a Number, which is the current screen column of | |
5816 the cursor. The leftmost column has number 1. | |
5817 This function is mainly used for testing. | |
5818 | |
5819 Note: Always returns the current screen column, thus if used | |
5820 in a command (e.g. ":echo screencol()") it will return the | |
5821 column inside the command line, which is 1 when the command is | |
5822 executed. To get the cursor position in the file use one of | |
5823 the following mappings: > | |
5824 nnoremap <expr> GG ":echom ".screencol()."\n" | |
5825 nnoremap <silent> GG :echom screencol()<CR> | |
5826 < | |
5827 screenrow() *screenrow()* | |
5828 The result is a Number, which is the current screen row of the | |
5829 cursor. The top line has number one. | |
5830 This function is mainly used for testing. | |
5831 | |
5832 Note: Same restrictions as with |screencol()|. | |
5833 | |
1496 | 5834 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 5835 Search for regexp pattern {pattern}. The search starts at the |
119 | 5836 cursor position (you can use |cursor()| to set it). |
707 | 5837 |
3967 | 5838 When a match has been found its line number is returned. |
3312 | 5839 If there is no match a 0 is returned and the cursor doesn't |
5840 move. No error message is given. | |
5841 | |
7 | 5842 {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
|
5843 'b' search Backward instead of forward |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5844 'c' accept a match at the Cursor position |
712 | 5845 'e' move to the End of the match |
20 | 5846 '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
|
5847 '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
|
5848 '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
|
5849 '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
|
5850 '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
|
5851 'z' start searching at the cursor column instead of zero |
7 | 5852 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
5853 | |
444 | 5854 If the 's' flag is supplied, the ' mark is set, only if the |
5855 cursor is moved. The 's' flag cannot be combined with the 'n' | |
5856 flag. | |
5857 | |
1156 | 5858 '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
|
5859 |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5860 When the 'z' flag is not given, searching always starts in |
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5861 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
|
5862 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
|
5863 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
|
5864 one column further. |
1156 | 5865 |
692 | 5866 When the {stopline} argument is given then the search stops |
5867 after searching this line. This is useful to restrict the | |
5868 search to a range of lines. Examples: > | |
5869 let match = search('(', 'b', line("w0")) | |
5870 let end = search('END', '', line("w$")) | |
5871 < When {stopline} is used and it is not zero this also implies | |
5872 that the search does not wrap around the end of the file. | |
1496 | 5873 A zero value is equal to not giving the argument. |
5874 | |
5875 When the {timeout} argument is given the search stops when | |
3513 | 5876 more than this many milliseconds have passed. Thus when |
1496 | 5877 {timeout} is 500 the search stops after half a second. |
5878 The value must not be negative. A zero value is like not | |
5879 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
|
5880 {only available when compiled with the |+reltime| feature} |
692 | 5881 |
714 | 5882 *search()-sub-match* |
5883 With the 'p' flag the returned value is one more than the | |
5884 first sub-match in \(\). One if none of them matched but the | |
5885 whole pattern did match. | |
712 | 5886 To get the column number too use |searchpos()|. |
5887 | |
20 | 5888 The cursor will be positioned at the match, unless the 'n' |
707 | 5889 flag is used. |
7 | 5890 |
5891 Example (goes over all files in the argument list): > | |
5892 :let n = 1 | |
5893 :while n <= argc() " loop over all files in arglist | |
5894 : exe "argument " . n | |
5895 : " start at the last char in the file and wrap for the | |
5896 : " first search to find match at start of file | |
5897 : normal G$ | |
5898 : let flags = "w" | |
5899 : while search("foo", flags) > 0 | |
1621 | 5900 : s/foo/bar/g |
7 | 5901 : let flags = "W" |
5902 : endwhile | |
5903 : update " write the file if modified | |
5904 : let n = n + 1 | |
5905 :endwhile | |
5906 < | |
712 | 5907 Example for using some flags: > |
5908 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
5909 < This will search for the keywords "if", "else", and "endif" | |
5910 under or after the cursor. Because of the 'p' flag, it | |
5911 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
5912 if the search fails. With the cursor on the first word of the | |
5913 line: | |
5914 if (foo == 0) | let foo = foo + 1 | endif ~ | |
5915 the function returns 1. Without the 'c' flag, the function | |
5916 finds the "endif" and returns 3. The same thing happens | |
5917 without the 'e' flag if the cursor is on the "f" of "if". | |
5918 The 'n' flag tells the function not to move the cursor. | |
5919 | |
504 | 5920 |
523 | 5921 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
5922 Search for the declaration of {name}. | |
856 | 5923 |
523 | 5924 With a non-zero {global} argument it works like |gD|, find |
5925 first match in the file. Otherwise it works like |gd|, find | |
5926 first match in the function. | |
5927 | |
5928 With a non-zero {thisblock} argument matches in a {} block | |
5929 that ends before the cursor position are ignored. Avoids | |
5930 finding variable declarations only valid in another scope. | |
5931 | |
504 | 5932 Moves the cursor to the found match. |
5933 Returns zero for success, non-zero for failure. | |
5934 Example: > | |
5935 if searchdecl('myvar') == 0 | |
5936 echo getline('.') | |
5937 endif | |
5938 < | |
7 | 5939 *searchpair()* |
1496 | 5940 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
5941 [, {stopline} [, {timeout}]]]]) | |
7 | 5942 Search for the match of a nested start-end pair. This can be |
5943 used to find the "endif" that matches an "if", while other | |
5944 if/endif pairs in between are ignored. | |
677 | 5945 The search starts at the cursor. The default is to search |
5946 forward, include 'b' in {flags} to search backward. | |
5947 If a match is found, the cursor is positioned at it and the | |
5948 line number is returned. If no match is found 0 or -1 is | |
5949 returned and the cursor doesn't move. No error message is | |
5950 given. | |
7 | 5951 |
5952 {start}, {middle} and {end} are patterns, see |pattern|. They | |
5953 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
5954 {middle} is not empty, it is found when searching from either | |
5955 direction, but only when not in a nested start-end pair. A | |
5956 typical use is: > | |
5957 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
5958 < By leaving {middle} empty the "else" is skipped. | |
5959 | |
712 | 5960 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
5961 |search()|. Additionally: | |
7 | 5962 'r' Repeat until no more matches found; will find the |
1621 | 5963 outer pair. Implies the 'W' flag. |
5964 'm' Return number of matches instead of line number with | |
712 | 5965 the match; will be > 1 when 'r' is used. |
1621 | 5966 Note: it's nearly always a good idea to use the 'W' flag, to |
5967 avoid wrapping around the end of the file. | |
7 | 5968 |
5969 When a match for {start}, {middle} or {end} is found, the | |
5970 {skip} expression is evaluated with the cursor positioned on | |
5971 the start of the match. It should return non-zero if this | |
5972 match is to be skipped. E.g., because it is inside a comment | |
5973 or a string. | |
5974 When {skip} is omitted or empty, every match is accepted. | |
5975 When evaluating {skip} causes an error the search is aborted | |
5976 and -1 returned. | |
5977 | |
1496 | 5978 For {stopline} and {timeout} see |search()|. |
692 | 5979 |
7 | 5980 The value of 'ignorecase' is used. 'magic' is ignored, the |
5981 patterns are used like it's on. | |
5982 | |
5983 The search starts exactly at the cursor. A match with | |
5984 {start}, {middle} or {end} at the next character, in the | |
5985 direction of searching, is the first one found. Example: > | |
5986 if 1 | |
5987 if 2 | |
5988 endif 2 | |
5989 endif 1 | |
5990 < When starting at the "if 2", with the cursor on the "i", and | |
5991 searching forwards, the "endif 2" is found. When starting on | |
5992 the character just before the "if 2", the "endif 1" will be | |
1621 | 5993 found. That's because the "if 2" will be found first, and |
7 | 5994 then this is considered to be a nested if/endif from "if 2" to |
5995 "endif 2". | |
5996 When searching backwards and {end} is more than one character, | |
5997 it may be useful to put "\zs" at the end of the pattern, so | |
5998 that when the cursor is inside a match with the end it finds | |
5999 the matching start. | |
6000 | |
6001 Example, to find the "endif" command in a Vim script: > | |
6002 | |
6003 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
6004 \ 'getline(".") =~ "^\\s*\""') | |
6005 | |
6006 < The cursor must be at or after the "if" for which a match is | |
6007 to be found. Note that single-quote strings are used to avoid | |
6008 having to double the backslashes. The skip expression only | |
6009 catches comments at the start of a line, not after a command. | |
6010 Also, a word "en" or "if" halfway a line is considered a | |
6011 match. | |
6012 Another example, to search for the matching "{" of a "}": > | |
6013 | |
6014 :echo searchpair('{', '', '}', 'bW') | |
6015 | |
6016 < This works when the cursor is at or before the "}" for which a | |
6017 match is to be found. To reject matches that syntax | |
6018 highlighting recognized as strings: > | |
6019 | |
6020 :echo searchpair('{', '', '}', 'bW', | |
6021 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
6022 < | |
667 | 6023 *searchpairpos()* |
1496 | 6024 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
6025 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6026 Same as |searchpair()|, but returns a |List| with the line and |
685 | 6027 column position of the match. The first element of the |List| |
6028 is the line number and the second element is the byte index of | |
667 | 6029 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
|
6030 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6031 |
667 | 6032 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
6033 < | |
6034 See |match-parens| for a bigger and more useful example. | |
6035 | |
1496 | 6036 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 6037 Same as |search()|, but returns a |List| with the line and |
685 | 6038 column position of the match. The first element of the |List| |
6039 is the line number and the second element is the byte index of | |
6040 the column position of the match. If no match is found, | |
6041 returns [0, 0]. | |
714 | 6042 Example: > |
6043 :let [lnum, col] = searchpos('mypattern', 'n') | |
6044 | |
6045 < When the 'p' flag is given then there is an extra item with | |
6046 the sub-pattern match number |search()-sub-match|. Example: > | |
6047 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
6048 < In this example "submatch" is 2 when a lowercase letter is | |
6049 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
6050 | |
7 | 6051 server2client( {clientid}, {string}) *server2client()* |
6052 Send a reply string to {clientid}. The most recent {clientid} | |
6053 that sent a string can be retrieved with expand("<client>"). | |
6054 {only available when compiled with the |+clientserver| feature} | |
6055 Note: | |
6056 This id has to be stored before the next command can be | |
236 | 6057 received. I.e. before returning from the received command and |
7 | 6058 before calling any commands that waits for input. |
6059 See also |clientserver|. | |
6060 Example: > | |
6061 :echo server2client(expand("<client>"), "HELLO") | |
6062 < | |
6063 serverlist() *serverlist()* | |
6064 Return a list of available server names, one per line. | |
6065 When there are no servers or the information is not available | |
6066 an empty string is returned. See also |clientserver|. | |
6067 {only available when compiled with the |+clientserver| feature} | |
6068 Example: > | |
6069 :echo serverlist() | |
6070 < | |
6071 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
6072 Set option or local variable {varname} in buffer {expr} to | |
6073 {val}. | |
6074 This also works for a global or local window option, but it | |
6075 doesn't work for a global or local window variable. | |
6076 For a local window option the global value is unchanged. | |
6077 For the use of {expr}, see |bufname()| above. | |
6078 Note that the variable name without "b:" must be used. | |
6079 Examples: > | |
6080 :call setbufvar(1, "&mod", 1) | |
6081 :call setbufvar("todo", "myvar", "foobar") | |
6082 < This function is not available in the |sandbox|. | |
6083 | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6084 setcharsearch({dict}) *setcharsearch()* |
6991 | 6085 Set the current character search information to {dict}, |
6086 which contains one or more of the following entries: | |
6087 | |
6088 char character which will be used for a subsequent | |
6089 |,| or |;| command; an empty string clears the | |
6090 character search | |
6091 forward direction of character search; 1 for forward, | |
6092 0 for backward | |
6093 until type of character search; 1 for a |t| or |T| | |
6094 character search, 0 for an |f| or |F| | |
6095 character search | |
6096 | |
6097 This can be useful to save/restore a user's character search | |
6098 from a script: > | |
6099 :let prevsearch = getcharsearch() | |
6100 :" Perform a command which clobbers user's search | |
6101 :call setcharsearch(prevsearch) | |
6102 < Also see |getcharsearch()|. | |
6103 | |
7 | 6104 setcmdpos({pos}) *setcmdpos()* |
6105 Set the cursor position in the command line to byte position | |
1621 | 6106 {pos}. The first position is 1. |
7 | 6107 Use |getcmdpos()| to obtain the current position. |
6108 Only works while editing the command line, thus you must use | |
99 | 6109 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
6110 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
6111 set after the command line is set to the expression. For | |
6112 |c_CTRL-R_=| it is set after evaluating the expression but | |
6113 before inserting the resulting text. | |
7 | 6114 When the number is too big the cursor is put at the end of the |
6115 line. A number smaller than one has undefined results. | |
6116 Returns 0 when successful, 1 when not editing the command | |
6117 line. | |
6118 | |
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6119 setfperm({fname}, {mode}) *setfperm()* *chmod* |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6120 Set the file permissions for {fname} to {mode}. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6121 {mode} must be a string with 9 characters. It is of the form |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6122 "rwxrwxrwx", where each group of "rwx" flags represent, in |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6123 turn, the permissions of the owner of the file, the group the |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6124 file belongs to, and other users. A '-' character means the |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6125 permission is off, any other character means on. Multi-byte |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6126 characters are not supported. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6127 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6128 For example "rw-r-----" means read-write for the user, |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6129 readable by the group, not accessible by others. "xx-x-----" |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6130 would do the same thing. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6131 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6132 Returns non-zero for success, zero for failure. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6133 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6134 To read permissions see |getfperm()|. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6135 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6136 |
1621 | 6137 setline({lnum}, {text}) *setline()* |
3312 | 6138 Set line {lnum} of the current buffer to {text}. To insert |
6139 lines use |append()|. | |
236 | 6140 {lnum} is used like with |getline()|. |
1621 | 6141 When {lnum} is just below the last line the {text} will be |
282 | 6142 added as a new line. |
236 | 6143 If this succeeds, 0 is returned. If this fails (most likely |
6144 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 6145 :call setline(5, strftime("%c")) |
1621 | 6146 < When {text} is a |List| then line {lnum} and following lines |
282 | 6147 will be set to the items in the list. Example: > |
6148 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
6149 < This is equivalent to: > | |
3465 | 6150 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
282 | 6151 : call setline(n, l) |
6152 :endfor | |
7 | 6153 < Note: The '[ and '] marks are not set. |
6154 | |
647 | 6155 setloclist({nr}, {list} [, {action}]) *setloclist()* |
6156 Create or replace or add to the location list for window {nr}. | |
6157 When {nr} is zero the current window is used. For a location | |
648 | 6158 list window, the displayed location list is modified. For an |
6159 invalid window number {nr}, -1 is returned. | |
1326 | 6160 Otherwise, same as |setqflist()|. |
6161 Also see |location-list|. | |
6162 | |
6163 setmatches({list}) *setmatches()* | |
6164 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 6165 if successful, otherwise -1. All current matches are cleared |
1326 | 6166 before the list is restored. See example for |getmatches()|. |
230 | 6167 |
707 | 6168 *setpos()* |
6169 setpos({expr}, {list}) | |
6170 Set the position for {expr}. Possible values: | |
6171 . the cursor | |
6172 'x mark x | |
6173 | |
5938 | 6174 {list} must be a |List| with four or five numbers: |
707 | 6175 [bufnum, lnum, col, off] |
5938 | 6176 [bufnum, lnum, col, off, curswant] |
707 | 6177 |
1621 | 6178 "bufnum" is the buffer number. Zero can be used for the |
856 | 6179 current buffer. Setting the cursor is only possible for |
707 | 6180 the current buffer. To set a mark in another buffer you can |
6181 use the |bufnr()| function to turn a file name into a buffer | |
6182 number. | |
798 | 6183 Does not change the jumplist. |
707 | 6184 |
6185 "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
|
6186 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
|
6187 smaller than 1 then 1 is used. |
707 | 6188 |
6189 The "off" number is only used when 'virtualedit' is set. Then | |
6190 it is the offset in screen columns from the start of the | |
1266 | 6191 character. E.g., a position within a <Tab> or after the last |
707 | 6192 character. |
6193 | |
5938 | 6194 The "curswant" number is only used when setting the cursor |
6195 position. It sets the preferred column for when moving the | |
6196 cursor vertically. When the "curswant" number is missing the | |
6197 preferred column is not set. When it is present and setting a | |
6198 mark position it is not used. | |
6199 | |
5555 | 6200 Note that for '< and '> changing the line number may result in |
6201 the marks to be effectively be swapped, so that '< is always | |
6202 before '>. | |
6203 | |
1533 | 6204 Returns 0 when the position could be set, -1 otherwise. |
6205 An error message is given if {expr} is invalid. | |
6206 | |
5944 | 6207 Also see |getpos()| and |getcurpos()|. |
707 | 6208 |
1156 | 6209 This does not restore the preferred column for moving |
5938 | 6210 vertically; if you set the cursor position with this, |j| and |
6211 |k| motions will jump to previous columns! Use |cursor()| to | |
6212 also set the preferred column. Also see the "curswant" key in | |
6213 |winrestview()|. | |
1156 | 6214 |
707 | 6215 |
277 | 6216 setqflist({list} [, {action}]) *setqflist()* |
647 | 6217 Create or replace or add to the quickfix list using the items |
6218 in {list}. Each item in {list} is a dictionary. | |
6219 Non-dictionary items in {list} are ignored. Each dictionary | |
6220 item can contain the following entries: | |
230 | 6221 |
1065 | 6222 bufnr buffer number; must be the number of a valid |
1621 | 6223 buffer |
1065 | 6224 filename name of a file; only used when "bufnr" is not |
1621 | 6225 present or it is invalid. |
230 | 6226 lnum line number in the file |
233 | 6227 pattern search pattern used to locate the error |
230 | 6228 col column number |
233 | 6229 vcol when non-zero: "col" is visual column |
856 | 6230 when zero: "col" is byte index |
233 | 6231 nr error number |
230 | 6232 text description of the error |
233 | 6233 type single-character error type, 'E', 'W', etc. |
6234 | |
6235 The "col", "vcol", "nr", "type" and "text" entries are | |
6236 optional. Either "lnum" or "pattern" entry can be used to | |
6237 locate a matching error line. | |
1065 | 6238 If the "filename" and "bufnr" entries are not present or |
6239 neither the "lnum" or "pattern" entries are present, then the | |
6240 item will not be handled as an error line. | |
230 | 6241 If both "pattern" and "lnum" are present then "pattern" will |
6242 be used. | |
2152 | 6243 If you supply an empty {list}, the quickfix list will be |
6244 cleared. | |
1065 | 6245 Note that the list is not exactly the same as what |
6246 |getqflist()| returns. | |
230 | 6247 |
277 | 6248 If {action} is set to 'a', then the items from {list} are |
6249 added to the existing quickfix list. If there is no existing | |
6250 list, then a new list is created. If {action} is set to 'r', | |
6251 then the items from the current quickfix list are replaced | |
6252 with the items from {list}. If {action} is not present or is | |
6253 set to ' ', then a new list is created. | |
6254 | |
230 | 6255 Returns zero for success, -1 for failure. |
6256 | |
6257 This function can be used to create a quickfix list | |
6258 independent of the 'errorformat' setting. Use a command like | |
6259 ":cc 1" to jump to the first position. | |
6260 | |
6261 | |
7 | 6262 *setreg()* |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
6263 setreg({regname}, {value} [, {options}]) |
7 | 6264 Set the register {regname} to {value}. |
5798 | 6265 {value} may be any value returned by |getreg()|, including |
6266 a |List|. | |
7 | 6267 If {options} contains "a" or {regname} is upper case, |
6268 then the value is appended. | |
2423 | 6269 {options} can also contain a register type specification: |
7 | 6270 "c" or "v" |characterwise| mode |
6271 "l" or "V" |linewise| mode | |
6272 "b" or "<CTRL-V>" |blockwise-visual| mode | |
6273 If a number immediately follows "b" or "<CTRL-V>" then this is | |
6274 used as the width of the selection - if it is not specified | |
6275 then the width of the block is set to the number of characters | |
1266 | 6276 in the longest line (counting a <Tab> as 1 character). |
7 | 6277 |
6278 If {options} contains no register settings, then the default | |
5798 | 6279 is to use character mode unless {value} ends in a <NL> for |
6280 string {value} and linewise mode for list {value}. Blockwise | |
6281 mode is never selected automatically. | |
6282 Returns zero for success, non-zero for failure. | |
6283 | |
6284 *E883* | |
6180 | 6285 Note: you may not use |List| containing more than one item to |
5798 | 6286 set search and expression registers. Lists containing no |
6287 items act like empty strings. | |
7 | 6288 |
6289 Examples: > | |
6290 :call setreg(v:register, @*) | |
6291 :call setreg('*', @%, 'ac') | |
6292 :call setreg('a', "1\n2\n3", 'b5') | |
6293 | |
6294 < This example shows using the functions to save and restore a | |
5798 | 6295 register (note: you may not reliably restore register value |
6296 without using the third argument to |getreg()| as without it | |
6297 newlines are represented as newlines AND Nul bytes are | |
6298 represented as newlines as well, see |NL-used-for-Nul|). > | |
6299 :let var_a = getreg('a', 1, 1) | |
7 | 6300 :let var_amode = getregtype('a') |
6301 .... | |
6302 :call setreg('a', var_a, var_amode) | |
6303 | |
6304 < You can also change the type of a register by appending | |
6305 nothing: > | |
6306 :call setreg('a', '', 'al') | |
6307 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6308 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6309 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
|
6310 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6311 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
|
6312 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6313 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6314 |
831 | 6315 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
6316 Set option or local variable {varname} in window {winnr} to | |
6317 {val}. | |
6318 Tabs are numbered starting with one. For the current tabpage | |
6319 use |setwinvar()|. | |
6320 When {winnr} is zero the current window is used. | |
7 | 6321 This also works for a global or local buffer option, but it |
6322 doesn't work for a global or local buffer variable. | |
6323 For a local buffer option the global value is unchanged. | |
6324 Note that the variable name without "w:" must be used. | |
831 | 6325 Examples: > |
6326 :call settabwinvar(1, 1, "&list", 0) | |
6327 :call settabwinvar(3, 2, "myvar", "foobar") | |
6328 < This function is not available in the |sandbox|. | |
6329 | |
6330 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
6331 Like |settabwinvar()| for the current tab page. | |
7 | 6332 Examples: > |
6333 :call setwinvar(1, "&list", 0) | |
6334 :call setwinvar(2, "myvar", "foobar") | |
6335 | |
4126 | 6336 sha256({string}) *sha256()* |
6647 | 6337 Returns a String with 64 hex characters, which is the SHA256 |
4126 | 6338 checksum of {string}. |
6339 {only available when compiled with the |+cryptv| feature} | |
6340 | |
1661 | 6341 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6342 Escape {string} for use as a shell command argument. |
985 | 6343 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 6344 will enclose {string} in double quotes and double all double |
985 | 6345 quotes within {string}. |
6346 For other systems, it will enclose {string} in single quotes | |
6347 and replace all "'" with "'\''". | |
1661 | 6348 When the {special} argument is present and it's a non-zero |
6349 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 6350 items such as "!", "%", "#" and "<cword>" will be preceded by |
6351 a backslash. This backslash will be removed again by the |:!| | |
1661 | 6352 command. |
1698 | 6353 The "!" character will be escaped (again with a |non-zero-arg| |
6354 {special}) when 'shell' contains "csh" in the tail. That is | |
6355 because for csh and tcsh "!" is used for history replacement | |
6356 even when inside single quotes. | |
6357 The <NL> character is also escaped. With a |non-zero-arg| | |
6358 {special} and 'shell' containing "csh" in the tail it's | |
6359 escaped a second time. | |
1661 | 6360 Example of use with a |:!| command: > |
6361 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
6362 < This results in a directory listing for the file under the | |
6363 cursor. Example of use with |system()|: > | |
6364 :call system("chmod +w -- " . shellescape(expand("%"))) | |
5690 | 6365 < See also |::S|. |
985 | 6366 |
6367 | |
3875 | 6368 shiftwidth() *shiftwidth()* |
6369 Returns the effective value of 'shiftwidth'. This is the | |
6370 'shiftwidth' value unless it is zero, in which case it is the | |
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6371 'tabstop' value. This function was introduced with patch |
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6372 7.3.694 in 2012, everybody should have it by now. |
3875 | 6373 |
6374 | |
7 | 6375 simplify({filename}) *simplify()* |
6376 Simplify the file name as much as possible without changing | |
6377 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
6378 Unix) are not resolved. If the first path component in | |
6379 {filename} designates the current directory, this will be | |
6380 valid for the result as well. A trailing path separator is | |
6381 not removed either. | |
6382 Example: > | |
6383 simplify("./dir/.././/file/") == "./file/" | |
6384 < Note: The combination "dir/.." is only removed if "dir" is | |
6385 a searchable directory or does not exist. On Unix, it is also | |
6386 removed when "dir" is a symbolic link within the same | |
6387 directory. In order to resolve all the involved symbolic | |
6388 links before simplifying the path name, use |resolve()|. | |
6389 | |
82 | 6390 |
1621 | 6391 sin({expr}) *sin()* |
6392 Return the sine of {expr}, measured in radians, as a |Float|. | |
6393 {expr} must evaluate to a |Float| or a |Number|. | |
6394 Examples: > | |
6395 :echo sin(100) | |
6396 < -0.506366 > | |
6397 :echo sin(-4.01) | |
6398 < 0.763301 | |
6399 {only available when compiled with the |+float| feature} | |
6400 | |
6401 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6402 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6403 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
|
6404 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6405 {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
|
6406 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6407 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6408 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6409 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6410 < -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
|
6411 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6412 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6413 |
2902 | 6414 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
5747 | 6415 Sort the items in {list} in-place. Returns {list}. |
6416 | |
6417 If you want a list to remain unmodified make a copy first: > | |
82 | 6418 :let sortedlist = sort(copy(mylist)) |
5968 | 6419 |
6009 | 6420 < When {func} is omitted, is empty or zero, then sort() uses the |
6421 string representation of each item to sort on. Numbers sort | |
6422 after Strings, |Lists| after Numbers. For sorting text in the | |
6423 current buffer use |:sort|. | |
6424 | |
6180 | 6425 When {func} is given and it is '1' or 'i' then case is |
6009 | 6426 ignored. |
6427 | |
6428 When {func} is given and it is 'n' then all items will be | |
6429 sorted numerical (Implementation detail: This uses the | |
6430 strtod() function to parse numbers, Strings, Lists, Dicts and | |
6431 Funcrefs will be considered as being 0). | |
6432 | |
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
6433 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
|
6434 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
|
6435 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
|
6436 |
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6437 When {func} is given and it is 'f' then all items will be |
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6438 sorted numerical. All values must be a Number or a Float. |
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6439 |
685 | 6440 When {func} is a |Funcref| or a function name, this function |
6441 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
|
6442 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
|
6443 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
|
6444 smaller if the first one sorts before the second one. |
5747 | 6445 |
6446 {dict} is for functions with the "dict" attribute. It will be | |
6447 used to set the local variable "self". |Dictionary-function| | |
6448 | |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6449 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
|
6450 string) will keep their relative position. E.g., when sorting |
6051 | 6451 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
|
6452 same order as they were originally. |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6453 |
5747 | 6454 Also see |uniq()|. |
6455 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6456 Example: > |
82 | 6457 func MyCompare(i1, i2) |
6458 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
6459 endfunc | |
6460 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6461 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6462 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6463 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6464 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6465 endfunc |
344 | 6466 < |
374 | 6467 *soundfold()* |
6468 soundfold({word}) | |
6469 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 6470 language in 'spelllang' for the current window that supports |
375 | 6471 soundfolding. 'spell' must be set. When no sound folding is |
6472 possible the {word} is returned unmodified. | |
374 | 6473 This can be used for making spelling suggestions. Note that |
6474 the method can be quite slow. | |
6475 | |
344 | 6476 *spellbadword()* |
532 | 6477 spellbadword([{sentence}]) |
6478 Without argument: The result is the badly spelled word under | |
6479 or after the cursor. The cursor is moved to the start of the | |
6480 bad word. When no bad word is found in the cursor line the | |
6481 result is an empty string and the cursor doesn't move. | |
6482 | |
6483 With argument: The result is the first word in {sentence} that | |
6484 is badly spelled. If there are no spelling mistakes the | |
6485 result is an empty string. | |
6486 | |
6487 The return value is a list with two items: | |
6488 - The badly spelled word or an empty string. | |
6489 - The type of the spelling error: | |
856 | 6490 "bad" spelling mistake |
532 | 6491 "rare" rare word |
6492 "local" word only valid in another region | |
6493 "caps" word should start with Capital | |
6494 Example: > | |
6495 echo spellbadword("the quik brown fox") | |
6496 < ['quik', 'bad'] ~ | |
6497 | |
6498 The spelling information for the current window is used. The | |
6499 'spell' option must be set and the value of 'spelllang' is | |
6500 used. | |
344 | 6501 |
6502 *spellsuggest()* | |
537 | 6503 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 6504 Return a |List| with spelling suggestions to replace {word}. |
344 | 6505 When {max} is given up to this number of suggestions are |
6506 returned. Otherwise up to 25 suggestions are returned. | |
6507 | |
537 | 6508 When the {capital} argument is given and it's non-zero only |
6509 suggestions with a leading capital will be given. Use this | |
6510 after a match with 'spellcapcheck'. | |
6511 | |
344 | 6512 {word} can be a badly spelled word followed by other text. |
6513 This allows for joining two words that were split. The | |
359 | 6514 suggestions also include the following text, thus you can |
6515 replace a line. | |
6516 | |
6517 {word} may also be a good word. Similar words will then be | |
537 | 6518 returned. {word} itself is not included in the suggestions, |
6519 although it may appear capitalized. | |
344 | 6520 |
6521 The spelling information for the current window is used. The | |
375 | 6522 'spell' option must be set and the values of 'spelllang' and |
6523 'spellsuggest' are used. | |
344 | 6524 |
82 | 6525 |
282 | 6526 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 6527 Make a |List| out of {expr}. When {pattern} is omitted or |
6528 empty each white-separated sequence of characters becomes an | |
6529 item. | |
82 | 6530 Otherwise the string is split where {pattern} matches, |
3920 | 6531 removing the matched characters. 'ignorecase' is not used |
6532 here, add \c to ignore case. |/\c| | |
282 | 6533 When the first or last item is empty it is omitted, unless the |
6534 {keepempty} argument is given and it's non-zero. | |
293 | 6535 Other empty items are kept when {pattern} matches at least one |
6536 character or when {keepempty} is non-zero. | |
82 | 6537 Example: > |
95 | 6538 :let words = split(getline('.'), '\W\+') |
282 | 6539 < To split a string in individual characters: > |
236 | 6540 :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
|
6541 < 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
|
6542 the end of the pattern: > |
258 | 6543 :echo split('abc:def:ghi', ':\zs') |
6544 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 6545 Splitting a table where the first element can be empty: > |
6546 :let items = split(line, ':', 1) | |
6547 < The opposite function is |join()|. | |
82 | 6548 |
6549 | |
1621 | 6550 sqrt({expr}) *sqrt()* |
6551 Return the non-negative square root of Float {expr} as a | |
6552 |Float|. | |
6553 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
6554 is negative the result is NaN (Not a Number). | |
6555 Examples: > | |
6556 :echo sqrt(100) | |
6557 < 10.0 > | |
6558 :echo sqrt(-4.01) | |
6559 < nan | |
1668 | 6560 "nan" may be different, it depends on system libraries. |
1621 | 6561 {only available when compiled with the |+float| feature} |
6562 | |
6563 | |
6564 str2float( {expr}) *str2float()* | |
6565 Convert String {expr} to a Float. This mostly works the same | |
6566 as when using a floating point number in an expression, see | |
6567 |floating-point-format|. But it's a bit more permissive. | |
6568 E.g., "1e40" is accepted, while in an expression you need to | |
6569 write "1.0e40". | |
6570 Text after the number is silently ignored. | |
6571 The decimal point is always '.', no matter what the locale is | |
6572 set to. A comma ends the number: "12,345.67" is converted to | |
6573 12.0. You can strip out thousands separators with | |
6574 |substitute()|: > | |
6575 let f = str2float(substitute(text, ',', '', 'g')) | |
6576 < {only available when compiled with the |+float| feature} | |
6577 | |
6578 | |
782 | 6579 str2nr( {expr} [, {base}]) *str2nr()* |
6580 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
|
6581 {base} is the conversion base, it can be 2, 8, 10 or 16. |
782 | 6582 When {base} is omitted base 10 is used. This also means that |
6583 a leading zero doesn't cause octal conversion to be used, as | |
6584 with the default String to Number conversion. | |
6585 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
|
6586 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
|
6587 {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
|
6588 leading "0b" or "0B" is ignored. |
782 | 6589 Text after the number is silently ignored. |
856 | 6590 |
782 | 6591 |
6884 | 6592 strchars({expr} [, {skipcc}]) *strchars()* |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6593 The result is a Number, which is the number of characters |
6884 | 6594 in String {expr}. |
6595 When {skipcc} is omitted or zero, composing characters are | |
6596 counted separately. | |
6597 When {skipcc} set to 1, Composing characters are ignored. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6598 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6599 |
6918 | 6600 |
6601 {skipcc} is only available after 7.4.755. For backward | |
6602 compatibility, you can define a wrapper function: > | |
6603 if has("patch-7.4.755") | |
6604 function s:strchars(str, skipcc) | |
6605 return strchars(a:str, a:skipcc) | |
6606 endfunction | |
6607 else | |
6608 function s:strchars(str, skipcc) | |
6609 if a:skipcc | |
6610 return strlen(substitute(a:str, ".", "x", "g")) | |
6611 else | |
6612 return strchars(a:str) | |
6613 endif | |
6614 endfunction | |
6615 endif | |
6616 < | |
6617 | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6618 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6619 The result is a Number, which is the number of display cells |
6884 | 6620 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
|
6621 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6622 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6623 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6624 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
|
6625 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
|
6626 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6627 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6628 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6629 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6630 |
7 | 6631 strftime({format} [, {time}]) *strftime()* |
6632 The result is a String, which is a formatted date and time, as | |
6633 specified by the {format} string. The given {time} is used, | |
6634 or the current time if no time is given. The accepted | |
6635 {format} depends on your system, thus this is not portable! | |
6636 See the manual page of the C function strftime() for the | |
6637 format. The maximum length of the result is 80 characters. | |
6638 See also |localtime()| and |getftime()|. | |
6639 The language can be changed with the |:language| command. | |
6640 Examples: > | |
6641 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
6642 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
6643 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
6644 :echo strftime("%H:%M") 11:55 | |
6645 :echo strftime("%c", getftime("file.c")) | |
6646 Show mod time of file.c. | |
82 | 6647 < Not available on all systems. To check use: > |
6648 :if exists("*strftime") | |
6649 | |
133 | 6650 stridx({haystack}, {needle} [, {start}]) *stridx()* |
6651 The result is a Number, which gives the byte index in | |
6652 {haystack} of the first occurrence of the String {needle}. | |
140 | 6653 If {start} is specified, the search starts at index {start}. |
6654 This can be used to find a second match: > | |
2662 | 6655 :let colon1 = stridx(line, ":") |
6656 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 6657 < The search is done case-sensitive. |
205 | 6658 For pattern searches use |match()|. |
133 | 6659 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 6660 See also |strridx()|. |
6661 Examples: > | |
7 | 6662 :echo stridx("An Example", "Example") 3 |
6663 :echo stridx("Starting point", "Start") 0 | |
6664 :echo stridx("Starting point", "start") -1 | |
856 | 6665 < *strstr()* *strchr()* |
170 | 6666 stridx() works similar to the C function strstr(). When used |
6667 with a single character it works similar to strchr(). | |
6668 | |
55 | 6669 *string()* |
95 | 6670 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 6671 Float, String or a composition of them, then the result can be |
6672 parsed back with |eval()|. | |
55 | 6673 {expr} type result ~ |
99 | 6674 String 'string' |
95 | 6675 Number 123 |
1621 | 6676 Float 123.123456 or 1.123456e8 |
99 | 6677 Funcref function('name') |
95 | 6678 List [item, item] |
323 | 6679 Dictionary {key: value, key: value} |
99 | 6680 Note that in String values the ' character is doubled. |
1156 | 6681 Also see |strtrans()|. |
55 | 6682 |
7 | 6683 *strlen()* |
6684 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 6685 {expr} in bytes. |
55 | 6686 If the argument is a Number it is first converted to a String. |
6687 For other types an error is given. | |
6870 | 6688 If you want to count the number of multi-byte characters use |
6689 |strchars()|. | |
6690 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
7 | 6691 |
6692 strpart({src}, {start}[, {len}]) *strpart()* | |
6693 The result is a String, which is part of {src}, starting from | |
574 | 6694 byte {start}, with the byte length {len}. |
7 | 6695 When non-existing bytes are included, this doesn't result in |
6696 an error, the bytes are simply omitted. | |
6697 If {len} is missing, the copy continues from {start} till the | |
6698 end of the {src}. > | |
6699 strpart("abcdefg", 3, 2) == "de" | |
6700 strpart("abcdefg", -2, 4) == "ab" | |
6701 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 6702 strpart("abcdefg", 3) == "defg" |
7 | 6703 < Note: To get the first character, {start} must be 0. For |
6704 example, to get three bytes under and after the cursor: > | |
823 | 6705 strpart(getline("."), col(".") - 1, 3) |
7 | 6706 < |
140 | 6707 strridx({haystack}, {needle} [, {start}]) *strridx()* |
6708 The result is a Number, which gives the byte index in | |
6709 {haystack} of the last occurrence of the String {needle}. | |
6710 When {start} is specified, matches beyond this index are | |
6711 ignored. This can be used to find a match before a previous | |
6712 match: > | |
6713 :let lastcomma = strridx(line, ",") | |
6714 :let comma2 = strridx(line, ",", lastcomma - 1) | |
6715 < The search is done case-sensitive. | |
133 | 6716 For pattern searches use |match()|. |
6717 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 6718 If the {needle} is empty the length of {haystack} is returned. |
236 | 6719 See also |stridx()|. Examples: > |
7 | 6720 :echo strridx("an angry armadillo", "an") 3 |
856 | 6721 < *strrchr()* |
170 | 6722 When used with a single character it works similar to the C |
6723 function strrchr(). | |
6724 | |
7 | 6725 strtrans({expr}) *strtrans()* |
6726 The result is a String, which is {expr} with all unprintable | |
6727 characters translated into printable characters |'isprint'|. | |
6728 Like they are shown in a window. Example: > | |
6729 echo strtrans(@a) | |
6730 < This displays a newline in register a as "^@" instead of | |
6731 starting a new line. | |
6732 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6733 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6734 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
|
6735 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6736 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6737 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6738 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6739 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6740 |
5794 | 6741 submatch({nr}[, {list}]) *submatch()* |
2908 | 6742 Only for an expression in a |:substitute| command or |
6743 substitute() function. | |
6744 Returns the {nr}'th submatch of the matched text. When {nr} | |
6745 is 0 the whole matched text is returned. | |
5794 | 6746 Note that a NL in the string can stand for a line break of a |
6747 multi-line match or a NUL character in the text. | |
2908 | 6748 Also see |sub-replace-expression|. |
5794 | 6749 |
6750 If {list} is present and non-zero then submatch() returns | |
6751 a list of strings, similar to |getline()| with two arguments. | |
6752 NL characters in the text represent NUL characters in the | |
6753 text. | |
6754 Only returns more than one item for |:substitute|, inside | |
6755 |substitute()| this list will always contain one or zero | |
6756 items, since there are no real line breaks. | |
6757 | |
7 | 6758 Example: > |
6759 :s/\d\+/\=submatch(0) + 1/ | |
6760 < This finds the first number in the line and adds one to it. | |
6761 A line break is included as a newline character. | |
6762 | |
6763 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
6764 The result is a String, which is a copy of {expr}, in which | |
2908 | 6765 the first match of {pat} is replaced with {sub}. |
6766 When {flags} is "g", all matches of {pat} in {expr} are | |
6767 replaced. Otherwise {flags} should be "". | |
6768 | |
6769 This works like the ":substitute" command (without any flags). | |
6770 But the matching with {pat} is always done like the 'magic' | |
6771 option is set and 'cpoptions' is empty (to make scripts | |
3967 | 6772 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
6773 if you want to ignore or match case and ignore 'ignorecase'. | |
6774 'smartcase' is not used. See |string-match| for how {pat} is | |
6775 used. | |
2908 | 6776 |
6777 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 6778 Note that some codes in {sub} have a special meaning |
1621 | 6779 |sub-replace-special|. For example, to replace something with |
7 | 6780 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 6781 |
7 | 6782 When {pat} does not match in {expr}, {expr} is returned |
6783 unmodified. | |
2908 | 6784 |
7 | 6785 Example: > |
6786 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
6787 < This removes the last component of the 'path' option. > | |
6788 :echo substitute("testing", ".*", "\\U\\0", "") | |
6789 < results in "TESTING". | |
2908 | 6790 |
6791 When {sub} starts with "\=", the remainder is interpreted as | |
6792 an expression. See |sub-replace-expression|. Example: > | |
2833 | 6793 :echo substitute(s, '%\(\x\x\)', |
6794 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 6795 |
32 | 6796 synID({lnum}, {col}, {trans}) *synID()* |
7 | 6797 The result is a Number, which is the syntax ID at the position |
32 | 6798 {lnum} and {col} in the current window. |
7 | 6799 The syntax ID can be used with |synIDattr()| and |
6800 |synIDtrans()| to obtain syntax information about text. | |
419 | 6801 |
32 | 6802 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 6803 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
|
6804 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
|
6805 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
|
6806 zero. |
419 | 6807 |
7 | 6808 When {trans} is non-zero, transparent items are reduced to the |
1621 | 6809 item that they reveal. This is useful when wanting to know |
7 | 6810 the effective color. When {trans} is zero, the transparent |
6811 item is returned. This is useful when wanting to know which | |
6812 syntax item is effective (e.g. inside parens). | |
6813 Warning: This function can be very slow. Best speed is | |
6814 obtained by going through the file in forward direction. | |
6815 | |
6816 Example (echoes the name of the syntax item under the cursor): > | |
6817 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
6818 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6819 |
7 | 6820 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
6821 The result is a String, which is the {what} attribute of | |
6822 syntax ID {synID}. This can be used to obtain information | |
6823 about a syntax item. | |
6824 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 6825 for that mode. When {mode} is omitted, or an invalid value is |
7 | 6826 used, the attributes for the currently active highlighting are |
6827 used (GUI, cterm or term). | |
6828 Use synIDtrans() to follow linked highlight groups. | |
6829 {what} result | |
6830 "name" the name of the syntax item | |
6831 "fg" foreground color (GUI: color name used to set | |
6832 the color, cterm: color number as a string, | |
6833 term: empty string) | |
1755 | 6834 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6835 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6836 |highlight-font| |
1755 | 6837 "sp" special color (as with "fg") |highlight-guisp| |
7 | 6838 "fg#" like "fg", but for the GUI and the GUI is |
6839 running the name in "#RRGGBB" form | |
6840 "bg#" like "fg#" for "bg" | |
1755 | 6841 "sp#" like "fg#" for "sp" |
7 | 6842 "bold" "1" if bold |
6843 "italic" "1" if italic | |
6844 "reverse" "1" if reverse | |
6845 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6846 "standout" "1" if standout |
7 | 6847 "underline" "1" if underlined |
205 | 6848 "undercurl" "1" if undercurled |
7 | 6849 |
6850 Example (echoes the color of the syntax item under the | |
6851 cursor): > | |
6852 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
6853 < | |
6854 synIDtrans({synID}) *synIDtrans()* | |
6855 The result is a Number, which is the translated syntax ID of | |
6856 {synID}. This is the syntax group ID of what is being used to | |
6857 highlight the character. Highlight links given with | |
6858 ":highlight link" are followed. | |
6859 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6860 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6861 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
|
6862 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
|
6863 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
|
6864 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
|
6865 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
|
6866 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6867 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
|
6868 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6869 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
|
6870 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6871 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6872 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6873 |
1500 | 6874 synstack({lnum}, {col}) *synstack()* |
6875 Return a |List|, which is the stack of syntax items at the | |
6876 position {lnum} and {col} in the current window. Each item in | |
6877 the List is an ID like what |synID()| returns. | |
6878 The first item in the List is the outer region, following are | |
6879 items contained in that one. The last one is what |synID()| | |
6880 returns, unless not the whole item is highlighted or it is a | |
6881 transparent item. | |
6882 This function is useful for debugging a syntax file. | |
6883 Example that shows the syntax stack under the cursor: > | |
6884 for id in synstack(line("."), col(".")) | |
6885 echo synIDattr(id, "name") | |
6886 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6887 < 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
|
6888 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6889 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
|
6890 valid positions. |
1500 | 6891 |
24 | 6892 system({expr} [, {input}]) *system()* *E677* |
5808 | 6893 Get the output of the shell command {expr} as a string. See |
6894 |systemlist()| to get the output as a List. | |
5806 | 6895 |
6896 When {input} is given and is a string this string is written | |
6897 to a file and passed as stdin to the command. The string is | |
6898 written as-is, you need to take care of using the correct line | |
6899 separators yourself. | |
6900 If {input} is given and is a |List| it is written to the file | |
6901 in a way |writefile()| does with {binary} set to "b" (i.e. | |
6902 with a newline between each list item with newlines inside | |
6903 list items converted to NULs). | |
6904 Pipes are not used. | |
6905 | |
6183 | 6906 When prepended by |:silent| the shell will not be set to |
6907 cooked mode. This is meant to be used for commands that do | |
6908 not need the user to type. It avoids stray characters showing | |
6909 up on the screen which require |CTRL-L| to remove. > | |
6910 :silent let f = system('ls *.vim') | |
6911 < | |
5690 | 6912 Note: Use |shellescape()| or |::S| with |expand()| or |
6913 |fnamemodify()| to escape special characters in a command | |
6914 argument. Newlines in {expr} may cause the command to fail. | |
6915 The characters in 'shellquote' and 'shellxquote' may also | |
6916 cause trouble. | |
7 | 6917 This is not to be used for interactive commands. |
1661 | 6918 |
7 | 6919 The result is a String. Example: > |
1661 | 6920 :let files = system("ls " . shellescape(expand('%:h'))) |
5690 | 6921 :let files = system('ls ' . expand('%:h:S')) |
7 | 6922 |
6923 < To make the result more system-independent, the shell output | |
6924 is filtered to replace <CR> with <NL> for Macintosh, and | |
6925 <CR><NL> with <NL> for DOS-like systems. | |
5277 | 6926 To avoid the string being truncated at a NUL, all NUL |
6927 characters are replaced with SOH (0x01). | |
6928 | |
7 | 6929 The command executed is constructed using several options: |
6930 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
6931 ({tmp} is an automatically generated file name). | |
6932 For Unix and OS/2 braces are put around {expr} to allow for | |
6933 concatenated commands. | |
6934 | |
794 | 6935 The command will be executed in "cooked" mode, so that a |
6936 CTRL-C will interrupt the command (on Unix at least). | |
6937 | |
7 | 6938 The resulting error code can be found in |v:shell_error|. |
6939 This function will fail in |restricted-mode|. | |
625 | 6940 |
6941 Note that any wrong value in the options mentioned above may | |
6942 make the function fail. It has also been reported to fail | |
6943 when using a security agent application. | |
7 | 6944 Unlike ":!cmd" there is no automatic check for changed files. |
6945 Use |:checktime| to force a check. | |
6946 | |
205 | 6947 |
5808 | 6948 systemlist({expr} [, {input}]) *systemlist()* |
6949 Same as |system()|, but returns a |List| with lines (parts of | |
6950 output separated by NL) with NULs transformed into NLs. Output | |
6951 is the same as |readfile()| will output with {binary} argument | |
6952 set to "b". | |
6953 | |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
6954 Returns an empty string on error. |
5808 | 6955 |
6956 | |
677 | 6957 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 6958 The result is a |List|, where each item is the number of the |
677 | 6959 buffer associated with each window in the current tab page. |
6960 {arg} specifies the number of tab page to be used. When | |
6961 omitted the current tab page is used. | |
6962 When {arg} is invalid the number zero is returned. | |
6963 To get a list of all buffers in all tabs use this: > | |
3445 | 6964 let buflist = [] |
677 | 6965 for i in range(tabpagenr('$')) |
3445 | 6966 call extend(buflist, tabpagebuflist(i + 1)) |
677 | 6967 endfor |
6968 < Note that a buffer may appear in more than one window. | |
6969 | |
6970 | |
6971 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 6972 The result is a Number, which is the number of the current |
6973 tab page. The first tab page has number 1. | |
6974 When the optional argument is "$", the number of the last tab | |
6975 page is returned (the tab page count). | |
6976 The number can be used with the |:tab| command. | |
6977 | |
6978 | |
5763 | 6979 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6980 Like |winnr()| but for tab page {tabarg}. |
677 | 6981 {tabarg} specifies the number of tab page to be used. |
6982 {arg} is used like with |winnr()|: | |
6983 - When omitted the current window number is returned. This is | |
6984 the window which will be used when going to this tab page. | |
6985 - When "$" the number of windows is returned. | |
6986 - When "#" the previous window nr is returned. | |
6987 Useful examples: > | |
6988 tabpagewinnr(1) " current window of tab page 1 | |
6989 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
6990 < When {tabarg} is invalid zero is returned. | |
6991 | |
805 | 6992 *tagfiles()* |
6993 tagfiles() Returns a |List| with the file names used to search for tags | |
6994 for the current buffer. This is the 'tags' option expanded. | |
6995 | |
6996 | |
205 | 6997 taglist({expr}) *taglist()* |
6998 Returns a list of tags matching the regular expression {expr}. | |
438 | 6999 Each list item is a dictionary with at least the following |
7000 entries: | |
648 | 7001 name Name of the tag. |
7002 filename Name of the file where the tag is | |
1156 | 7003 defined. It is either relative to the |
7004 current directory or a full path. | |
205 | 7005 cmd Ex command used to locate the tag in |
7006 the file. | |
648 | 7007 kind Type of the tag. The value for this |
205 | 7008 entry depends on the language specific |
1156 | 7009 kind values. Only available when |
7010 using a tags file generated by | |
7011 Exuberant ctags or hdrtag. | |
648 | 7012 static A file specific tag. Refer to |
205 | 7013 |static-tag| for more information. |
1156 | 7014 More entries may be present, depending on the content of the |
7015 tags file: access, implementation, inherits and signature. | |
7016 Refer to the ctags documentation for information about these | |
7017 fields. For C code the fields "struct", "class" and "enum" | |
7018 may appear, they give the name of the entity the tag is | |
7019 contained in. | |
452 | 7020 |
216 | 7021 The ex-command 'cmd' can be either an ex search pattern, a |
7022 line number or a line number followed by a byte number. | |
205 | 7023 |
7024 If there are no matching tags, then an empty list is returned. | |
7025 | |
7026 To get an exact tag match, the anchors '^' and '$' should be | |
4073 | 7027 used in {expr}. This also make the function work faster. |
7028 Refer to |tag-regexp| for more information about the tag | |
7029 search regular expression pattern. | |
205 | 7030 |
7031 Refer to |'tags'| for information about how the tags file is | |
7032 located by Vim. Refer to |tags-file-format| for the format of | |
7033 the tags file generated by the different ctags tools. | |
7034 | |
7 | 7035 tempname() *tempname()* *temp-file-name* |
7036 The result is a String, which is the name of a file that | |
1621 | 7037 doesn't exist. It can be used for a temporary file. The name |
7 | 7038 is different for at least 26 consecutive calls. Example: > |
7039 :let tmpfile = tempname() | |
7040 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7041 < For Unix, the file will be in a private directory |tempfile|. |
7 | 7042 For MS-Windows forward slashes are used when the 'shellslash' |
7043 option is set or when 'shellcmdflag' starts with '-'. | |
7044 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7045 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7046 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7047 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
|
7048 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7049 {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
|
7050 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7051 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7052 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7053 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7054 < -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
|
7055 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7056 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7057 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7058 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7059 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
|
7060 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7061 {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
|
7062 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7063 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7064 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7065 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7066 < -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
|
7067 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7068 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7069 |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7070 *timer_start()* |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7071 timer_start({time}, {callback} [, {options}]) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7072 Create a timer and return the timer ID. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7073 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7074 {time} is the waiting time in milliseconds. This is the |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7075 minimum time before invoking the callback. When the system is |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7076 busy or Vim is not waiting for input the time will be longer. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7077 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7078 {callback} is the function to call. It can be the name of a |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7079 function or a Funcref. It is called with one argument, which |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7080 is the timer ID. The callback is only invoked when Vim is |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7081 waiting for input. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7082 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7083 {options} is a dictionary. Supported entries: |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7084 "repeat" Number of times to repeat calling the |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7085 callback. -1 means forever. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7086 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7087 Example: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7088 func MyHandler(timer) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7089 echo 'Handler called' |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7090 endfunc |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7091 let timer = timer_start(500, 'MyHandler', |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7092 \ {'repeat': 3}) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7093 < This will invoke MyHandler() three times at 500 msec |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7094 intervals. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7095 {only available when compiled with the |+timers| feature} |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7096 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7097 timer_stop({timer}) *timer_stop()* |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7098 Stop a timer. {timer} is an ID returned by timer_start(). |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7099 The timer callback will no longer be invoked. |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7100 |
7 | 7101 tolower({expr}) *tolower()* |
7102 The result is a copy of the String given, with all uppercase | |
7103 characters turned into lowercase (just like applying |gu| to | |
7104 the string). | |
7105 | |
7106 toupper({expr}) *toupper()* | |
7107 The result is a copy of the String given, with all lowercase | |
7108 characters turned into uppercase (just like applying |gU| to | |
7109 the string). | |
7110 | |
15 | 7111 tr({src}, {fromstr}, {tostr}) *tr()* |
7112 The result is a copy of the {src} string with all characters | |
7113 which appear in {fromstr} replaced by the character in that | |
7114 position in the {tostr} string. Thus the first character in | |
7115 {fromstr} is translated into the first character in {tostr} | |
7116 and so on. Exactly like the unix "tr" command. | |
7117 This code also deals with multibyte characters properly. | |
7118 | |
7119 Examples: > | |
7120 echo tr("hello there", "ht", "HT") | |
7121 < returns "Hello THere" > | |
7122 echo tr("<blob>", "<>", "{}") | |
7123 < returns "{blob}" | |
7124 | |
1621 | 7125 trunc({expr}) *trunc()* |
1668 | 7126 Return the largest integral value with magnitude less than or |
1621 | 7127 equal to {expr} as a |Float| (truncate towards zero). |
7128 {expr} must evaluate to a |Float| or a |Number|. | |
7129 Examples: > | |
7130 echo trunc(1.456) | |
7131 < 1.0 > | |
7132 echo trunc(-5.456) | |
7133 < -5.0 > | |
7134 echo trunc(4.0) | |
7135 < 4.0 | |
7136 {only available when compiled with the |+float| feature} | |
7137 | |
87 | 7138 *type()* |
7139 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 7140 Number: 0 |
7141 String: 1 | |
7142 Funcref: 2 | |
7143 List: 3 | |
7144 Dictionary: 4 | |
1621 | 7145 Float: 5 |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
7146 Boolean: 6 (v:false and v:true) |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
7147 None 7 (v:null and v:none) |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
7148 Job 8 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
7149 Channel 9 |
153 | 7150 To avoid the magic numbers it should be used this way: > |
87 | 7151 :if type(myvar) == type(0) |
7152 :if type(myvar) == type("") | |
7153 :if type(myvar) == type(function("tr")) | |
7154 :if type(myvar) == type([]) | |
153 | 7155 :if type(myvar) == type({}) |
1621 | 7156 :if type(myvar) == type(0.0) |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
7157 :if type(myvar) == type(v:false) |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
7158 :if type(myvar) == type(v:none) |
7 | 7159 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7160 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7161 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
|
7162 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
|
7163 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
|
7164 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
7165 {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
|
7166 is used internally. |
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
7167 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
|
7168 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
|
7169 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7170 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
|
7171 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7172 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7173 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7174 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
|
7175 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7176 "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
|
7177 "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
|
7178 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
|
7179 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
|
7180 "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
|
7181 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
|
7182 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7183 "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
|
7184 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
7185 "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
|
7186 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7187 "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
|
7188 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
|
7189 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7190 "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
|
7191 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7192 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7193 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
|
7194 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
|
7195 "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
|
7196 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7197 "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
|
7198 |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
|
7199 "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
|
7200 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
|
7201 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
|
7202 "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
|
7203 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
|
7204 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
|
7205 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
|
7206 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
|
7207 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7208 "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
|
7209 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
|
7210 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
|
7211 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7212 "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
|
7213 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
|
7214 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7215 |
5747 | 7216 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
7217 Remove second and succeeding copies of repeated adjacent | |
7218 {list} items in-place. Returns {list}. If you want a list | |
7219 to remain unmodified make a copy first: > | |
7220 :let newlist = uniq(copy(mylist)) | |
7221 < The default compare function uses the string representation of | |
7222 each item. For the use of {func} and {dict} see |sort()|. | |
7223 | |
140 | 7224 values({dict}) *values()* |
1621 | 7225 Return a |List| with all the values of {dict}. The |List| is |
685 | 7226 in arbitrary order. |
140 | 7227 |
7228 | |
7 | 7229 virtcol({expr}) *virtcol()* |
7230 The result is a Number, which is the screen column of the file | |
7231 position given with {expr}. That is, the last screen position | |
7232 occupied by the character at that position, when the screen | |
7233 would be of unlimited width. When there is a <Tab> at the | |
7234 position, the returned Number will be the column at the end of | |
7235 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
3445 | 7236 set to 8, it returns 8. |conceal| is ignored. |
1317 | 7237 For the byte position use |col()|. |
7238 For the use of {expr} see |col()|. | |
7239 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 7240 "off" is the offset in screen columns from the start of the |
1266 | 7241 character. E.g., a position within a <Tab> or after the last |
2965 | 7242 character. When "off" is omitted zero is used. |
7 | 7243 When Virtual editing is active in the current mode, a position |
7244 beyond the end of the line can be returned. |'virtualedit'| | |
7245 The accepted positions are: | |
7246 . the cursor position | |
7247 $ the end of the cursor line (the result is the | |
7248 number of displayed characters in the cursor line | |
7249 plus one) | |
7250 'x position of mark x (if the mark is not set, 0 is | |
7251 returned) | |
6447 | 7252 v In Visual mode: the start of the Visual area (the |
7253 cursor is the end). When not in Visual mode | |
7254 returns the cursor position. Differs from |'<| in | |
7255 that it's updated right away. | |
7 | 7256 Note that only marks in the current file can be used. |
7257 Examples: > | |
7258 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
7259 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 7260 virtcol("'t") with text " there", with 't at 'h', returns 6 |
7261 < The first column is 1. 0 is returned for an error. | |
1156 | 7262 A more advanced example that echoes the maximum length of |
7263 all lines: > | |
7264 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
7265 | |
7 | 7266 |
7267 visualmode([expr]) *visualmode()* | |
7268 The result is a String, which describes the last Visual mode | |
856 | 7269 used in the current buffer. Initially it returns an empty |
7270 string, but once Visual mode has been used, it returns "v", | |
7271 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
7272 character-wise, line-wise, or block-wise Visual mode | |
7273 respectively. | |
7 | 7274 Example: > |
7275 :exe "normal " . visualmode() | |
7276 < This enters the same Visual mode as before. It is also useful | |
7277 in scripts if you wish to act differently depending on the | |
7278 Visual mode that was used. | |
1621 | 7279 If Visual mode is active, use |mode()| to get the Visual mode |
7280 (e.g., in a |:vmap|). | |
1661 | 7281 *non-zero-arg* |
7282 If [expr] is supplied and it evaluates to a non-zero Number or | |
7283 a non-empty String, then the Visual mode will be cleared and | |
1621 | 7284 the old value is returned. Note that " " and "0" are also |
1661 | 7285 non-empty strings, thus cause the mode to be cleared. A List, |
7286 Dictionary or Float is not a Number or String, thus does not | |
7287 cause the mode to be cleared. | |
7 | 7288 |
4151 | 7289 wildmenumode() *wildmenumode()* |
7290 Returns non-zero when the wildmenu is active and zero | |
7291 otherwise. See 'wildmenu' and 'wildmode'. | |
7292 This can be used in mappings to handle the 'wildcharm' option | |
7293 gracefully. (Makes only sense with |mapmode-c| mappings). | |
7294 | |
7295 For example to make <c-j> work like <down> in wildmode, use: > | |
7296 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
7297 < | |
7298 (Note, this needs the 'wildcharm' option set appropriately). | |
7299 | |
7300 | |
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7301 win_findbuf({bufnr}) *win_findbuf()* |
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7302 Returns a list with window IDs for windows that contain buffer |
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7303 {bufnr}. When there is none the list is empty. |
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7304 |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7305 win_getid([{win} [, {tab}]]) *win_getid()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7306 Get the window ID for the specified window. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7307 When {win} is missing use the current window. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7308 With {win} this is the window number. The top window has |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7309 number 1. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7310 Without {tab} use the current tab, otherwise the tab with |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7311 number {tab}. The first tab has number one. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7312 Return zero if the window cannot be found. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7313 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7314 win_gotoid({expr}) *win_gotoid()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7315 Go to window with ID {expr}. This may also change the current |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7316 tabpage. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7317 Return 1 if successful, 0 if the window cannot be found. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7318 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7319 win_id2tabwin({expr} *win_id2tabwin()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7320 Return a list with the tab number and window number of window |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7321 with ID {expr}: [tabnr, winnr]. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7322 Return [0, 0] if the window cannot be found. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7323 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7324 win_id2win({expr}) *win_id2win()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7325 Return the window number of window with ID {expr}. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7326 Return 0 if the window cannot be found in the current tabpage. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7327 |
7 | 7328 *winbufnr()* |
7329 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 7330 associated with window {nr}. When {nr} is zero, the number of |
7 | 7331 the buffer in the current window is returned. When window |
7332 {nr} doesn't exist, -1 is returned. | |
7333 Example: > | |
7334 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
7335 < | |
7336 *wincol()* | |
7337 wincol() The result is a Number, which is the virtual column of the | |
7338 cursor in the window. This is counting screen cells from the | |
7339 left side of the window. The leftmost column is one. | |
7340 | |
7341 winheight({nr}) *winheight()* | |
7342 The result is a Number, which is the height of window {nr}. | |
7343 When {nr} is zero, the height of the current window is | |
7344 returned. When window {nr} doesn't exist, -1 is returned. | |
7345 An existing window always has a height of zero or more. | |
7346 Examples: > | |
7347 :echo "The current window has " . winheight(0) . " lines." | |
7348 < | |
7349 *winline()* | |
7350 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 7351 in the window. This is counting screen lines from the top of |
7 | 7352 the window. The first line is one. |
531 | 7353 If the cursor was moved the view on the file will be updated |
7354 first, this may cause a scroll. | |
7 | 7355 |
7356 *winnr()* | |
20 | 7357 winnr([{arg}]) The result is a Number, which is the number of the current |
7358 window. The top window has number 1. | |
7359 When the optional argument is "$", the number of the | |
3967 | 7360 last window is returned (the window count). > |
7361 let window_count = winnr('$') | |
7362 < When the optional argument is "#", the number of the last | |
20 | 7363 accessed window is returned (where |CTRL-W_p| goes to). |
1156 | 7364 If there is no previous window or it is in another tab page 0 |
7365 is returned. | |
20 | 7366 The number can be used with |CTRL-W_w| and ":wincmd w" |
7367 |:wincmd|. | |
1156 | 7368 Also see |tabpagewinnr()|. |
7 | 7369 |
7370 *winrestcmd()* | |
7371 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
7372 the current window sizes. Only works properly when no windows | |
712 | 7373 are opened or closed and the current window and tab page is |
7374 unchanged. | |
7 | 7375 Example: > |
7376 :let cmd = winrestcmd() | |
7377 :call MessWithWindowSizes() | |
7378 :exe cmd | |
712 | 7379 < |
7380 *winrestview()* | |
7381 winrestview({dict}) | |
7382 Uses the |Dictionary| returned by |winsaveview()| to restore | |
7383 the view of the current window. | |
5940 | 7384 Note: The {dict} does not have to contain all values, that are |
7385 returned by |winsaveview()|. If values are missing, those | |
7386 settings won't be restored. So you can use: > | |
7387 :call winrestview({'curswant': 4}) | |
7388 < | |
7389 This will only set the curswant value (the column the cursor | |
7390 wants to move on vertical movements) of the cursor to column 5 | |
7391 (yes, that is 5), while all other settings will remain the | |
7392 same. This is useful, if you set the cursor position manually. | |
7393 | |
712 | 7394 If you have changed the values the result is unpredictable. |
7395 If the window size changed the result won't be the same. | |
7396 | |
7397 *winsaveview()* | |
7398 winsaveview() Returns a |Dictionary| that contains information to restore | |
7399 the view of the current window. Use |winrestview()| to | |
7400 restore the view. | |
7401 This is useful if you have a mapping that jumps around in the | |
7402 buffer and you want to go back to the original view. | |
7403 This does not save fold information. Use the 'foldenable' | |
798 | 7404 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
|
7405 not opened when moving around. This may have side effects. |
712 | 7406 The return value includes: |
7407 lnum cursor line number | |
5940 | 7408 col cursor column (Note: the first column |
7409 zero, as opposed to what getpos() | |
7410 returns) | |
712 | 7411 coladd cursor column offset for 'virtualedit' |
7412 curswant column for vertical movement | |
7413 topline first line in the window | |
7414 topfill filler lines, only in diff mode | |
7415 leftcol first column displayed | |
7416 skipcol columns skipped | |
7417 Note that no option values are saved. | |
7418 | |
7 | 7419 |
7420 winwidth({nr}) *winwidth()* | |
7421 The result is a Number, which is the width of window {nr}. | |
7422 When {nr} is zero, the width of the current window is | |
7423 returned. When window {nr} doesn't exist, -1 is returned. | |
7424 An existing window always has a width of zero or more. | |
7425 Examples: > | |
7426 :echo "The current window has " . winwidth(0) . " columns." | |
7427 :if winwidth(0) <= 50 | |
7428 : exe "normal 50\<C-W>|" | |
7429 :endif | |
7430 < | |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7431 wordcount() *wordcount()* |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7432 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
|
7433 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
|
7434 |g_CTRL-G| |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7435 The return value includes: |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7436 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
|
7437 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
|
7438 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
|
7439 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
|
7440 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7441 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
|
7442 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7443 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
|
7444 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7445 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
|
7446 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7447 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
|
7448 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7449 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
|
7450 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7451 |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7452 |
158 | 7453 *writefile()* |
6341 | 7454 writefile({list}, {fname} [, {flags}]) |
685 | 7455 Write |List| {list} to file {fname}. Each list item is |
158 | 7456 separated with a NL. Each list item must be a String or |
7457 Number. | |
6341 | 7458 When {flags} contains "b" then binary mode is used: There will |
158 | 7459 not be a NL after the last list item. An empty item at the |
7460 end does cause the last line in the file to end in a NL. | |
6341 | 7461 |
7462 When {flags} contains "a" then append mode is used, lines are | |
7463 append to the file: > | |
7464 :call writefile(["foo"], "event.log", "a") | |
7465 :call writefile(["bar"], "event.log", "a") | |
7466 > | |
7467 < All NL characters are replaced with a NUL character. | |
158 | 7468 Inserting CR characters needs to be done before passing {list} |
7469 to writefile(). | |
7470 An existing file is overwritten, if possible. | |
7471 When the write fails -1 is returned, otherwise 0. There is an | |
7472 error message if the file can't be created or when writing | |
7473 fails. | |
7474 Also see |readfile()|. | |
7475 To copy a file byte for byte: > | |
7476 :let fl = readfile("foo", "b") | |
7477 :call writefile(fl, "foocopy", "b") | |
3214 | 7478 |
7479 | |
7480 xor({expr}, {expr}) *xor()* | |
7481 Bitwise XOR on the two arguments. The arguments are converted | |
7482 to a number. A List, Dict or Float argument causes an error. | |
7483 Example: > | |
7484 :let bits = xor(bits, 0x80) | |
3256 | 7485 < |
3214 | 7486 |
7 | 7487 |
7488 *feature-list* | |
6009 | 7489 There are four types of features: |
7 | 7490 1. Features that are only supported when they have been enabled when Vim |
7491 was compiled |+feature-list|. Example: > | |
7492 :if has("cindent") | |
7493 2. Features that are only supported when certain conditions have been met. | |
7494 Example: > | |
7495 :if has("gui_running") | |
7496 < *has-patch* | |
5814 | 7497 3. Included patches. The "patch123" feature means that patch 123 has been |
7498 included. Note that this form does not check the version of Vim, you need | |
7499 to inspect |v:version| for that. | |
7500 Example (checking version 6.2.148 or later): > | |
7 | 7501 :if v:version > 602 || v:version == 602 && has("patch148") |
5814 | 7502 < Note that it's possible for patch 147 to be omitted even though 148 is |
7503 included. | |
7504 | |
7505 4. Beyond a certain version or at a certain version and including a specific | |
5862 | 7506 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
7507 later, or it is version 7.4 and patch 237 was included. | |
7508 Note that this only works for patch 7.4.237 and later, before that you | |
7509 need to use the example above that checks v:version. Example: > | |
7510 :if has("patch-7.4.248") | |
5814 | 7511 < Note that it's possible for patch 147 to be omitted even though 148 is |
1156 | 7512 included. |
7 | 7513 |
5340 | 7514 acl Compiled with |ACL| support. |
7 | 7515 all_builtin_terms Compiled with all builtin terminals enabled. |
7516 amiga Amiga version of Vim. | |
7517 arabic Compiled with Arabic support |Arabic|. | |
7518 arp Compiled with ARP support (Amiga). | |
613 | 7519 autocmd Compiled with autocommand support. |autocommand| |
7 | 7520 balloon_eval Compiled with |balloon-eval| support. |
435 | 7521 balloon_multiline GUI supports multiline balloons. |
7 | 7522 beos BeOS version of Vim. |
7523 browse Compiled with |:browse| support, and browse() will | |
7524 work. | |
3682 | 7525 browsefilter Compiled with support for |browsefilter|. |
7 | 7526 builtin_terms Compiled with some builtin terminals. |
7527 byte_offset Compiled with support for 'o' in 'statusline' | |
7528 cindent Compiled with 'cindent' support. | |
7529 clientserver Compiled with remote invocation support |clientserver|. | |
7530 clipboard Compiled with 'clipboard' support. | |
7531 cmdline_compl Compiled with |cmdline-completion| support. | |
7532 cmdline_hist Compiled with |cmdline-history| support. | |
7533 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
7534 comments Compiled with |'comments'| support. | |
2681 | 7535 compatible Compiled to be very Vi compatible. |
7 | 7536 cryptv Compiled with encryption support |encryption|. |
7537 cscope Compiled with |cscope| support. | |
7538 debug Compiled with "DEBUG" defined. | |
7539 dialog_con Compiled with console dialog support. | |
7540 dialog_gui Compiled with GUI dialog support. | |
7541 diff Compiled with |vimdiff| and 'diff' support. | |
7542 digraphs Compiled with support for digraphs. | |
6110 | 7543 directx Compiled with support for Direct-X and 'renderoptions'. |
7 | 7544 dnd Compiled with support for the "~ register |quote_~|. |
2681 | 7545 dos16 16 bits DOS version of Vim. |
7 | 7546 dos32 32 bits DOS (DJGPP) version of Vim. |
7547 ebcdic Compiled on a machine with ebcdic character set. | |
7548 emacs_tags Compiled with support for Emacs tags. | |
7549 eval Compiled with expression evaluation support. Always | |
7550 true, of course! | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7788
diff
changeset
|
7551 ex_extra |+ex_extra|, always true now |
7 | 7552 extra_search Compiled with support for |'incsearch'| and |
7553 |'hlsearch'| | |
7554 farsi Compiled with Farsi support |farsi|. | |
7555 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 7556 filterpipe When 'shelltemp' is off pipes are used for shell |
7557 read/write/filter commands | |
7 | 7558 find_in_path Compiled with support for include file searches |
7559 |+find_in_path|. | |
1621 | 7560 float Compiled with support for |Float|. |
7 | 7561 fname_case Case in file names matters (for Amiga, MS-DOS, and |
7562 Windows this is not present). | |
7563 folding Compiled with |folding| support. | |
7564 footer Compiled with GUI footer support. |gui-footer| | |
7565 fork Compiled to use fork()/exec() instead of system(). | |
7566 gettext Compiled with message translation |multi-lang| | |
7567 gui Compiled with GUI enabled. | |
7568 gui_athena Compiled with Athena GUI. | |
2681 | 7569 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 7570 gui_gtk Compiled with GTK+ GUI (any version). |
7571 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
8178
diff
changeset
|
7572 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
7 | 7573 gui_mac Compiled with Macintosh GUI. |
7574 gui_motif Compiled with Motif GUI. | |
7575 gui_photon Compiled with Photon GUI. | |
2681 | 7576 gui_running Vim is running in the GUI, or it will start soon. |
7 | 7577 gui_win32 Compiled with MS Windows Win32 GUI. |
7578 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
7579 hangul_input Compiled with Hangul input support. |hangul| | |
7580 iconv Can use iconv() for conversion. | |
7581 insert_expand Compiled with support for CTRL-X expansion commands in | |
7582 Insert mode. | |
7583 jumplist Compiled with |jumplist| support. | |
7584 keymap Compiled with 'keymap' support. | |
7585 langmap Compiled with 'langmap' support. | |
7586 libcall Compiled with |libcall()| support. | |
5995 | 7587 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
7588 'breakindent' support. | |
7 | 7589 lispindent Compiled with support for lisp indenting. |
7590 listcmds Compiled with commands for the buffer list |:files| | |
7591 and the argument list |arglist|. | |
7592 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
|
7593 lua Compiled with Lua interface |Lua|. |
8094
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
7594 mac Any Macintosh version of Vim. |
8078
7676818d486b
commit https://github.com/vim/vim/commit/f8df7addc5f741c16fa2a458f8777ac1fdf2e01e
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
7595 macunix Compiled for OS X, with darwin |
7676818d486b
commit https://github.com/vim/vim/commit/f8df7addc5f741c16fa2a458f8777ac1fdf2e01e
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
7596 osx Compiled for OS X, with or without darwin |
7 | 7597 menu Compiled with support for |:menu|. |
7598 mksession Compiled with support for |:mksession|. | |
7599 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
7600 mouse Compiled with support mouse. | |
7601 mouse_dec Compiled with support for Dec terminal mouse. | |
7602 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
7603 mouse_netterm Compiled with support for netterm mouse. | |
7604 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 7605 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3750 | 7606 mouse_sgr Compiled with support for sgr mouse. |
3224 | 7607 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 7608 mouse_xterm Compiled with support for xterm mouse. |
2681 | 7609 mouseshape Compiled with support for 'mouseshape'. |
1768 | 7610 multi_byte Compiled with support for 'encoding' |
7611 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 7612 multi_byte_ime Compiled with support for IME input method. |
7613 multi_lang Compiled with support for multiple languages. | |
14 | 7614 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 7615 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 7616 netbeans_intg Compiled with support for |netbeans|. |
7617 ole Compiled with OLE automation support for Win32. | |
7618 os2 OS/2 version of Vim. | |
7619 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
7620 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
|
7621 persistent_undo Compiled with support for persistent undo history. |
7 | 7622 postscript Compiled with PostScript file printing. |
7623 printer Compiled with |:hardcopy| support. | |
170 | 7624 profile Compiled with |:profile| support. |
2826 | 7625 python Compiled with Python 2.x interface. |has-python| |
7626 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 7627 qnx QNX version of Vim. |
7628 quickfix Compiled with |quickfix| support. | |
857 | 7629 reltime Compiled with |reltime()| support. |
7 | 7630 rightleft Compiled with 'rightleft' support. |
7631 ruby Compiled with Ruby interface |ruby|. | |
7632 scrollbind Compiled with 'scrollbind' support. | |
7633 showcmd Compiled with 'showcmd' support. | |
7634 signs Compiled with |:sign| support. | |
7635 smartindent Compiled with 'smartindent' support. | |
2681 | 7636 spell Compiled with spell checking support |spell|. |
1989 | 7637 startuptime Compiled with |--startuptime| support. |
7 | 7638 statusline Compiled with support for 'statusline', 'rulerformat' |
7639 and special formats of 'titlestring' and 'iconstring'. | |
7640 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 7641 syntax Compiled with syntax highlighting support |syntax|. |
7 | 7642 syntax_items There are active syntax highlighting items for the |
7643 current buffer. | |
7644 system Compiled to use system() instead of fork()/exec(). | |
7645 tag_binary Compiled with binary searching in tags files | |
7646 |tag-binary-search|. | |
7647 tag_old_static Compiled with support for old static tags | |
7648 |tag-old-static|. | |
7649 tag_any_white Compiled with support for any white characters in tags | |
7650 files |tag-any-white|. | |
7651 tcl Compiled with Tcl interface. | |
7652 terminfo Compiled with terminfo instead of termcap. | |
7653 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
7654 textobjects Compiled with support for |text-objects|. | |
7655 tgetent Compiled with tgetent support, able to use a termcap | |
7656 or terminfo file. | |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7657 timers Compiled with |timer_start()| support. |
7 | 7658 title Compiled with window title support |'title'|. |
7659 toolbar Compiled with support for |gui-toolbar|. | |
7660 unix Unix version of Vim. | |
7661 user_commands User-defined commands. | |
2681 | 7662 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 7663 vim_starting True while initial source'ing takes place. |startup| |
2681 | 7664 viminfo Compiled with viminfo support. |
7 | 7665 virtualedit Compiled with 'virtualedit' option. |
7666 visual Compiled with Visual mode. | |
7667 visualextra Compiled with extra Visual mode commands. | |
7668 |blockwise-operators|. | |
7669 vms VMS version of Vim. | |
7670 vreplace Compiled with |gR| and |gr| commands. | |
7671 wildignore Compiled with 'wildignore' option. | |
7672 wildmenu Compiled with 'wildmenu' option. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
7673 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
|
7674 64 bits) |
2681 | 7675 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 7676 win64 Win64 version of Vim (MS-Windows 64 bit). |
7677 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 7678 winaltkeys Compiled with 'winaltkeys' option. |
7679 windows Compiled with support for more than one window. | |
7 | 7680 writebackup Compiled with 'writebackup' default on. |
7681 xfontset Compiled with X fontset support |xfontset|. | |
7682 xim Compiled with X input method support |xim|. | |
5340 | 7683 xpm Compiled with pixmap support. |
7684 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
7685 backward compatibility. Use "xpm" instead.) | |
7 | 7686 xsmp Compiled with X session management support. |
7687 xsmp_interact Compiled with interactive X session management support. | |
7688 xterm_clipboard Compiled with support for xterm clipboard. | |
7689 xterm_save Compiled with support for saving and restoring the | |
7690 xterm screen. | |
7691 x11 Compiled with X11 support. | |
7692 | |
7693 *string-match* | |
7694 Matching a pattern in a String | |
7695 | |
7696 A regexp pattern as explained at |pattern| is normally used to find a match in | |
7697 the buffer lines. When a pattern is used to find a match in a String, almost | |
7698 everything works in the same way. The difference is that a String is handled | |
7699 like it is one line. When it contains a "\n" character, this is not seen as a | |
7700 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
7701 with ".". Example: > | |
7702 :let a = "aaaa\nxxxx" | |
7703 :echo matchstr(a, "..\n..") | |
7704 aa | |
7705 xx | |
7706 :echo matchstr(a, "a.x") | |
7707 a | |
7708 x | |
7709 | |
7710 Don't forget that "^" will only match at the first character of the String and | |
7711 "$" at the last character of the string. They don't match after or before a | |
7712 "\n". | |
7713 | |
7714 ============================================================================== | |
7715 5. Defining functions *user-functions* | |
7716 | |
7717 New functions can be defined. These can be called just like builtin | |
7718 functions. The function executes a sequence of Ex commands. Normal mode | |
7719 commands can be executed with the |:normal| command. | |
7720 | |
7721 The function name must start with an uppercase letter, to avoid confusion with | |
7722 builtin functions. To prevent from using the same name in different scripts | |
7723 avoid obvious, short names. A good habit is to start the function name with | |
7724 the name of the script, e.g., "HTMLcolor()". | |
7725 | |
504 | 7726 It's also possible to use curly braces, see |curly-braces-names|. And the |
7727 |autoload| facility is useful to define a function only when it's called. | |
7 | 7728 |
7729 *local-function* | |
7730 A function local to a script must start with "s:". A local script function | |
7731 can only be called from within the script and from functions, user commands | |
7732 and autocommands defined in the script. It is also possible to call the | |
1698 | 7733 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 7734 instead of "s:" when the mapping is expanded outside of the script. |
5862 | 7735 There are only script-local functions, no buffer-local or window-local |
7736 functions. | |
7 | 7737 |
7738 *:fu* *:function* *E128* *E129* *E123* | |
7739 :fu[nction] List all functions and their arguments. | |
7740 | |
7741 :fu[nction] {name} List function {name}. | |
685 | 7742 {name} can also be a |Dictionary| entry that is a |
7743 |Funcref|: > | |
114 | 7744 :function dict.init |
504 | 7745 |
7746 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
7747 Example that lists all functions ending with "File": > | |
7748 :function /File$ | |
482 | 7749 < |
7750 *:function-verbose* | |
7751 When 'verbose' is non-zero, listing a function will also display where it was | |
7752 last defined. Example: > | |
7753 | |
7754 :verbose function SetFileTypeSH | |
7755 function SetFileTypeSH(name) | |
7756 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
7757 < | |
484 | 7758 See |:verbose-cmd| for more information. |
482 | 7759 |
5862 | 7760 *E124* *E125* *E853* *E884* |
102 | 7761 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 7762 Define a new function by the name {name}. The name |
7763 must be made of alphanumeric characters and '_', and | |
5862 | 7764 must start with a capital or "s:" (see above). Note |
7765 that using "b:" or "g:" is not allowed. (since patch | |
7766 7.4.260 E884 is given if the function name has a colon | |
7767 in the name, e.g. for "foo:bar()". Before that patch | |
7768 no error was given). | |
114 | 7769 |
685 | 7770 {name} can also be a |Dictionary| entry that is a |
7771 |Funcref|: > | |
114 | 7772 :function dict.init(arg) |
1621 | 7773 < "dict" must be an existing dictionary. The entry |
114 | 7774 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 7775 is required to overwrite an existing function. The |
114 | 7776 result is a |Funcref| to a numbered function. The |
7777 function can only be used with a |Funcref| and will be | |
7778 deleted if there are no more references to it. | |
7 | 7779 *E127* *E122* |
7780 When a function by this name already exists and [!] is | |
7781 not used an error message is given. When [!] is used, | |
7782 an existing function is silently replaced. Unless it | |
7783 is currently being executed, that is an error. | |
133 | 7784 |
7785 For the {arguments} see |function-argument|. | |
7786 | |
5618 | 7787 *:func-range* *a:firstline* *a:lastline* |
7 | 7788 When the [range] argument is added, the function is |
7789 expected to take care of a range itself. The range is | |
7790 passed as "a:firstline" and "a:lastline". If [range] | |
7791 is excluded, ":{range}call" will call the function for | |
7792 each line in the range, with the cursor on the start | |
7793 of each line. See |function-range-example|. | |
3967 | 7794 The cursor is still moved to the first line of the |
7795 range, as is the case with all Ex commands. | |
5618 | 7796 *:func-abort* |
7 | 7797 When the [abort] argument is added, the function will |
7798 abort as soon as an error is detected. | |
5618 | 7799 *:func-dict* |
102 | 7800 When the [dict] argument is added, the function must |
1621 | 7801 be invoked through an entry in a |Dictionary|. The |
102 | 7802 local variable "self" will then be set to the |
7803 dictionary. See |Dictionary-function|. | |
7 | 7804 |
1621 | 7805 *function-search-undo* |
653 | 7806 The last used search pattern and the redo command "." |
1621 | 7807 will not be changed by the function. This also |
7808 implies that the effect of |:nohlsearch| is undone | |
7809 when the function returns. | |
653 | 7810 |
7 | 7811 *:endf* *:endfunction* *E126* *E193* |
7812 :endf[unction] The end of a function definition. Must be on a line | |
7813 by its own, without other commands. | |
7814 | |
7815 *:delf* *:delfunction* *E130* *E131* | |
7816 :delf[unction] {name} Delete function {name}. | |
685 | 7817 {name} can also be a |Dictionary| entry that is a |
7818 |Funcref|: > | |
114 | 7819 :delfunc dict.init |
1621 | 7820 < This will remove the "init" entry from "dict". The |
114 | 7821 function is deleted if there are no more references to |
7822 it. | |
7 | 7823 *:retu* *:return* *E133* |
7824 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
7825 evaluated and returned as the result of the function. | |
7826 If "[expr]" is not given, the number 0 is returned. | |
7827 When a function ends without an explicit ":return", | |
7828 the number 0 is returned. | |
7829 Note that there is no check for unreachable lines, | |
7830 thus there is no warning if commands follow ":return". | |
7831 | |
7832 If the ":return" is used after a |:try| but before the | |
7833 matching |:finally| (if present), the commands | |
7834 following the ":finally" up to the matching |:endtry| | |
7835 are executed first. This process applies to all | |
7836 nested ":try"s inside the function. The function | |
7837 returns at the outermost ":endtry". | |
7838 | |
133 | 7839 *function-argument* *a:var* |
1621 | 7840 An argument can be defined by giving its name. In the function this can then |
133 | 7841 be used as "a:name" ("a:" for argument). |
1156 | 7842 *a:0* *a:1* *a:000* *E740* *...* |
133 | 7843 Up to 20 arguments can be given, separated by commas. After the named |
7844 arguments an argument "..." can be specified, which means that more arguments | |
7845 may optionally be following. In the function the extra arguments can be used | |
7846 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 7847 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
7848 that "a:1" is the same as "a:000[0]". | |
148 | 7849 *E742* |
7850 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 7851 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 7852 Thus you can pass a |List| to a function and have the function add an item to |
7853 it. If you want to make sure the function cannot change a |List| or | |
7854 |Dictionary| use |:lockvar|. | |
133 | 7855 |
7856 When not using "...", the number of arguments in a function call must be equal | |
7857 to the number of named arguments. When using "...", the number of arguments | |
7858 may be larger. | |
7859 | |
7860 It is also possible to define a function without any arguments. You must | |
7861 still supply the () then. The body of the function follows in the next lines, | |
7862 until the matching |:endfunction|. It is allowed to define another function | |
7863 inside a function body. | |
7864 | |
7865 *local-variables* | |
7 | 7866 Inside a function variables can be used. These are local variables, which |
7867 will disappear when the function returns. Global variables need to be | |
7868 accessed with "g:". | |
7869 | |
7870 Example: > | |
7871 :function Table(title, ...) | |
7872 : echohl Title | |
7873 : echo a:title | |
7874 : echohl None | |
140 | 7875 : echo a:0 . " items:" |
7876 : for s in a:000 | |
7877 : echon ' ' . s | |
7878 : endfor | |
7 | 7879 :endfunction |
7880 | |
7881 This function can then be called with: > | |
140 | 7882 call Table("Table", "line1", "line2") |
7883 call Table("Empty Table") | |
7 | 7884 |
1156 | 7885 To return more than one value, return a |List|: > |
7886 :function Compute(n1, n2) | |
7 | 7887 : if a:n2 == 0 |
1156 | 7888 : return ["fail", 0] |
7 | 7889 : endif |
1156 | 7890 : return ["ok", a:n1 / a:n2] |
7 | 7891 :endfunction |
7892 | |
7893 This function can then be called with: > | |
1156 | 7894 :let [success, div] = Compute(102, 6) |
7 | 7895 :if success == "ok" |
7896 : echo div | |
7897 :endif | |
1156 | 7898 < |
786 | 7899 *:cal* *:call* *E107* *E117* |
7 | 7900 :[range]cal[l] {name}([arguments]) |
7901 Call a function. The name of the function and its arguments | |
7902 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 7903 used. The returned value is discarded. |
7 | 7904 Without a range and for functions that accept a range, the |
7905 function is called once. When a range is given the cursor is | |
7906 positioned at the start of the first line before executing the | |
7907 function. | |
7908 When a range is given and the function doesn't handle it | |
7909 itself, the function is executed for each line in the range, | |
7910 with the cursor in the first column of that line. The cursor | |
7911 is left at the last line (possibly moved by the last function | |
1621 | 7912 call). The arguments are re-evaluated for each line. Thus |
7 | 7913 this works: |
7914 *function-range-example* > | |
7915 :function Mynumber(arg) | |
7916 : echo line(".") . " " . a:arg | |
7917 :endfunction | |
7918 :1,5call Mynumber(getline(".")) | |
7919 < | |
7920 The "a:firstline" and "a:lastline" are defined anyway, they | |
7921 can be used to do something different at the start or end of | |
7922 the range. | |
7923 | |
7924 Example of a function that handles the range itself: > | |
7925 | |
7926 :function Cont() range | |
7927 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
7928 :endfunction | |
7929 :4,8call Cont() | |
7930 < | |
7931 This function inserts the continuation character "\" in front | |
7932 of all the lines in the range, except the first one. | |
7933 | |
1156 | 7934 When the function returns a composite value it can be further |
7935 dereferenced, but the range will not be used then. Example: > | |
7936 :4,8call GetDict().method() | |
7937 < Here GetDict() gets the range but method() does not. | |
7938 | |
7 | 7939 *E132* |
7940 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
7941 option. | |
7942 | |
161 | 7943 |
7944 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 7945 *autoload-functions* |
7946 When using many or large functions, it's possible to automatically define them | |
161 | 7947 only when they are used. There are two methods: with an autocommand and with |
7948 the "autoload" directory in 'runtimepath'. | |
7949 | |
7950 | |
7951 Using an autocommand ~ | |
7952 | |
170 | 7953 This is introduced in the user manual, section |41.14|. |
7954 | |
161 | 7955 The autocommand is useful if you have a plugin that is a long Vim script file. |
7956 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 7957 That makes Vim startup faster. The autocommand should then load the same file |
161 | 7958 again, setting a variable to skip the |:finish| command. |
7959 | |
7960 Use the FuncUndefined autocommand event with a pattern that matches the | |
7961 function(s) to be defined. Example: > | |
7 | 7962 |
7963 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
7964 | |
7965 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
7966 "BufNet". Also see |FuncUndefined|. | |
7967 | |
161 | 7968 |
7969 Using an autoload script ~ | |
168 | 7970 *autoload* *E746* |
170 | 7971 This is introduced in the user manual, section |41.15|. |
7972 | |
161 | 7973 Using a script in the "autoload" directory is simpler, but requires using |
7974 exactly the right file name. A function that can be autoloaded has a name | |
7975 like this: > | |
7976 | |
270 | 7977 :call filename#funcname() |
161 | 7978 |
7979 When such a function is called, and it is not defined yet, Vim will search the | |
7980 "autoload" directories in 'runtimepath' for a script file called | |
7981 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
7982 then define the function like this: > | |
7983 | |
270 | 7984 function filename#funcname() |
161 | 7985 echo "Done!" |
7986 endfunction | |
7987 | |
530 | 7988 The file name and the name used before the # in the function must match |
161 | 7989 exactly, and the defined function must have the name exactly as it will be |
7990 called. | |
7991 | |
270 | 7992 It is possible to use subdirectories. Every # in the function name works like |
7993 a path separator. Thus when calling a function: > | |
7994 | |
7995 :call foo#bar#func() | |
161 | 7996 |
7997 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
7998 | |
168 | 7999 This also works when reading a variable that has not been set yet: > |
8000 | |
270 | 8001 :let l = foo#bar#lvar |
168 | 8002 |
557 | 8003 However, when the autoload script was already loaded it won't be loaded again |
8004 for an unknown variable. | |
8005 | |
168 | 8006 When assigning a value to such a variable nothing special happens. This can |
8007 be used to pass settings to the autoload script before it's loaded: > | |
8008 | |
270 | 8009 :let foo#bar#toggle = 1 |
8010 :call foo#bar#func() | |
168 | 8011 |
164 | 8012 Note that when you make a mistake and call a function that is supposed to be |
8013 defined in an autoload script, but the script doesn't actually define the | |
8014 function, the script will be sourced every time you try to call the function. | |
168 | 8015 And you will get an error message every time. |
8016 | |
8017 Also note that if you have two script files, and one calls a function in the | |
1621 | 8018 other and vice versa, before the used function is defined, it won't work. |
168 | 8019 Avoid using the autoload functionality at the toplevel. |
161 | 8020 |
794 | 8021 Hint: If you distribute a bunch of scripts you can pack them together with the |
8022 |vimball| utility. Also read the user manual |distribute-script|. | |
8023 | |
7 | 8024 ============================================================================== |
8025 6. Curly braces names *curly-braces-names* | |
8026 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8027 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
|
8028 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
|
8029 wrapped in braces {} like this: > |
7 | 8030 my_{adjective}_variable |
8031 | |
8032 When Vim encounters this, it evaluates the expression inside the braces, puts | |
8033 that in place of the expression, and re-interprets the whole as a variable | |
8034 name. So in the above example, if the variable "adjective" was set to | |
8035 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
8036 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
8037 | |
8038 One application for this is to create a set of variables governed by an option | |
1621 | 8039 value. For example, the statement > |
7 | 8040 echo my_{&background}_message |
8041 | |
8042 would output the contents of "my_dark_message" or "my_light_message" depending | |
8043 on the current value of 'background'. | |
8044 | |
8045 You can use multiple brace pairs: > | |
8046 echo my_{adverb}_{adjective}_message | |
8047 ..or even nest them: > | |
8048 echo my_{ad{end_of_word}}_message | |
8049 where "end_of_word" is either "verb" or "jective". | |
8050 | |
8051 However, the expression inside the braces must evaluate to a valid single | |
236 | 8052 variable name, e.g. this is invalid: > |
7 | 8053 :let foo='a + b' |
8054 :echo c{foo}d | |
8055 .. since the result of expansion is "ca + bd", which is not a variable name. | |
8056 | |
8057 *curly-braces-function-names* | |
8058 You can call and define functions by an evaluated name in a similar way. | |
8059 Example: > | |
8060 :let func_end='whizz' | |
8061 :call my_func_{func_end}(parameter) | |
8062 | |
8063 This would call the function "my_func_whizz(parameter)". | |
8064 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8065 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8066 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8067 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8068 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8069 |
7 | 8070 ============================================================================== |
8071 7. Commands *expression-commands* | |
8072 | |
8073 :let {var-name} = {expr1} *:let* *E18* | |
8074 Set internal variable {var-name} to the result of the | |
8075 expression {expr1}. The variable will get the type | |
8076 from the {expr}. If {var-name} didn't exist yet, it | |
8077 is created. | |
8078 | |
85 | 8079 :let {var-name}[{idx}] = {expr1} *E689* |
8080 Set a list item to the result of the expression | |
8081 {expr1}. {var-name} must refer to a list and {idx} | |
8082 must be a valid index in that list. For nested list | |
8083 the index can be repeated. | |
1621 | 8084 This cannot be used to add an item to a |List|. |
8085 This cannot be used to set a byte in a String. You | |
8086 can do that like this: > | |
8087 :let var = var[0:2] . 'X' . var[4:] | |
8088 < | |
114 | 8089 *E711* *E719* |
8090 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 8091 Set a sequence of items in a |List| to the result of |
8092 the expression {expr1}, which must be a list with the | |
87 | 8093 correct number of items. |
8094 {idx1} can be omitted, zero is used instead. | |
8095 {idx2} can be omitted, meaning the end of the list. | |
8096 When the selected range of items is partly past the | |
8097 end of the list, items will be added. | |
8098 | |
153 | 8099 *:let+=* *:let-=* *:let.=* *E734* |
114 | 8100 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
8101 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
8102 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
8103 These fail if {var} was not set yet and when the type | |
8104 of {var} and {expr1} don't fit the operator. | |
8105 | |
8106 | |
7 | 8107 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
8108 Set environment variable {env-name} to the result of | |
8109 the expression {expr1}. The type is always String. | |
114 | 8110 :let ${env-name} .= {expr1} |
8111 Append {expr1} to the environment variable {env-name}. | |
8112 If the environment variable didn't exist yet this | |
8113 works like "=". | |
7 | 8114 |
8115 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
8116 Write the result of the expression {expr1} in register | |
8117 {reg-name}. {reg-name} must be a single letter, and | |
8118 must be the name of a writable register (see | |
8119 |registers|). "@@" can be used for the unnamed | |
8120 register, "@/" for the search pattern. | |
8121 If the result of {expr1} ends in a <CR> or <NL>, the | |
8122 register will be linewise, otherwise it will be set to | |
8123 characterwise. | |
8124 This can be used to clear the last search pattern: > | |
8125 :let @/ = "" | |
8126 < This is different from searching for an empty string, | |
8127 that would match everywhere. | |
8128 | |
114 | 8129 :let @{reg-name} .= {expr1} |
1621 | 8130 Append {expr1} to register {reg-name}. If the |
114 | 8131 register was empty it's like setting it to {expr1}. |
8132 | |
1156 | 8133 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 8134 Set option {option-name} to the result of the |
68 | 8135 expression {expr1}. A String or Number value is |
8136 always converted to the type of the option. | |
7 | 8137 For an option local to a window or buffer the effect |
8138 is just like using the |:set| command: both the local | |
555 | 8139 value and the global value are changed. |
68 | 8140 Example: > |
8141 :let &path = &path . ',/usr/local/include' | |
7 | 8142 |
114 | 8143 :let &{option-name} .= {expr1} |
8144 For a string option: Append {expr1} to the value. | |
8145 Does not insert a comma like |:set+=|. | |
8146 | |
8147 :let &{option-name} += {expr1} | |
8148 :let &{option-name} -= {expr1} | |
8149 For a number or boolean option: Add or subtract | |
8150 {expr1}. | |
8151 | |
7 | 8152 :let &l:{option-name} = {expr1} |
114 | 8153 :let &l:{option-name} .= {expr1} |
8154 :let &l:{option-name} += {expr1} | |
8155 :let &l:{option-name} -= {expr1} | |
7 | 8156 Like above, but only set the local value of an option |
8157 (if there is one). Works like |:setlocal|. | |
8158 | |
8159 :let &g:{option-name} = {expr1} | |
114 | 8160 :let &g:{option-name} .= {expr1} |
8161 :let &g:{option-name} += {expr1} | |
8162 :let &g:{option-name} -= {expr1} | |
7 | 8163 Like above, but only set the global value of an option |
8164 (if there is one). Works like |:setglobal|. | |
8165 | |
85 | 8166 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 8167 {expr1} must evaluate to a |List|. The first item in |
68 | 8168 the list is assigned to {name1}, the second item to |
8169 {name2}, etc. | |
8170 The number of names must match the number of items in | |
685 | 8171 the |List|. |
68 | 8172 Each name can be one of the items of the ":let" |
8173 command as mentioned above. | |
8174 Example: > | |
8175 :let [s, item] = GetItem(s) | |
114 | 8176 < Detail: {expr1} is evaluated first, then the |
8177 assignments are done in sequence. This matters if | |
8178 {name2} depends on {name1}. Example: > | |
8179 :let x = [0, 1] | |
8180 :let i = 0 | |
8181 :let [i, x[i]] = [1, 2] | |
8182 :echo x | |
8183 < The result is [0, 2]. | |
8184 | |
8185 :let [{name1}, {name2}, ...] .= {expr1} | |
8186 :let [{name1}, {name2}, ...] += {expr1} | |
8187 :let [{name1}, {name2}, ...] -= {expr1} | |
8188 Like above, but append/add/subtract the value for each | |
685 | 8189 |List| item. |
68 | 8190 |
8191 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 8192 Like |:let-unpack| above, but the |List| may have more |
114 | 8193 items than there are names. A list of the remaining |
8194 items is assigned to {lastname}. If there are no | |
8195 remaining items {lastname} is set to an empty list. | |
68 | 8196 Example: > |
8197 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
8198 < | |
114 | 8199 :let [{name}, ..., ; {lastname}] .= {expr1} |
8200 :let [{name}, ..., ; {lastname}] += {expr1} | |
8201 :let [{name}, ..., ; {lastname}] -= {expr1} | |
8202 Like above, but append/add/subtract the value for each | |
685 | 8203 |List| item. |
2596 | 8204 |
8205 *E121* | |
1621 | 8206 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 8207 variable names may be given. Special names recognized |
8208 here: *E738* | |
777 | 8209 g: global variables |
8210 b: local buffer variables | |
8211 w: local window variables | |
819 | 8212 t: local tab page variables |
777 | 8213 s: script-local variables |
8214 l: local function variables | |
123 | 8215 v: Vim variables. |
7 | 8216 |
55 | 8217 :let List the values of all variables. The type of the |
8218 variable is indicated before the value: | |
8219 <nothing> String | |
8220 # Number | |
856 | 8221 * Funcref |
7 | 8222 |
148 | 8223 |
1156 | 8224 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 8225 Remove the internal variable {name}. Several variable |
8226 names can be given, they are all removed. The name | |
685 | 8227 may also be a |List| or |Dictionary| item. |
7 | 8228 With [!] no error message is given for non-existing |
8229 variables. | |
685 | 8230 One or more items from a |List| can be removed: > |
108 | 8231 :unlet list[3] " remove fourth item |
8232 :unlet list[3:] " remove fourth item to last | |
685 | 8233 < One item from a |Dictionary| can be removed at a time: > |
108 | 8234 :unlet dict['two'] |
8235 :unlet dict.two | |
1668 | 8236 < This is especially useful to clean up used global |
8237 variables and script-local variables (these are not | |
8238 deleted when the script ends). Function-local | |
8239 variables are automatically deleted when the function | |
8240 ends. | |
7 | 8241 |
148 | 8242 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
8243 Lock the internal variable {name}. Locking means that | |
8244 it can no longer be changed (until it is unlocked). | |
8245 A locked variable can be deleted: > | |
8246 :lockvar v | |
8247 :let v = 'asdf' " fails! | |
8248 :unlet v | |
8249 < *E741* | |
8250 If you try to change a locked variable you get an | |
6530 | 8251 error message: "E741: Value is locked: {name}" |
148 | 8252 |
685 | 8253 [depth] is relevant when locking a |List| or |
8254 |Dictionary|. It specifies how deep the locking goes: | |
8255 1 Lock the |List| or |Dictionary| itself, | |
148 | 8256 cannot add or remove items, but can |
8257 still change their values. | |
8258 2 Also lock the values, cannot change | |
685 | 8259 the items. If an item is a |List| or |
8260 |Dictionary|, cannot add or remove | |
148 | 8261 items, but can still change the |
8262 values. | |
685 | 8263 3 Like 2 but for the |List| / |
8264 |Dictionary| in the |List| / | |
8265 |Dictionary|, one level deeper. | |
8266 The default [depth] is 2, thus when {name} is a |List| | |
8267 or |Dictionary| the values cannot be changed. | |
148 | 8268 *E743* |
8269 For unlimited depth use [!] and omit [depth]. | |
8270 However, there is a maximum depth of 100 to catch | |
8271 loops. | |
8272 | |
685 | 8273 Note that when two variables refer to the same |List| |
8274 and you lock one of them, the |List| will also be | |
819 | 8275 locked when used through the other variable. |
8276 Example: > | |
148 | 8277 :let l = [0, 1, 2, 3] |
8278 :let cl = l | |
8279 :lockvar l | |
8280 :let cl[1] = 99 " won't work! | |
8281 < You may want to make a copy of a list to avoid this. | |
8282 See |deepcopy()|. | |
8283 | |
8284 | |
8285 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
8286 Unlock the internal variable {name}. Does the | |
8287 opposite of |:lockvar|. | |
8288 | |
8289 | |
7 | 8290 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
8291 :en[dif] Execute the commands until the next matching ":else" | |
8292 or ":endif" if {expr1} evaluates to non-zero. | |
8293 | |
8294 From Vim version 4.5 until 5.0, every Ex command in | |
8295 between the ":if" and ":endif" is ignored. These two | |
8296 commands were just to allow for future expansions in a | |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
8297 backward compatible way. Nesting was allowed. Note |
7 | 8298 that any ":else" or ":elseif" was ignored, the "else" |
8299 part was not executed either. | |
8300 | |
8301 You can use this to remain compatible with older | |
8302 versions: > | |
8303 :if version >= 500 | |
8304 : version-5-specific-commands | |
8305 :endif | |
8306 < The commands still need to be parsed to find the | |
8307 "endif". Sometimes an older Vim has a problem with a | |
8308 new command. For example, ":silent" is recognized as | |
8309 a ":substitute" command. In that case ":execute" can | |
8310 avoid problems: > | |
8311 :if version >= 600 | |
8312 : execute "silent 1,$delete" | |
8313 :endif | |
8314 < | |
8315 NOTE: The ":append" and ":insert" commands don't work | |
8316 properly in between ":if" and ":endif". | |
8317 | |
8318 *:else* *:el* *E581* *E583* | |
8319 :el[se] Execute the commands until the next matching ":else" | |
8320 or ":endif" if they previously were not being | |
8321 executed. | |
8322 | |
8323 *:elseif* *:elsei* *E582* *E584* | |
8324 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
8325 is no extra ":endif". | |
8326 | |
8327 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 8328 *E170* *E585* *E588* *E733* |
7 | 8329 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
8330 as long as {expr1} evaluates to non-zero. | |
8331 When an error is detected from a command inside the | |
8332 loop, execution continues after the "endwhile". | |
75 | 8333 Example: > |
8334 :let lnum = 1 | |
8335 :while lnum <= line("$") | |
8336 :call FixLine(lnum) | |
8337 :let lnum = lnum + 1 | |
8338 :endwhile | |
8339 < | |
7 | 8340 NOTE: The ":append" and ":insert" commands don't work |
99 | 8341 properly inside a ":while" and ":for" loop. |
75 | 8342 |
114 | 8343 :for {var} in {list} *:for* *E690* *E732* |
75 | 8344 :endfo[r] *:endfo* *:endfor* |
8345 Repeat the commands between ":for" and ":endfor" for | |
158 | 8346 each item in {list}. Variable {var} is set to the |
79 | 8347 value of each item. |
8348 When an error is detected for a command inside the | |
75 | 8349 loop, execution continues after the "endfor". |
464 | 8350 Changing {list} inside the loop affects what items are |
8351 used. Make a copy if this is unwanted: > | |
79 | 8352 :for item in copy(mylist) |
8353 < When not making a copy, Vim stores a reference to the | |
8354 next item in the list, before executing the commands | |
1621 | 8355 with the current item. Thus the current item can be |
79 | 8356 removed without effect. Removing any later item means |
8357 it will not be found. Thus the following example | |
8358 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8359 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8360 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8361 endfor |
87 | 8362 < Note that reordering the list (e.g., with sort() or |
8363 reverse()) may have unexpected effects. | |
8364 Note that the type of each list item should be | |
75 | 8365 identical to avoid errors for the type of {var} |
8366 changing. Unlet the variable at the end of the loop | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8367 to allow multiple item types: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8368 for item in ["foo", ["bar"]] |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8369 echo item |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8370 unlet item " E706 without this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8371 endfor |
75 | 8372 |
8373 :for [{var1}, {var2}, ...] in {listlist} | |
8374 :endfo[r] | |
8375 Like ":for" above, but each item in {listlist} must be | |
8376 a list, of which each item is assigned to {var1}, | |
8377 {var2}, etc. Example: > | |
8378 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
8379 :echo getline(lnum)[col] | |
8380 :endfor | |
8381 < | |
7 | 8382 *:continue* *:con* *E586* |
75 | 8383 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
8384 to the start of the loop. | |
8385 If it is used after a |:try| inside the loop but | |
8386 before the matching |:finally| (if present), the | |
8387 commands following the ":finally" up to the matching | |
8388 |:endtry| are executed first. This process applies to | |
8389 all nested ":try"s inside the loop. The outermost | |
8390 ":endtry" then jumps back to the start of the loop. | |
7 | 8391 |
8392 *:break* *:brea* *E587* | |
75 | 8393 :brea[k] When used inside a ":while" or ":for" loop, skips to |
8394 the command after the matching ":endwhile" or | |
8395 ":endfor". | |
8396 If it is used after a |:try| inside the loop but | |
8397 before the matching |:finally| (if present), the | |
8398 commands following the ":finally" up to the matching | |
8399 |:endtry| are executed first. This process applies to | |
8400 all nested ":try"s inside the loop. The outermost | |
8401 ":endtry" then jumps to the command after the loop. | |
7 | 8402 |
8403 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
8404 :endt[ry] Change the error handling for the commands between | |
8405 ":try" and ":endtry" including everything being | |
8406 executed across ":source" commands, function calls, | |
8407 or autocommand invocations. | |
8408 | |
8409 When an error or interrupt is detected and there is | |
8410 a |:finally| command following, execution continues | |
8411 after the ":finally". Otherwise, or when the | |
8412 ":endtry" is reached thereafter, the next | |
8413 (dynamically) surrounding ":try" is checked for | |
8414 a corresponding ":finally" etc. Then the script | |
8415 processing is terminated. (Whether a function | |
8416 definition has an "abort" argument does not matter.) | |
8417 Example: > | |
8418 :try | edit too much | finally | echo "cleanup" | endtry | |
8419 :echo "impossible" " not reached, script terminated above | |
8420 < | |
8421 Moreover, an error or interrupt (dynamically) inside | |
8422 ":try" and ":endtry" is converted to an exception. It | |
8423 can be caught as if it were thrown by a |:throw| | |
8424 command (see |:catch|). In this case, the script | |
8425 processing is not terminated. | |
8426 | |
8427 The value "Vim:Interrupt" is used for an interrupt | |
8428 exception. An error in a Vim command is converted | |
8429 to a value of the form "Vim({command}):{errmsg}", | |
8430 other errors are converted to a value of the form | |
8431 "Vim:{errmsg}". {command} is the full command name, | |
8432 and {errmsg} is the message that is displayed if the | |
8433 error exception is not caught, always beginning with | |
8434 the error number. | |
8435 Examples: > | |
8436 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
8437 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
8438 < | |
8439 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8440 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 8441 |:finally|, or |:endtry| that belongs to the same |
8442 |:try| as the ":catch" are executed when an exception | |
8443 matching {pattern} is being thrown and has not yet | |
8444 been caught by a previous ":catch". Otherwise, these | |
8445 commands are skipped. | |
8446 When {pattern} is omitted all errors are caught. | |
8447 Examples: > | |
8448 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
8449 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
8450 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
8451 :catch /^Vim(write):/ " catch all errors in :write | |
8452 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
8453 :catch /my-exception/ " catch user exception | |
8454 :catch /.*/ " catch everything | |
8455 :catch " same as /.*/ | |
8456 < | |
8457 Another character can be used instead of / around the | |
8458 {pattern}, so long as it does not have a special | |
8459 meaning (e.g., '|' or '"') and doesn't occur inside | |
8460 {pattern}. | |
5814 | 8461 Information about the exception is available in |
8462 |v:exception|. Also see |throw-variables|. | |
7 | 8463 NOTE: It is not reliable to ":catch" the TEXT of |
8464 an error message because it may vary in different | |
8465 locales. | |
8466 | |
8467 *:fina* *:finally* *E606* *E607* | |
8468 :fina[lly] The following commands until the matching |:endtry| | |
8469 are executed whenever the part between the matching | |
8470 |:try| and the ":finally" is left: either by falling | |
8471 through to the ":finally" or by a |:continue|, | |
8472 |:break|, |:finish|, or |:return|, or by an error or | |
8473 interrupt or exception (see |:throw|). | |
8474 | |
8475 *:th* *:throw* *E608* | |
8476 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
8477 If the ":throw" is used after a |:try| but before the | |
8478 first corresponding |:catch|, commands are skipped | |
8479 until the first ":catch" matching {expr1} is reached. | |
8480 If there is no such ":catch" or if the ":throw" is | |
8481 used after a ":catch" but before the |:finally|, the | |
8482 commands following the ":finally" (if present) up to | |
8483 the matching |:endtry| are executed. If the ":throw" | |
8484 is after the ":finally", commands up to the ":endtry" | |
8485 are skipped. At the ":endtry", this process applies | |
8486 again for the next dynamically surrounding ":try" | |
8487 (which may be found in a calling function or sourcing | |
8488 script), until a matching ":catch" has been found. | |
8489 If the exception is not caught, the command processing | |
8490 is terminated. | |
8491 Example: > | |
8492 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 8493 < Note that "catch" may need to be on a separate line |
8494 for when an error causes the parsing to skip the whole | |
8495 line and not see the "|" that separates the commands. | |
7 | 8496 |
8497 *:ec* *:echo* | |
8498 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
8499 first {expr1} starts on a new line. | |
8500 Also see |:comment|. | |
8501 Use "\n" to start a new line. Use "\r" to move the | |
8502 cursor to the first column. | |
8503 Uses the highlighting set by the |:echohl| command. | |
8504 Cannot be followed by a comment. | |
8505 Example: > | |
8506 :echo "the value of 'shell' is" &shell | |
1156 | 8507 < *:echo-redraw* |
8508 A later redraw may make the message disappear again. | |
8509 And since Vim mostly postpones redrawing until it's | |
8510 finished with a sequence of commands this happens | |
8511 quite often. To avoid that a command from before the | |
8512 ":echo" causes a redraw afterwards (redraws are often | |
8513 postponed until you type something), force a redraw | |
8514 with the |:redraw| command. Example: > | |
7 | 8515 :new | redraw | echo "there is a new window" |
8516 < | |
8517 *:echon* | |
8518 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
8519 |:comment|. | |
8520 Uses the highlighting set by the |:echohl| command. | |
8521 Cannot be followed by a comment. | |
8522 Example: > | |
8523 :echon "the value of 'shell' is " &shell | |
8524 < | |
8525 Note the difference between using ":echo", which is a | |
8526 Vim command, and ":!echo", which is an external shell | |
8527 command: > | |
8528 :!echo % --> filename | |
8529 < The arguments of ":!" are expanded, see |:_%|. > | |
8530 :!echo "%" --> filename or "filename" | |
8531 < Like the previous example. Whether you see the double | |
8532 quotes or not depends on your 'shell'. > | |
8533 :echo % --> nothing | |
8534 < The '%' is an illegal character in an expression. > | |
8535 :echo "%" --> % | |
8536 < This just echoes the '%' character. > | |
8537 :echo expand("%") --> filename | |
8538 < This calls the expand() function to expand the '%'. | |
8539 | |
8540 *:echoh* *:echohl* | |
8541 :echoh[l] {name} Use the highlight group {name} for the following | |
8542 |:echo|, |:echon| and |:echomsg| commands. Also used | |
8543 for the |input()| prompt. Example: > | |
8544 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
8545 < Don't forget to set the group back to "None", | |
8546 otherwise all following echo's will be highlighted. | |
8547 | |
8548 *:echom* *:echomsg* | |
8549 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
8550 message in the |message-history|. | |
8551 Spaces are placed between the arguments as with the | |
8552 |:echo| command. But unprintable characters are | |
8553 displayed, not interpreted. | |
1156 | 8554 The parsing works slightly different from |:echo|, |
8555 more like |:execute|. All the expressions are first | |
8556 evaluated and concatenated before echoing anything. | |
8557 The expressions must evaluate to a Number or String, a | |
8558 Dictionary or List causes an error. | |
7 | 8559 Uses the highlighting set by the |:echohl| command. |
8560 Example: > | |
8561 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 8562 < See |:echo-redraw| to avoid the message disappearing |
8563 when the screen is redrawn. | |
7 | 8564 *:echoe* *:echoerr* |
8565 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
8566 message in the |message-history|. When used in a | |
8567 script or function the line number will be added. | |
8568 Spaces are placed between the arguments as with the | |
1621 | 8569 :echo command. When used inside a try conditional, |
7 | 8570 the message is raised as an error exception instead |
8571 (see |try-echoerr|). | |
8572 Example: > | |
8573 :echoerr "This script just failed!" | |
8574 < If you just want a highlighted message use |:echohl|. | |
8575 And to get a beep: > | |
8576 :exe "normal \<Esc>" | |
8577 < | |
8578 *:exe* *:execute* | |
8579 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 8580 of {expr1} as an Ex command. |
8581 Multiple arguments are concatenated, with a space in | |
8582 between. To avoid the extra space use the "." | |
8583 operator to concatenate strings into one argument. | |
8584 {expr1} is used as the processed command, command line | |
8585 editing keys are not recognized. | |
7 | 8586 Cannot be followed by a comment. |
8587 Examples: > | |
2152 | 8588 :execute "buffer" nextbuf |
8589 :execute "normal" count . "w" | |
7 | 8590 < |
8591 ":execute" can be used to append a command to commands | |
8592 that don't accept a '|'. Example: > | |
8593 :execute '!ls' | echo "theend" | |
8594 | |
8595 < ":execute" is also a nice way to avoid having to type | |
8596 control characters in a Vim script for a ":normal" | |
8597 command: > | |
8598 :execute "normal ixxx\<Esc>" | |
8599 < This has an <Esc> character, see |expr-string|. | |
8600 | |
1621 | 8601 Be careful to correctly escape special characters in |
8602 file names. The |fnameescape()| function can be used | |
1661 | 8603 for Vim commands, |shellescape()| for |:!| commands. |
8604 Examples: > | |
1621 | 8605 :execute "e " . fnameescape(filename) |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
8606 :execute "!ls " . shellescape(filename, 1) |
1621 | 8607 < |
7 | 8608 Note: The executed string may be any command-line, but |
5763 | 8609 starting or ending "if", "while" and "for" does not |
8610 always work, because when commands are skipped the | |
8611 ":execute" is not evaluated and Vim loses track of | |
8612 where blocks start and end. Also "break" and | |
8613 "continue" should not be inside ":execute". | |
8614 This example does not work, because the ":execute" is | |
8615 not evaluated and Vim does not see the "while", and | |
8616 gives an error for finding an ":endwhile": > | |
8617 :if 0 | |
8618 : execute 'while i > 5' | |
8619 : echo "test" | |
8620 : endwhile | |
8621 :endif | |
7 | 8622 < |
8623 It is allowed to have a "while" or "if" command | |
8624 completely in the executed string: > | |
8625 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
8626 < | |
8627 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8628 *:exe-comment* |
7 | 8629 ":execute", ":echo" and ":echon" cannot be followed by |
8630 a comment directly, because they see the '"' as the | |
8631 start of a string. But, you can use '|' followed by a | |
8632 comment. Example: > | |
8633 :echo "foo" | "this is a comment | |
8634 | |
8635 ============================================================================== | |
8636 8. Exception handling *exception-handling* | |
8637 | |
8638 The Vim script language comprises an exception handling feature. This section | |
8639 explains how it can be used in a Vim script. | |
8640 | |
8641 Exceptions may be raised by Vim on an error or on interrupt, see | |
8642 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
8643 exception by using the ":throw" command, see |throw-catch|. | |
8644 | |
8645 | |
8646 TRY CONDITIONALS *try-conditionals* | |
8647 | |
8648 Exceptions can be caught or can cause cleanup code to be executed. You can | |
8649 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
8650 a finally clause (to be executed for cleanup). | |
8651 A try conditional begins with a |:try| command and ends at the matching | |
8652 |:endtry| command. In between, you can use a |:catch| command to start | |
8653 a catch clause, or a |:finally| command to start a finally clause. There may | |
8654 be none or multiple catch clauses, but there is at most one finally clause, | |
8655 which must not be followed by any catch clauses. The lines before the catch | |
8656 clauses and the finally clause is called a try block. > | |
8657 | |
8658 :try | |
1621 | 8659 : ... |
8660 : ... TRY BLOCK | |
8661 : ... | |
7 | 8662 :catch /{pattern}/ |
1621 | 8663 : ... |
8664 : ... CATCH CLAUSE | |
8665 : ... | |
7 | 8666 :catch /{pattern}/ |
1621 | 8667 : ... |
8668 : ... CATCH CLAUSE | |
8669 : ... | |
7 | 8670 :finally |
1621 | 8671 : ... |
8672 : ... FINALLY CLAUSE | |
8673 : ... | |
7 | 8674 :endtry |
8675 | |
8676 The try conditional allows to watch code for exceptions and to take the | |
8677 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
8678 from the try block and also the catch clauses may cause cleanup actions. | |
8679 When no exception is thrown during execution of the try block, the control | |
8680 is transferred to the finally clause, if present. After its execution, the | |
8681 script continues with the line following the ":endtry". | |
8682 When an exception occurs during execution of the try block, the remaining | |
8683 lines in the try block are skipped. The exception is matched against the | |
8684 patterns specified as arguments to the ":catch" commands. The catch clause | |
8685 after the first matching ":catch" is taken, other catch clauses are not | |
8686 executed. The catch clause ends when the next ":catch", ":finally", or | |
8687 ":endtry" command is reached - whatever is first. Then, the finally clause | |
8688 (if present) is executed. When the ":endtry" is reached, the script execution | |
8689 continues in the following line as usual. | |
8690 When an exception that does not match any of the patterns specified by the | |
8691 ":catch" commands is thrown in the try block, the exception is not caught by | |
8692 that try conditional and none of the catch clauses is executed. Only the | |
8693 finally clause, if present, is taken. The exception pends during execution of | |
8694 the finally clause. It is resumed at the ":endtry", so that commands after | |
8695 the ":endtry" are not executed and the exception might be caught elsewhere, | |
8696 see |try-nesting|. | |
8697 When during execution of a catch clause another exception is thrown, the | |
1621 | 8698 remaining lines in that catch clause are not executed. The new exception is |
7 | 8699 not matched against the patterns in any of the ":catch" commands of the same |
8700 try conditional and none of its catch clauses is taken. If there is, however, | |
8701 a finally clause, it is executed, and the exception pends during its | |
8702 execution. The commands following the ":endtry" are not executed. The new | |
8703 exception might, however, be caught elsewhere, see |try-nesting|. | |
8704 When during execution of the finally clause (if present) an exception is | |
1621 | 8705 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 8706 clause has been taken because of an exception from the try block or one of the |
8707 catch clauses, the original (pending) exception is discarded. The commands | |
8708 following the ":endtry" are not executed, and the exception from the finally | |
8709 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
8710 | |
8711 The finally clause is also executed, when a ":break" or ":continue" for | |
8712 a ":while" loop enclosing the complete try conditional is executed from the | |
8713 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
8714 from the try block or a catch clause of a try conditional in a function or | |
8715 sourced script, respectively. The ":break", ":continue", ":return", or | |
8716 ":finish" pends during execution of the finally clause and is resumed when the | |
8717 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
8718 from the finally clause. | |
8719 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
8720 try conditional or when a ":return" or ":finish" is encountered in the finally | |
8721 clause, the rest of the finally clause is skipped, and the ":break", | |
8722 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
8723 clause has been taken because of an exception or an earlier ":break", | |
8724 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
8725 this pending exception or command is discarded. | |
8726 | |
8727 For examples see |throw-catch| and |try-finally|. | |
8728 | |
8729 | |
8730 NESTING OF TRY CONDITIONALS *try-nesting* | |
8731 | |
8732 Try conditionals can be nested arbitrarily. That is, a complete try | |
8733 conditional can be put into the try block, a catch clause, or the finally | |
8734 clause of another try conditional. If the inner try conditional does not | |
8735 catch an exception thrown in its try block or throws a new exception from one | |
8736 of its catch clauses or its finally clause, the outer try conditional is | |
8737 checked according to the rules above. If the inner try conditional is in the | |
8738 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 8739 otherwise only the finally clause is executed. It does not matter for |
7 | 8740 nesting, whether the inner try conditional is directly contained in the outer |
8741 one, or whether the outer one sources a script or calls a function containing | |
8742 the inner try conditional. | |
8743 | |
8744 When none of the active try conditionals catches an exception, just their | |
8745 finally clauses are executed. Thereafter, the script processing terminates. | |
8746 An error message is displayed in case of an uncaught exception explicitly | |
8747 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
8748 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
8749 as usual. | |
8750 | |
8751 For examples see |throw-catch|. | |
8752 | |
8753 | |
8754 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
8755 | |
8756 Exception handling code can get tricky. If you are in doubt what happens, set | |
8757 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
8758 script file. Then you see when an exception is thrown, discarded, caught, or | |
8759 finished. When using a verbosity level of at least 14, things pending in | |
8760 a finally clause are also shown. This information is also given in debug mode | |
8761 (see |debug-scripts|). | |
8762 | |
8763 | |
8764 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
8765 | |
8766 You can throw any number or string as an exception. Use the |:throw| command | |
8767 and pass the value to be thrown as argument: > | |
8768 :throw 4711 | |
8769 :throw "string" | |
8770 < *throw-expression* | |
8771 You can also specify an expression argument. The expression is then evaluated | |
8772 first, and the result is thrown: > | |
8773 :throw 4705 + strlen("string") | |
8774 :throw strpart("strings", 0, 6) | |
8775 | |
8776 An exception might be thrown during evaluation of the argument of the ":throw" | |
8777 command. Unless it is caught there, the expression evaluation is abandoned. | |
8778 The ":throw" command then does not throw a new exception. | |
8779 Example: > | |
8780 | |
8781 :function! Foo(arg) | |
8782 : try | |
8783 : throw a:arg | |
8784 : catch /foo/ | |
8785 : endtry | |
8786 : return 1 | |
8787 :endfunction | |
8788 : | |
8789 :function! Bar() | |
8790 : echo "in Bar" | |
8791 : return 4710 | |
8792 :endfunction | |
8793 : | |
8794 :throw Foo("arrgh") + Bar() | |
8795 | |
8796 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
8797 executed. > | |
8798 :throw Foo("foo") + Bar() | |
8799 however displays "in Bar" and throws 4711. | |
8800 | |
8801 Any other command that takes an expression as argument might also be | |
1621 | 8802 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 8803 exception is then propagated to the caller of the command. |
8804 Example: > | |
8805 | |
8806 :if Foo("arrgh") | |
8807 : echo "then" | |
8808 :else | |
8809 : echo "else" | |
8810 :endif | |
8811 | |
8812 Here neither of "then" or "else" is displayed. | |
8813 | |
8814 *catch-order* | |
8815 Exceptions can be caught by a try conditional with one or more |:catch| | |
8816 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
8817 command can be specified as a pattern argument. The subsequent catch clause | |
8818 gets executed when a matching exception is caught. | |
8819 Example: > | |
8820 | |
8821 :function! Foo(value) | |
8822 : try | |
8823 : throw a:value | |
8824 : catch /^\d\+$/ | |
8825 : echo "Number thrown" | |
8826 : catch /.*/ | |
8827 : echo "String thrown" | |
8828 : endtry | |
8829 :endfunction | |
8830 : | |
8831 :call Foo(0x1267) | |
8832 :call Foo('string') | |
8833 | |
8834 The first call to Foo() displays "Number thrown", the second "String thrown". | |
8835 An exception is matched against the ":catch" commands in the order they are | |
8836 specified. Only the first match counts. So you should place the more | |
8837 specific ":catch" first. The following order does not make sense: > | |
8838 | |
8839 : catch /.*/ | |
8840 : echo "String thrown" | |
8841 : catch /^\d\+$/ | |
8842 : echo "Number thrown" | |
8843 | |
8844 The first ":catch" here matches always, so that the second catch clause is | |
8845 never taken. | |
8846 | |
8847 *throw-variables* | |
8848 If you catch an exception by a general pattern, you may access the exact value | |
8849 in the variable |v:exception|: > | |
8850 | |
8851 : catch /^\d\+$/ | |
8852 : echo "Number thrown. Value is" v:exception | |
8853 | |
8854 You may also be interested where an exception was thrown. This is stored in | |
8855 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
8856 exception most recently caught as long it is not finished. | |
8857 Example: > | |
8858 | |
8859 :function! Caught() | |
8860 : if v:exception != "" | |
8861 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
8862 : else | |
8863 : echo 'Nothing caught' | |
8864 : endif | |
8865 :endfunction | |
8866 : | |
8867 :function! Foo() | |
8868 : try | |
8869 : try | |
8870 : try | |
8871 : throw 4711 | |
8872 : finally | |
8873 : call Caught() | |
8874 : endtry | |
8875 : catch /.*/ | |
8876 : call Caught() | |
8877 : throw "oops" | |
8878 : endtry | |
8879 : catch /.*/ | |
8880 : call Caught() | |
8881 : finally | |
8882 : call Caught() | |
8883 : endtry | |
8884 :endfunction | |
8885 : | |
8886 :call Foo() | |
8887 | |
8888 This displays > | |
8889 | |
8890 Nothing caught | |
8891 Caught "4711" in function Foo, line 4 | |
8892 Caught "oops" in function Foo, line 10 | |
8893 Nothing caught | |
8894 | |
8895 A practical example: The following command ":LineNumber" displays the line | |
8896 number in the script or function where it has been used: > | |
8897 | |
8898 :function! LineNumber() | |
8899 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
8900 :endfunction | |
8901 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
8902 < | |
8903 *try-nested* | |
8904 An exception that is not caught by a try conditional can be caught by | |
8905 a surrounding try conditional: > | |
8906 | |
8907 :try | |
8908 : try | |
8909 : throw "foo" | |
8910 : catch /foobar/ | |
8911 : echo "foobar" | |
8912 : finally | |
8913 : echo "inner finally" | |
8914 : endtry | |
8915 :catch /foo/ | |
8916 : echo "foo" | |
8917 :endtry | |
8918 | |
8919 The inner try conditional does not catch the exception, just its finally | |
8920 clause is executed. The exception is then caught by the outer try | |
8921 conditional. The example displays "inner finally" and then "foo". | |
8922 | |
8923 *throw-from-catch* | |
8924 You can catch an exception and throw a new one to be caught elsewhere from the | |
8925 catch clause: > | |
8926 | |
8927 :function! Foo() | |
8928 : throw "foo" | |
8929 :endfunction | |
8930 : | |
8931 :function! Bar() | |
8932 : try | |
8933 : call Foo() | |
8934 : catch /foo/ | |
8935 : echo "Caught foo, throw bar" | |
8936 : throw "bar" | |
8937 : endtry | |
8938 :endfunction | |
8939 : | |
8940 :try | |
8941 : call Bar() | |
8942 :catch /.*/ | |
8943 : echo "Caught" v:exception | |
8944 :endtry | |
8945 | |
8946 This displays "Caught foo, throw bar" and then "Caught bar". | |
8947 | |
8948 *rethrow* | |
8949 There is no real rethrow in the Vim script language, but you may throw | |
8950 "v:exception" instead: > | |
8951 | |
8952 :function! Bar() | |
8953 : try | |
8954 : call Foo() | |
8955 : catch /.*/ | |
8956 : echo "Rethrow" v:exception | |
8957 : throw v:exception | |
8958 : endtry | |
8959 :endfunction | |
8960 < *try-echoerr* | |
8961 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
8962 exceptions, because it is not possible to fake Vim internal exceptions. | |
8963 Trying so causes an error exception. You should throw your own exception | |
8964 denoting the situation. If you want to cause a Vim error exception containing | |
8965 the original error exception value, you can use the |:echoerr| command: > | |
8966 | |
8967 :try | |
8968 : try | |
8969 : asdf | |
8970 : catch /.*/ | |
8971 : echoerr v:exception | |
8972 : endtry | |
8973 :catch /.*/ | |
8974 : echo v:exception | |
8975 :endtry | |
8976 | |
8977 This code displays | |
8978 | |
1621 | 8979 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 8980 |
8981 | |
8982 CLEANUP CODE *try-finally* | |
8983 | |
8984 Scripts often change global settings and restore them at their end. If the | |
8985 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 8986 an inconsistent state. The same may happen to you in the development phase of |
7 | 8987 a script when an error occurs or you explicitly throw an exception without |
8988 catching it. You can solve these problems by using a try conditional with | |
8989 a finally clause for restoring the settings. Its execution is guaranteed on | |
8990 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
8991 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 8992 to exceptions. When not caught, they terminate the script after the finally |
7 | 8993 clause has been executed.) |
8994 Example: > | |
8995 | |
8996 :try | |
8997 : let s:saved_ts = &ts | |
8998 : set ts=17 | |
8999 : | |
9000 : " Do the hard work here. | |
9001 : | |
9002 :finally | |
9003 : let &ts = s:saved_ts | |
9004 : unlet s:saved_ts | |
9005 :endtry | |
9006 | |
9007 This method should be used locally whenever a function or part of a script | |
9008 changes global settings which need to be restored on failure or normal exit of | |
9009 that function or script part. | |
9010 | |
9011 *break-finally* | |
9012 Cleanup code works also when the try block or a catch clause is left by | |
9013 a ":continue", ":break", ":return", or ":finish". | |
9014 Example: > | |
9015 | |
9016 :let first = 1 | |
9017 :while 1 | |
9018 : try | |
9019 : if first | |
9020 : echo "first" | |
9021 : let first = 0 | |
9022 : continue | |
9023 : else | |
9024 : throw "second" | |
9025 : endif | |
9026 : catch /.*/ | |
9027 : echo v:exception | |
9028 : break | |
9029 : finally | |
9030 : echo "cleanup" | |
9031 : endtry | |
9032 : echo "still in while" | |
9033 :endwhile | |
9034 :echo "end" | |
9035 | |
9036 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
9037 | |
9038 :function! Foo() | |
9039 : try | |
9040 : return 4711 | |
9041 : finally | |
9042 : echo "cleanup\n" | |
9043 : endtry | |
9044 : echo "Foo still active" | |
9045 :endfunction | |
9046 : | |
9047 :echo Foo() "returned by Foo" | |
9048 | |
9049 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 9050 extra ":return" in the finally clause. (Above all, this would override the |
7 | 9051 return value.) |
9052 | |
9053 *except-from-finally* | |
9054 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
9055 a finally clause is possible, but not recommended since it abandons the | |
9056 cleanup actions for the try conditional. But, of course, interrupt and error | |
9057 exceptions might get raised from a finally clause. | |
9058 Example where an error in the finally clause stops an interrupt from | |
9059 working correctly: > | |
9060 | |
9061 :try | |
9062 : try | |
9063 : echo "Press CTRL-C for interrupt" | |
9064 : while 1 | |
9065 : endwhile | |
9066 : finally | |
9067 : unlet novar | |
9068 : endtry | |
9069 :catch /novar/ | |
9070 :endtry | |
9071 :echo "Script still running" | |
9072 :sleep 1 | |
9073 | |
9074 If you need to put commands that could fail into a finally clause, you should | |
9075 think about catching or ignoring the errors in these commands, see | |
9076 |catch-errors| and |ignore-errors|. | |
9077 | |
9078 | |
9079 CATCHING ERRORS *catch-errors* | |
9080 | |
9081 If you want to catch specific errors, you just have to put the code to be | |
9082 watched in a try block and add a catch clause for the error message. The | |
9083 presence of the try conditional causes all errors to be converted to an | |
9084 exception. No message is displayed and |v:errmsg| is not set then. To find | |
9085 the right pattern for the ":catch" command, you have to know how the format of | |
9086 the error exception is. | |
9087 Error exceptions have the following format: > | |
9088 | |
9089 Vim({cmdname}):{errmsg} | |
9090 or > | |
9091 Vim:{errmsg} | |
9092 | |
9093 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 9094 the command name is not known. {errmsg} is the error message usually produced |
7 | 9095 when the error occurs outside try conditionals. It always begins with |
9096 a capital "E", followed by a two or three-digit error number, a colon, and | |
9097 a space. | |
9098 | |
9099 Examples: | |
9100 | |
9101 The command > | |
9102 :unlet novar | |
9103 normally produces the error message > | |
9104 E108: No such variable: "novar" | |
9105 which is converted inside try conditionals to an exception > | |
9106 Vim(unlet):E108: No such variable: "novar" | |
9107 | |
9108 The command > | |
9109 :dwim | |
9110 normally produces the error message > | |
9111 E492: Not an editor command: dwim | |
9112 which is converted inside try conditionals to an exception > | |
9113 Vim:E492: Not an editor command: dwim | |
9114 | |
9115 You can catch all ":unlet" errors by a > | |
9116 :catch /^Vim(unlet):/ | |
9117 or all errors for misspelled command names by a > | |
9118 :catch /^Vim:E492:/ | |
9119 | |
9120 Some error messages may be produced by different commands: > | |
9121 :function nofunc | |
9122 and > | |
9123 :delfunction nofunc | |
9124 both produce the error message > | |
9125 E128: Function name must start with a capital: nofunc | |
9126 which is converted inside try conditionals to an exception > | |
9127 Vim(function):E128: Function name must start with a capital: nofunc | |
9128 or > | |
9129 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
9130 respectively. You can catch the error by its number independently on the | |
9131 command that caused it if you use the following pattern: > | |
9132 :catch /^Vim(\a\+):E128:/ | |
9133 | |
9134 Some commands like > | |
9135 :let x = novar | |
9136 produce multiple error messages, here: > | |
9137 E121: Undefined variable: novar | |
9138 E15: Invalid expression: novar | |
9139 Only the first is used for the exception value, since it is the most specific | |
9140 one (see |except-several-errors|). So you can catch it by > | |
9141 :catch /^Vim(\a\+):E121:/ | |
9142 | |
9143 You can catch all errors related to the name "nofunc" by > | |
9144 :catch /\<nofunc\>/ | |
9145 | |
9146 You can catch all Vim errors in the ":write" and ":read" commands by > | |
9147 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
9148 | |
9149 You can catch all Vim errors by the pattern > | |
9150 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
9151 < | |
9152 *catch-text* | |
9153 NOTE: You should never catch the error message text itself: > | |
9154 :catch /No such variable/ | |
6647 | 9155 only works in the English locale, but not when the user has selected |
7 | 9156 a different language by the |:language| command. It is however helpful to |
9157 cite the message text in a comment: > | |
9158 :catch /^Vim(\a\+):E108:/ " No such variable | |
9159 | |
9160 | |
9161 IGNORING ERRORS *ignore-errors* | |
9162 | |
9163 You can ignore errors in a specific Vim command by catching them locally: > | |
9164 | |
9165 :try | |
9166 : write | |
9167 :catch | |
9168 :endtry | |
9169 | |
9170 But you are strongly recommended NOT to use this simple form, since it could | |
9171 catch more than you want. With the ":write" command, some autocommands could | |
9172 be executed and cause errors not related to writing, for instance: > | |
9173 | |
9174 :au BufWritePre * unlet novar | |
9175 | |
9176 There could even be such errors you are not responsible for as a script | |
9177 writer: a user of your script might have defined such autocommands. You would | |
9178 then hide the error from the user. | |
9179 It is much better to use > | |
9180 | |
9181 :try | |
9182 : write | |
9183 :catch /^Vim(write):/ | |
9184 :endtry | |
9185 | |
9186 which only catches real write errors. So catch only what you'd like to ignore | |
9187 intentionally. | |
9188 | |
9189 For a single command that does not cause execution of autocommands, you could | |
9190 even suppress the conversion of errors to exceptions by the ":silent!" | |
9191 command: > | |
9192 :silent! nunmap k | |
9193 This works also when a try conditional is active. | |
9194 | |
9195 | |
9196 CATCHING INTERRUPTS *catch-interrupt* | |
9197 | |
9198 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 9199 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 9200 script is not terminated, then. |
9201 Example: > | |
9202 | |
9203 :function! TASK1() | |
9204 : sleep 10 | |
9205 :endfunction | |
9206 | |
9207 :function! TASK2() | |
9208 : sleep 20 | |
9209 :endfunction | |
9210 | |
9211 :while 1 | |
9212 : let command = input("Type a command: ") | |
9213 : try | |
9214 : if command == "" | |
9215 : continue | |
9216 : elseif command == "END" | |
9217 : break | |
9218 : elseif command == "TASK1" | |
9219 : call TASK1() | |
9220 : elseif command == "TASK2" | |
9221 : call TASK2() | |
9222 : else | |
9223 : echo "\nIllegal command:" command | |
9224 : continue | |
9225 : endif | |
9226 : catch /^Vim:Interrupt$/ | |
9227 : echo "\nCommand interrupted" | |
9228 : " Caught the interrupt. Continue with next prompt. | |
9229 : endtry | |
9230 :endwhile | |
9231 | |
9232 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 9233 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 9234 |
9235 For testing what happens when CTRL-C would be pressed on a specific line in | |
9236 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
9237 command on that line. See |debug-scripts|. | |
9238 | |
9239 | |
9240 CATCHING ALL *catch-all* | |
9241 | |
9242 The commands > | |
9243 | |
9244 :catch /.*/ | |
9245 :catch // | |
9246 :catch | |
9247 | |
9248 catch everything, error exceptions, interrupt exceptions and exceptions | |
9249 explicitly thrown by the |:throw| command. This is useful at the top level of | |
9250 a script in order to catch unexpected things. | |
9251 Example: > | |
9252 | |
9253 :try | |
9254 : | |
9255 : " do the hard work here | |
9256 : | |
9257 :catch /MyException/ | |
9258 : | |
9259 : " handle known problem | |
9260 : | |
9261 :catch /^Vim:Interrupt$/ | |
9262 : echo "Script interrupted" | |
9263 :catch /.*/ | |
9264 : echo "Internal error (" . v:exception . ")" | |
9265 : echo " - occurred at " . v:throwpoint | |
9266 :endtry | |
9267 :" end of script | |
9268 | |
9269 Note: Catching all might catch more things than you want. Thus, you are | |
9270 strongly encouraged to catch only for problems that you can really handle by | |
9271 specifying a pattern argument to the ":catch". | |
9272 Example: Catching all could make it nearly impossible to interrupt a script | |
9273 by pressing CTRL-C: > | |
9274 | |
9275 :while 1 | |
9276 : try | |
9277 : sleep 1 | |
9278 : catch | |
9279 : endtry | |
9280 :endwhile | |
9281 | |
9282 | |
9283 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
9284 | |
9285 Exceptions may be used during execution of autocommands. Example: > | |
9286 | |
9287 :autocmd User x try | |
9288 :autocmd User x throw "Oops!" | |
9289 :autocmd User x catch | |
9290 :autocmd User x echo v:exception | |
9291 :autocmd User x endtry | |
9292 :autocmd User x throw "Arrgh!" | |
9293 :autocmd User x echo "Should not be displayed" | |
9294 : | |
9295 :try | |
9296 : doautocmd User x | |
9297 :catch | |
9298 : echo v:exception | |
9299 :endtry | |
9300 | |
9301 This displays "Oops!" and "Arrgh!". | |
9302 | |
9303 *except-autocmd-Pre* | |
9304 For some commands, autocommands get executed before the main action of the | |
9305 command takes place. If an exception is thrown and not caught in the sequence | |
9306 of autocommands, the sequence and the command that caused its execution are | |
9307 abandoned and the exception is propagated to the caller of the command. | |
9308 Example: > | |
9309 | |
9310 :autocmd BufWritePre * throw "FAIL" | |
9311 :autocmd BufWritePre * echo "Should not be displayed" | |
9312 : | |
9313 :try | |
9314 : write | |
9315 :catch | |
9316 : echo "Caught:" v:exception "from" v:throwpoint | |
9317 :endtry | |
9318 | |
9319 Here, the ":write" command does not write the file currently being edited (as | |
9320 you can see by checking 'modified'), since the exception from the BufWritePre | |
9321 autocommand abandons the ":write". The exception is then caught and the | |
9322 script displays: > | |
9323 | |
9324 Caught: FAIL from BufWrite Auto commands for "*" | |
9325 < | |
9326 *except-autocmd-Post* | |
9327 For some commands, autocommands get executed after the main action of the | |
9328 command has taken place. If this main action fails and the command is inside | |
9329 an active try conditional, the autocommands are skipped and an error exception | |
9330 is thrown that can be caught by the caller of the command. | |
9331 Example: > | |
9332 | |
9333 :autocmd BufWritePost * echo "File successfully written!" | |
9334 : | |
9335 :try | |
9336 : write /i/m/p/o/s/s/i/b/l/e | |
9337 :catch | |
9338 : echo v:exception | |
9339 :endtry | |
9340 | |
9341 This just displays: > | |
9342 | |
9343 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
9344 | |
9345 If you really need to execute the autocommands even when the main action | |
9346 fails, trigger the event from the catch clause. | |
9347 Example: > | |
9348 | |
9349 :autocmd BufWritePre * set noreadonly | |
9350 :autocmd BufWritePost * set readonly | |
9351 : | |
9352 :try | |
9353 : write /i/m/p/o/s/s/i/b/l/e | |
9354 :catch | |
9355 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
9356 :endtry | |
9357 < | |
9358 You can also use ":silent!": > | |
9359 | |
9360 :let x = "ok" | |
9361 :let v:errmsg = "" | |
9362 :autocmd BufWritePost * if v:errmsg != "" | |
9363 :autocmd BufWritePost * let x = "after fail" | |
9364 :autocmd BufWritePost * endif | |
9365 :try | |
9366 : silent! write /i/m/p/o/s/s/i/b/l/e | |
9367 :catch | |
9368 :endtry | |
9369 :echo x | |
9370 | |
9371 This displays "after fail". | |
9372 | |
9373 If the main action of the command does not fail, exceptions from the | |
9374 autocommands will be catchable by the caller of the command: > | |
9375 | |
9376 :autocmd BufWritePost * throw ":-(" | |
9377 :autocmd BufWritePost * echo "Should not be displayed" | |
9378 : | |
9379 :try | |
9380 : write | |
9381 :catch | |
9382 : echo v:exception | |
9383 :endtry | |
9384 < | |
9385 *except-autocmd-Cmd* | |
9386 For some commands, the normal action can be replaced by a sequence of | |
9387 autocommands. Exceptions from that sequence will be catchable by the caller | |
9388 of the command. | |
9389 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 9390 had actually been written when the exception occurred. You need to tell it in |
7 | 9391 some way. > |
9392 | |
9393 :if !exists("cnt") | |
9394 : let cnt = 0 | |
9395 : | |
9396 : autocmd BufWriteCmd * if &modified | |
9397 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
9398 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
9399 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
9400 : autocmd BufWriteCmd * endif | |
9401 : autocmd BufWriteCmd * write | set nomodified | |
9402 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
9403 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
9404 : autocmd BufWriteCmd * endif | |
9405 : autocmd BufWriteCmd * echo "File successfully written!" | |
9406 : autocmd BufWriteCmd * endif | |
9407 :endif | |
9408 : | |
9409 :try | |
9410 : write | |
9411 :catch /^BufWriteCmdError$/ | |
9412 : if &modified | |
9413 : echo "Error on writing (file contents not changed)" | |
9414 : else | |
9415 : echo "Error after writing" | |
9416 : endif | |
9417 :catch /^Vim(write):/ | |
9418 : echo "Error on writing" | |
9419 :endtry | |
9420 | |
9421 When this script is sourced several times after making changes, it displays | |
9422 first > | |
9423 File successfully written! | |
9424 then > | |
9425 Error on writing (file contents not changed) | |
9426 then > | |
9427 Error after writing | |
9428 etc. | |
9429 | |
9430 *except-autocmd-ill* | |
9431 You cannot spread a try conditional over autocommands for different events. | |
9432 The following code is ill-formed: > | |
9433 | |
9434 :autocmd BufWritePre * try | |
9435 : | |
9436 :autocmd BufWritePost * catch | |
9437 :autocmd BufWritePost * echo v:exception | |
9438 :autocmd BufWritePost * endtry | |
9439 : | |
9440 :write | |
9441 | |
9442 | |
9443 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
9444 | |
9445 Some programming languages allow to use hierarchies of exception classes or to | |
9446 pass additional information with the object of an exception class. You can do | |
9447 similar things in Vim. | |
9448 In order to throw an exception from a hierarchy, just throw the complete | |
9449 class name with the components separated by a colon, for instance throw the | |
9450 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
9451 When you want to pass additional information with your exception class, add | |
9452 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
9453 for an error when writing "myfile". | |
9454 With the appropriate patterns in the ":catch" command, you can catch for | |
9455 base classes or derived classes of your hierarchy. Additional information in | |
9456 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
9457 Example: > | |
9458 | |
9459 :function! CheckRange(a, func) | |
9460 : if a:a < 0 | |
9461 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
9462 : endif | |
9463 :endfunction | |
9464 : | |
9465 :function! Add(a, b) | |
9466 : call CheckRange(a:a, "Add") | |
9467 : call CheckRange(a:b, "Add") | |
9468 : let c = a:a + a:b | |
9469 : if c < 0 | |
9470 : throw "EXCEPT:MATHERR:OVERFLOW" | |
9471 : endif | |
9472 : return c | |
9473 :endfunction | |
9474 : | |
9475 :function! Div(a, b) | |
9476 : call CheckRange(a:a, "Div") | |
9477 : call CheckRange(a:b, "Div") | |
9478 : if (a:b == 0) | |
9479 : throw "EXCEPT:MATHERR:ZERODIV" | |
9480 : endif | |
9481 : return a:a / a:b | |
9482 :endfunction | |
9483 : | |
9484 :function! Write(file) | |
9485 : try | |
1621 | 9486 : execute "write" fnameescape(a:file) |
7 | 9487 : catch /^Vim(write):/ |
9488 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
9489 : endtry | |
9490 :endfunction | |
9491 : | |
9492 :try | |
9493 : | |
9494 : " something with arithmetics and I/O | |
9495 : | |
9496 :catch /^EXCEPT:MATHERR:RANGE/ | |
9497 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
9498 : echo "Range error in" function | |
9499 : | |
9500 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
9501 : echo "Math error" | |
9502 : | |
9503 :catch /^EXCEPT:IO/ | |
9504 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
9505 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
9506 : if file !~ '^/' | |
9507 : let file = dir . "/" . file | |
9508 : endif | |
9509 : echo 'I/O error for "' . file . '"' | |
9510 : | |
9511 :catch /^EXCEPT/ | |
9512 : echo "Unspecified error" | |
9513 : | |
9514 :endtry | |
9515 | |
9516 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
9517 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
9518 exceptions with the "Vim" prefix; they are reserved for Vim. | |
9519 Vim error exceptions are parameterized with the name of the command that | |
9520 failed, if known. See |catch-errors|. | |
9521 | |
9522 | |
9523 PECULIARITIES | |
9524 *except-compat* | |
9525 The exception handling concept requires that the command sequence causing the | |
9526 exception is aborted immediately and control is transferred to finally clauses | |
9527 and/or a catch clause. | |
9528 | |
9529 In the Vim script language there are cases where scripts and functions | |
9530 continue after an error: in functions without the "abort" flag or in a command | |
9531 after ":silent!", control flow goes to the following line, and outside | |
9532 functions, control flow goes to the line following the outermost ":endwhile" | |
9533 or ":endif". On the other hand, errors should be catchable as exceptions | |
9534 (thus, requiring the immediate abortion). | |
9535 | |
9536 This problem has been solved by converting errors to exceptions and using | |
9537 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 9538 conditional is active. This is no restriction since an (error) exception can |
9539 be caught only from an active try conditional. If you want an immediate | |
7 | 9540 termination without catching the error, just use a try conditional without |
9541 catch clause. (You can cause cleanup code being executed before termination | |
9542 by specifying a finally clause.) | |
9543 | |
9544 When no try conditional is active, the usual abortion and continuation | |
9545 behavior is used instead of immediate abortion. This ensures compatibility of | |
9546 scripts written for Vim 6.1 and earlier. | |
9547 | |
9548 However, when sourcing an existing script that does not use exception handling | |
9549 commands (or when calling one of its functions) from inside an active try | |
9550 conditional of a new script, you might change the control flow of the existing | |
9551 script on error. You get the immediate abortion on error and can catch the | |
9552 error in the new script. If however the sourced script suppresses error | |
9553 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 9554 |v:errmsg| if appropriate), its execution path is not changed. The error is |
9555 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 9556 where this happens is for scripts that don't care about errors and produce |
9557 error messages. You probably won't want to use such code from your new | |
9558 scripts. | |
9559 | |
9560 *except-syntax-err* | |
9561 Syntax errors in the exception handling commands are never caught by any of | |
9562 the ":catch" commands of the try conditional they belong to. Its finally | |
9563 clauses, however, is executed. | |
9564 Example: > | |
9565 | |
9566 :try | |
9567 : try | |
9568 : throw 4711 | |
9569 : catch /\(/ | |
9570 : echo "in catch with syntax error" | |
9571 : catch | |
9572 : echo "inner catch-all" | |
9573 : finally | |
9574 : echo "inner finally" | |
9575 : endtry | |
9576 :catch | |
9577 : echo 'outer catch-all caught "' . v:exception . '"' | |
9578 : finally | |
9579 : echo "outer finally" | |
9580 :endtry | |
9581 | |
9582 This displays: > | |
9583 inner finally | |
9584 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
9585 outer finally | |
9586 The original exception is discarded and an error exception is raised, instead. | |
9587 | |
9588 *except-single-line* | |
9589 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
9590 a single line, but then syntax errors may make it difficult to recognize the | |
9591 "catch" line, thus you better avoid this. | |
9592 Example: > | |
9593 :try | unlet! foo # | catch | endtry | |
9594 raises an error exception for the trailing characters after the ":unlet!" | |
9595 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
9596 error exception is discarded and the "E488: Trailing characters" message gets | |
9597 displayed. | |
9598 | |
9599 *except-several-errors* | |
9600 When several errors appear in a single command, the first error message is | |
9601 usually the most specific one and therefor converted to the error exception. | |
9602 Example: > | |
9603 echo novar | |
9604 causes > | |
9605 E121: Undefined variable: novar | |
9606 E15: Invalid expression: novar | |
9607 The value of the error exception inside try conditionals is: > | |
9608 Vim(echo):E121: Undefined variable: novar | |
9609 < *except-syntax-error* | |
9610 But when a syntax error is detected after a normal error in the same command, | |
9611 the syntax error is used for the exception being thrown. | |
9612 Example: > | |
9613 unlet novar # | |
9614 causes > | |
9615 E108: No such variable: "novar" | |
9616 E488: Trailing characters | |
9617 The value of the error exception inside try conditionals is: > | |
9618 Vim(unlet):E488: Trailing characters | |
9619 This is done because the syntax error might change the execution path in a way | |
9620 not intended by the user. Example: > | |
9621 try | |
9622 try | unlet novar # | catch | echo v:exception | endtry | |
9623 catch /.*/ | |
9624 echo "outer catch:" v:exception | |
9625 endtry | |
9626 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
9627 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
9628 | |
9629 ============================================================================== | |
9630 9. Examples *eval-examples* | |
9631 | |
1156 | 9632 Printing in Binary ~ |
7 | 9633 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9634 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 9635 :func Nr2Bin(nr) |
7 | 9636 : let n = a:nr |
9637 : let r = "" | |
9638 : while n | |
1156 | 9639 : let r = '01'[n % 2] . r |
9640 : let n = n / 2 | |
7 | 9641 : endwhile |
9642 : return r | |
9643 :endfunc | |
9644 | |
1156 | 9645 :" The function String2Bin() converts each character in a string to a |
9646 :" binary string, separated with dashes. | |
9647 :func String2Bin(str) | |
7 | 9648 : let out = '' |
1156 | 9649 : for ix in range(strlen(a:str)) |
9650 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
9651 : endfor | |
9652 : return out[1:] | |
7 | 9653 :endfunc |
9654 | |
9655 Example of its use: > | |
1156 | 9656 :echo Nr2Bin(32) |
9657 result: "100000" > | |
9658 :echo String2Bin("32") | |
9659 result: "110011-110010" | |
9660 | |
9661 | |
9662 Sorting lines ~ | |
9663 | |
9664 This example sorts lines with a specific compare function. > | |
9665 | |
9666 :func SortBuffer() | |
9667 : let lines = getline(1, '$') | |
9668 : call sort(lines, function("Strcmp")) | |
9669 : call setline(1, lines) | |
7 | 9670 :endfunction |
9671 | |
1156 | 9672 As a one-liner: > |
9673 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
9674 | |
9675 | |
9676 scanf() replacement ~ | |
7 | 9677 *sscanf* |
9678 There is no sscanf() function in Vim. If you need to extract parts from a | |
9679 line, you can use matchstr() and substitute() to do it. This example shows | |
9680 how to get the file name, line number and column number out of a line like | |
9681 "foobar.txt, 123, 45". > | |
9682 :" Set up the match bit | |
9683 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
9684 :"get the part matching the whole expression | |
9685 :let l = matchstr(line, mx) | |
9686 :"get each item out of the match | |
9687 :let file = substitute(l, mx, '\1', '') | |
9688 :let lnum = substitute(l, mx, '\2', '') | |
9689 :let col = substitute(l, mx, '\3', '') | |
9690 | |
9691 The input is in the variable "line", the results in the variables "file", | |
9692 "lnum" and "col". (idea from Michael Geddes) | |
9693 | |
1156 | 9694 |
9695 getting the scriptnames in a Dictionary ~ | |
9696 *scriptnames-dictionary* | |
9697 The |:scriptnames| command can be used to get a list of all script files that | |
9698 have been sourced. There is no equivalent function or variable for this | |
9699 (because it's rarely needed). In case you need to manipulate the list this | |
9700 code can be used: > | |
9701 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
9702 let scriptnames_output = '' | |
9703 redir => scriptnames_output | |
9704 silent scriptnames | |
9705 redir END | |
9706 | |
1621 | 9707 " Split the output into lines and parse each line. Add an entry to the |
1156 | 9708 " "scripts" dictionary. |
9709 let scripts = {} | |
9710 for line in split(scriptnames_output, "\n") | |
9711 " Only do non-blank lines. | |
9712 if line =~ '\S' | |
9713 " Get the first number in the line. | |
1621 | 9714 let nr = matchstr(line, '\d\+') |
1156 | 9715 " Get the file name, remove the script number " 123: ". |
1621 | 9716 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 9717 " Add an item to the Dictionary |
1621 | 9718 let scripts[nr] = name |
1156 | 9719 endif |
9720 endfor | |
9721 unlet scriptnames_output | |
9722 | |
7 | 9723 ============================================================================== |
9724 10. No +eval feature *no-eval-feature* | |
9725 | |
9726 When the |+eval| feature was disabled at compile time, none of the expression | |
9727 evaluation commands are available. To prevent this from causing Vim scripts | |
9728 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
9729 recognized, though the argument of the ":if" and everything between the ":if" | |
9730 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
9731 only if the commands are at the start of the line. The ":else" command is not | |
9732 recognized. | |
9733 | |
9734 Example of how to avoid executing commands when the |+eval| feature is | |
9735 missing: > | |
9736 | |
9737 :if 1 | |
9738 : echo "Expression evaluation is compiled in" | |
9739 :else | |
9740 : echo "You will _never_ see this message" | |
9741 :endif | |
9742 | |
9743 ============================================================================== | |
9744 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
9745 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9746 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
|
9747 '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
|
9748 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
|
9749 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
|
9750 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 9751 The sandbox is also used for the |:sandbox| command. |
7 | 9752 |
9753 These items are not allowed in the sandbox: | |
9754 - changing the buffer text | |
9755 - defining or changing mapping, autocommands, functions, user commands | |
9756 - setting certain options (see |option-summary|) | |
1156 | 9757 - setting certain v: variables (see |v:var|) *E794* |
7 | 9758 - executing a shell command |
9759 - reading or writing a file | |
9760 - jumping to another buffer or editing a file | |
625 | 9761 - executing Python, Perl, etc. commands |
29 | 9762 This is not guaranteed 100% secure, but it should block most attacks. |
9763 | |
9764 *:san* *:sandbox* | |
401 | 9765 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 9766 option that may have been set from a modeline, e.g. |
9767 'foldexpr'. | |
9768 | |
634 | 9769 *sandbox-option* |
9770 A few options contain an expression. When this expression is evaluated it may | |
790 | 9771 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 9772 restrictive, thus this only happens when the option was set from an insecure |
9773 location. Insecure in this context are: | |
843 | 9774 - sourcing a .vimrc or .exrc in the current directory |
634 | 9775 - while executing in the sandbox |
9776 - value coming from a modeline | |
9777 | |
9778 Note that when in the sandbox and saving an option value and restoring it, the | |
9779 option will still be marked as it was set in the sandbox. | |
9780 | |
9781 ============================================================================== | |
9782 12. Textlock *textlock* | |
9783 | |
9784 In a few situations it is not allowed to change the text in the buffer, jump | |
9785 to another window and some other things that might confuse or break what Vim | |
9786 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 9787 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 9788 happen any moment the mouse cursor is resting at some position. |
9789 | |
9790 This is not allowed when the textlock is active: | |
9791 - changing the buffer text | |
9792 - jumping to another buffer or window | |
9793 - editing another file | |
9794 - closing a window or quitting Vim | |
9795 - etc. | |
9796 | |
7 | 9797 |
9798 vim:tw=78:ts=8:ft=help:norl: |