Mercurial > vim
annotate runtime/doc/eval.txt @ 9041:34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Apr 30 15:13:38 2016 +0200
Update runtime files.
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sat, 30 Apr 2016 15:15:06 +0200 |
parents | 0bdeaf7092bc |
children | 9305a1251e51 |
rev | line source |
---|---|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Apr 26 |
1621 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
7 | 5 |
6 | |
7 Expression evaluation *expression* *expr* *E15* *eval* | |
8 | |
9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
10 | |
11 Note: Expression evaluation can be disabled at compile time. If this has been | |
1621 | 12 done, the features in this document are not available. See |+eval| and |
99 | 13 |no-eval-feature|. |
7 | 14 |
85 | 15 1. Variables |variables| |
16 1.1 Variable types | |
87 | 17 1.2 Function references |Funcref| |
161 | 18 1.3 Lists |Lists| |
99 | 19 1.4 Dictionaries |Dictionaries| |
20 1.5 More about variables |more-variables| | |
85 | 21 2. Expression syntax |expression-syntax| |
22 3. Internal variable |internal-variables| | |
23 4. Builtin Functions |functions| | |
24 5. Defining functions |user-functions| | |
25 6. Curly braces names |curly-braces-names| | |
26 7. Commands |expression-commands| | |
27 8. Exception handling |exception-handling| | |
28 9. Examples |eval-examples| | |
29 10. No +eval feature |no-eval-feature| | |
30 11. The sandbox |eval-sandbox| | |
634 | 31 12. Textlock |textlock| |
7 | 32 |
33 {Vi does not have any of these commands} | |
34 | |
35 ============================================================================== | |
36 1. Variables *variables* | |
37 | |
85 | 38 1.1 Variable types ~ |
114 | 39 *E712* |
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 | |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
49 *E928* |
99 | 50 String A NUL terminated string of 8-bit unsigned characters (bytes). |
1621 | 51 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
99 | 52 |
53 List An ordered sequence of items |List|. | |
54 Example: [1, 2, ['a', 'b']] | |
55 | 55 |
370 | 56 Dictionary An associative, unordered array: Each entry has a key and a |
57 value. |Dictionary| | |
58 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
59 | |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
60 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
|
61 Example: function("strlen") |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
62 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
63 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
|
64 |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
65 Job Used for a job, see |job_start()|. *Job* *Jobs* |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
66 |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
67 Channel Used for a channel, see |ch_open()|. *Channel* *Channels* |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
68 |
55 | 69 The Number and String types are converted automatically, depending on how they |
70 are used. | |
7 | 71 |
72 Conversion from a Number to a String is by making the ASCII representation of | |
2581 | 73 the Number. Examples: |
74 Number 123 --> String "123" ~ | |
75 Number 0 --> String "0" ~ | |
76 Number -1 --> String "-1" ~ | |
2152 | 77 *octal* |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
78 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
|
79 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
|
80 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
|
81 Examples: |
2581 | 82 String "456" --> Number 456 ~ |
83 String "6bar" --> Number 6 ~ | |
84 String "foo" --> Number 0 ~ | |
85 String "0xf1" --> Number 241 ~ | |
86 String "0100" --> Number 64 ~ | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
87 String "0b101" --> Number 5 ~ |
2581 | 88 String "-8" --> Number -8 ~ |
89 String "+8" --> Number 0 ~ | |
7 | 90 |
91 To force conversion from String to Number, add zero to it: > | |
92 :echo "0100" + 0 | |
782 | 93 < 64 ~ |
94 | |
95 To avoid a leading zero to cause octal conversion, or for using a different | |
96 base, use |str2nr()|. | |
7 | 97 |
98 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
99 | |
100 Note that in the command > | |
101 :if "foo" | |
102 "foo" is converted to 0, which means FALSE. To test for a non-empty string, | |
3893 | 103 use empty(): > |
104 :if !empty("foo") | |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
105 < |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
106 *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
|
107 List, Dictionary, Funcref and Job types are not automatically converted. |
85 | 108 |
1621 | 109 *E805* *E806* *E808* |
110 When mixing Number and Float the Number is converted to Float. Otherwise | |
111 there is no automatic conversion of Float. You can use str2float() for String | |
112 to Float, printf() for Float to String and float2nr() for Float to Number. | |
113 | |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
114 *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
|
115 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
|
116 |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
117 *no-type-checking* |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
118 You will not get an error if you try to change the type of a variable. |
85 | 119 |
120 | |
87 | 121 1.2 Function references ~ |
153 | 122 *Funcref* *E695* *E718* |
1621 | 123 A Funcref variable is obtained with the |function()| function. It can be used |
114 | 124 in an expression in the place of a function name, before the parenthesis |
125 around the arguments, to invoke the function it refers to. Example: > | |
55 | 126 |
127 :let Fn = function("MyFunc") | |
128 :echo Fn() | |
114 | 129 < *E704* *E705* *E707* |
819 | 130 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
5340 | 131 can use "g:" but the following name must still start with a capital. You |
819 | 132 cannot have both a Funcref variable and a function with the same name. |
85 | 133 |
114 | 134 A special case is defining a function and directly assigning its Funcref to a |
135 Dictionary entry. Example: > | |
136 :function dict.init() dict | |
137 : let self.val = 0 | |
138 :endfunction | |
139 | |
140 The key of the Dictionary can start with a lower case letter. The actual | |
141 function name is not used here. Also see |numbered-function|. | |
142 | |
143 A Funcref can also be used with the |:call| command: > | |
144 :call Fn() | |
145 :call dict.init() | |
85 | 146 |
147 The name of the referenced function can be obtained with |string()|. > | |
119 | 148 :let func = string(Fn) |
85 | 149 |
150 You can use |call()| to invoke a Funcref and use a list variable for the | |
151 arguments: > | |
119 | 152 :let r = call(Fn, mylist) |
85 | 153 |
154 | |
87 | 155 1.3 Lists ~ |
5814 | 156 *list* *List* *Lists* *E686* |
55 | 157 A List is an ordered sequence of items. An item can be of any type. Items |
1621 | 158 can be accessed by their index number. Items can be added and removed at any |
55 | 159 position in the sequence. |
160 | |
85 | 161 |
162 List creation ~ | |
163 *E696* *E697* | |
55 | 164 A List is created with a comma separated list of items in square brackets. |
85 | 165 Examples: > |
166 :let mylist = [1, two, 3, "four"] | |
167 :let emptylist = [] | |
55 | 168 |
1621 | 169 An item can be any expression. Using a List for an item creates a |
842 | 170 List of Lists: > |
85 | 171 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 172 |
173 An extra comma after the last item is ignored. | |
174 | |
85 | 175 |
176 List index ~ | |
177 *list-index* *E684* | |
55 | 178 An item in the List can be accessed by putting the index in square brackets |
85 | 179 after the List. Indexes are zero-based, thus the first item has index zero. > |
180 :let item = mylist[0] " get the first item: 1 | |
55 | 181 :let item = mylist[2] " get the third item: 3 |
85 | 182 |
87 | 183 When the resulting item is a list this can be repeated: > |
85 | 184 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 185 < |
85 | 186 A negative index is counted from the end. Index -1 refers to the last item in |
187 the List, -2 to the last but one item, etc. > | |
55 | 188 :let last = mylist[-1] " get the last item: "four" |
189 | |
85 | 190 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 191 is not available it returns zero or the default value you specify: > |
85 | 192 :echo get(mylist, idx) |
193 :echo get(mylist, idx, "NONE") | |
194 | |
195 | |
196 List concatenation ~ | |
197 | |
198 Two lists can be concatenated with the "+" operator: > | |
199 :let longlist = mylist + [5, 6] | |
119 | 200 :let mylist += [7, 8] |
85 | 201 |
202 To prepend or append an item turn the item into a list by putting [] around | |
203 it. To change a list in-place see |list-modification| below. | |
204 | |
205 | |
206 Sublist ~ | |
207 | |
55 | 208 A part of the List can be obtained by specifying the first and last index, |
209 separated by a colon in square brackets: > | |
85 | 210 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 211 |
212 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 213 similar to -1. > |
90 | 214 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
215 :let shortlist = mylist[2:2] " List with one item: [3] | |
216 :let otherlist = mylist[:] " make a copy of the List | |
85 | 217 |
842 | 218 If the first index is beyond the last item of the List or the second item is |
219 before the first item, the result is an empty list. There is no error | |
220 message. | |
221 | |
222 If the second index is equal to or greater than the length of the list the | |
223 length minus one is used: > | |
829 | 224 :let mylist = [0, 1, 2, 3] |
225 :echo mylist[2:8] " result: [2, 3] | |
226 | |
270 | 227 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
1621 | 228 using a single letter variable before the ":". Insert a space when needed: |
270 | 229 mylist[s : e]. |
230 | |
85 | 231 |
232 List identity ~ | |
99 | 233 *list-identity* |
85 | 234 When variable "aa" is a list and you assign it to another variable "bb", both |
235 variables refer to the same list. Thus changing the list "aa" will also | |
236 change "bb": > | |
237 :let aa = [1, 2, 3] | |
238 :let bb = aa | |
239 :call add(aa, 4) | |
240 :echo bb | |
114 | 241 < [1, 2, 3, 4] |
85 | 242 |
243 Making a copy of a list is done with the |copy()| function. Using [:] also | |
244 works, as explained above. This creates a shallow copy of the list: Changing | |
87 | 245 a list item in the list will also change the item in the copied list: > |
85 | 246 :let aa = [[1, 'a'], 2, 3] |
247 :let bb = copy(aa) | |
114 | 248 :call add(aa, 4) |
85 | 249 :let aa[0][1] = 'aaa' |
250 :echo aa | |
114 | 251 < [[1, aaa], 2, 3, 4] > |
85 | 252 :echo bb |
114 | 253 < [[1, aaa], 2, 3] |
85 | 254 |
87 | 255 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 256 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 257 |
258 The operator "is" can be used to check if two variables refer to the same | |
114 | 259 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 260 the same value. > |
261 :let alist = [1, 2, 3] | |
262 :let blist = [1, 2, 3] | |
263 :echo alist is blist | |
114 | 264 < 0 > |
87 | 265 :echo alist == blist |
114 | 266 < 1 |
85 | 267 |
323 | 268 Note about comparing lists: Two lists are considered equal if they have the |
269 same length and all items compare equal, as with using "==". There is one | |
388 | 270 exception: When comparing a number with a string they are considered |
271 different. There is no automatic type conversion, as with using "==" on | |
272 variables. Example: > | |
273 echo 4 == "4" | |
323 | 274 < 1 > |
388 | 275 echo [4] == ["4"] |
323 | 276 < 0 |
277 | |
388 | 278 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 279 can compare simple values this way too by putting them in a list: > |
388 | 280 |
281 :let a = 5 | |
282 :let b = "5" | |
1621 | 283 :echo a == b |
388 | 284 < 1 > |
1621 | 285 :echo [a] == [b] |
388 | 286 < 0 |
323 | 287 |
85 | 288 |
289 List unpack ~ | |
290 | |
291 To unpack the items in a list to individual variables, put the variables in | |
292 square brackets, like list items: > | |
293 :let [var1, var2] = mylist | |
294 | |
295 When the number of variables does not match the number of items in the list | |
296 this produces an error. To handle any extra items from the list append ";" | |
297 and a variable name: > | |
298 :let [var1, var2; rest] = mylist | |
299 | |
300 This works like: > | |
301 :let var1 = mylist[0] | |
302 :let var2 = mylist[1] | |
95 | 303 :let rest = mylist[2:] |
85 | 304 |
305 Except that there is no error if there are only two items. "rest" will be an | |
306 empty list then. | |
307 | |
308 | |
309 List modification ~ | |
310 *list-modification* | |
87 | 311 To change a specific item of a list use |:let| this way: > |
85 | 312 :let list[4] = "four" |
313 :let listlist[0][3] = item | |
314 | |
87 | 315 To change part of a list you can specify the first and last item to be |
114 | 316 modified. The value must at least have the number of items in the range: > |
87 | 317 :let list[3:5] = [3, 4, 5] |
318 | |
85 | 319 Adding and removing items from a list is done with functions. Here are a few |
320 examples: > | |
321 :call insert(list, 'a') " prepend item 'a' | |
322 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
323 :call add(list, "new") " append String item | |
114 | 324 :call add(list, [1, 2]) " append a List as one new item |
85 | 325 :call extend(list, [1, 2]) " extend the list with two more items |
326 :let i = remove(list, 3) " remove item 3 | |
108 | 327 :unlet list[3] " idem |
85 | 328 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 329 :unlet list[3 : ] " idem |
114 | 330 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
331 | |
332 Changing the order of items in a list: > | |
87 | 333 :call sort(list) " sort a list alphabetically |
334 :call reverse(list) " reverse the order of items | |
5747 | 335 :call uniq(sort(list)) " sort and remove duplicates |
87 | 336 |
85 | 337 |
338 For loop ~ | |
339 | |
87 | 340 The |:for| loop executes commands for each item in a list. A variable is set |
341 to each item in the list in sequence. Example: > | |
114 | 342 :for item in mylist |
343 : call Doit(item) | |
85 | 344 :endfor |
345 | |
346 This works like: > | |
347 :let index = 0 | |
348 :while index < len(mylist) | |
114 | 349 : let item = mylist[index] |
350 : :call Doit(item) | |
85 | 351 : let index = index + 1 |
352 :endwhile | |
353 | |
95 | 354 If all you want to do is modify each item in the list then the |map()| |
114 | 355 function will be a simpler method than a for loop. |
95 | 356 |
1621 | 357 Just like the |:let| command, |:for| also accepts a list of variables. This |
85 | 358 requires the argument to be a list of lists. > |
359 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
360 : call Doit(lnum, col) | |
361 :endfor | |
362 | |
363 This works like a |:let| command is done for each list item. Again, the types | |
364 must remain the same to avoid an error. | |
365 | |
114 | 366 It is also possible to put remaining items in a List variable: > |
85 | 367 :for [i, j; rest] in listlist |
368 : call Doit(i, j) | |
369 : if !empty(rest) | |
370 : echo "remainder: " . string(rest) | |
371 : endif | |
372 :endfor | |
373 | |
374 | |
375 List functions ~ | |
114 | 376 *E714* |
85 | 377 Functions that are useful with a List: > |
87 | 378 :let r = call(funcname, list) " call a function with an argument list |
85 | 379 :if empty(list) " check if list is empty |
102 | 380 :let l = len(list) " number of items in list |
381 :let big = max(list) " maximum value in list | |
382 :let small = min(list) " minimum value in list | |
87 | 383 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
384 :let i = index(list, 'x') " index of first 'x' in list | |
85 | 385 :let lines = getline(1, 10) " get ten text lines from buffer |
386 :call append('$', lines) " append text lines in buffer | |
95 | 387 :let list = split("a b c") " create list from items in a string |
388 :let string = join(list, ', ') " create string from list items | |
102 | 389 :let s = string(list) " String representation of list |
390 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
99 | 391 |
258 | 392 Don't forget that a combination of features can make things simple. For |
393 example, to add up all the numbers in a list: > | |
394 :exe 'let sum = ' . join(nrlist, '+') | |
395 | |
99 | 396 |
397 1.4 Dictionaries ~ | |
5814 | 398 *dict* *Dictionaries* *Dictionary* |
99 | 399 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 400 entry can be located with the key. The entries are stored without a specific |
401 ordering. | |
99 | 402 |
403 | |
404 Dictionary creation ~ | |
114 | 405 *E720* *E721* *E722* *E723* |
99 | 406 A Dictionary is created with a comma separated list of entries in curly |
114 | 407 braces. Each entry has a key and a value, separated by a colon. Each key can |
408 only appear once. Examples: > | |
99 | 409 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
410 :let emptydict = {} | |
114 | 411 < *E713* *E716* *E717* |
99 | 412 A key is always a String. You can use a Number, it will be converted to a |
413 String automatically. Thus the String '4' and the number 4 will find the same | |
1621 | 414 entry. Note that the String '04' and the Number 04 are different, since the |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
415 Number will be converted to the String '4'. The empty string can be used as a |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
416 key. |
114 | 417 |
1621 | 418 A value can be any expression. Using a Dictionary for a value creates a |
99 | 419 nested Dictionary: > |
420 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
421 | |
422 An extra comma after the last entry is ignored. | |
423 | |
424 | |
425 Accessing entries ~ | |
426 | |
427 The normal way to access an entry is by putting the key in square brackets: > | |
428 :let val = mydict["one"] | |
429 :let mydict["four"] = 4 | |
430 | |
114 | 431 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 432 |
433 For keys that consist entirely of letters, digits and underscore the following | |
434 form can be used |expr-entry|: > | |
435 :let val = mydict.one | |
436 :let mydict.four = 4 | |
437 | |
438 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
439 key lookup can be repeated: > | |
114 | 440 :echo dict.key[idx].key |
99 | 441 |
442 | |
443 Dictionary to List conversion ~ | |
444 | |
1621 | 445 You may want to loop over the entries in a dictionary. For this you need to |
99 | 446 turn the Dictionary into a List and pass it to |:for|. |
447 | |
448 Most often you want to loop over the keys, using the |keys()| function: > | |
449 :for key in keys(mydict) | |
450 : echo key . ': ' . mydict[key] | |
451 :endfor | |
452 | |
453 The List of keys is unsorted. You may want to sort them first: > | |
454 :for key in sort(keys(mydict)) | |
455 | |
456 To loop over the values use the |values()| function: > | |
457 :for v in values(mydict) | |
458 : echo "value: " . v | |
459 :endfor | |
460 | |
461 If you want both the key and the value use the |items()| function. It returns | |
1621 | 462 a List in which each item is a List with two items, the key and the value: > |
1156 | 463 :for [key, value] in items(mydict) |
464 : echo key . ': ' . value | |
99 | 465 :endfor |
466 | |
467 | |
468 Dictionary identity ~ | |
161 | 469 *dict-identity* |
99 | 470 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
471 Dictionary. Otherwise, assignment results in referring to the same | |
472 Dictionary: > | |
473 :let onedict = {'a': 1, 'b': 2} | |
474 :let adict = onedict | |
475 :let adict['a'] = 11 | |
476 :echo onedict['a'] | |
477 11 | |
478 | |
327 | 479 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
480 more info see |list-identity|. | |
99 | 481 |
482 | |
483 Dictionary modification ~ | |
484 *dict-modification* | |
485 To change an already existing entry of a Dictionary, or to add a new entry, | |
486 use |:let| this way: > | |
487 :let dict[4] = "four" | |
488 :let dict['one'] = item | |
489 | |
108 | 490 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
491 Three ways to remove the entry with key "aaa" from dict: > | |
492 :let i = remove(dict, 'aaa') | |
493 :unlet dict.aaa | |
494 :unlet dict['aaa'] | |
99 | 495 |
496 Merging a Dictionary with another is done with |extend()|: > | |
114 | 497 :call extend(adict, bdict) |
498 This extends adict with all entries from bdict. Duplicate keys cause entries | |
499 in adict to be overwritten. An optional third argument can change this. | |
119 | 500 Note that the order of entries in a Dictionary is irrelevant, thus don't |
501 expect ":echo adict" to show the items from bdict after the older entries in | |
502 adict. | |
99 | 503 |
504 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 505 :call filter(dict, 'v:val =~ "x"') |
114 | 506 This removes all entries from "dict" with a value not matching 'x'. |
102 | 507 |
508 | |
509 Dictionary function ~ | |
4159 | 510 *Dictionary-function* *self* *E725* *E862* |
102 | 511 When a function is defined with the "dict" attribute it can be used in a |
1621 | 512 special way with a dictionary. Example: > |
102 | 513 :function Mylen() dict |
114 | 514 : return len(self.data) |
102 | 515 :endfunction |
114 | 516 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
517 :echo mydict.len() | |
102 | 518 |
519 This is like a method in object oriented programming. The entry in the | |
520 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
521 the function was invoked from. | |
522 | |
114 | 523 It is also possible to add a function without the "dict" attribute as a |
524 Funcref to a Dictionary, but the "self" variable is not available then. | |
525 | |
819 | 526 *numbered-function* *anonymous-function* |
102 | 527 To avoid the extra name for the function it can be defined and directly |
528 assigned to a Dictionary in this way: > | |
114 | 529 :let mydict = {'data': [0, 1, 2, 3]} |
6741 | 530 :function mydict.len() |
114 | 531 : return len(self.data) |
102 | 532 :endfunction |
114 | 533 :echo mydict.len() |
534 | |
535 The function will then get a number and the value of dict.len is a |Funcref| | |
1621 | 536 that references this function. The function can only be used through a |
114 | 537 |Funcref|. It will automatically be deleted when there is no |Funcref| |
538 remaining that refers to it. | |
539 | |
540 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 541 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
542 If you get an error for a numbered function, you can find out what it is with |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
543 a trick. Assuming the function is 42, the command is: > |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
544 :function {42} |
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
545 |
102 | 546 |
547 Functions for Dictionaries ~ | |
114 | 548 *E715* |
549 Functions that can be used with a Dictionary: > | |
102 | 550 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
551 :if empty(dict) " TRUE if dict is empty | |
552 :let l = len(dict) " number of items in dict | |
553 :let big = max(dict) " maximum value in dict | |
554 :let small = min(dict) " minimum value in dict | |
555 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
556 :let s = string(dict) " String representation of dict | |
557 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
99 | 558 |
559 | |
560 1.5 More about variables ~ | |
85 | 561 *more-variables* |
7 | 562 If you need to know the type of a variable or expression, use the |type()| |
563 function. | |
564 | |
565 When the '!' flag is included in the 'viminfo' option, global variables that | |
566 start with an uppercase letter, and don't contain a lowercase letter, are | |
567 stored in the viminfo file |viminfo-file|. | |
568 | |
569 When the 'sessionoptions' option contains "global", global variables that | |
570 start with an uppercase letter and contain at least one lowercase letter are | |
571 stored in the session file |session-file|. | |
572 | |
573 variable name can be stored where ~ | |
574 my_var_6 not | |
575 My_Var_6 session file | |
576 MY_VAR_6 viminfo file | |
577 | |
578 | |
579 It's possible to form a variable name with curly braces, see | |
580 |curly-braces-names|. | |
581 | |
582 ============================================================================== | |
583 2. Expression syntax *expression-syntax* | |
584 | |
585 Expression syntax summary, from least to most significant: | |
586 | |
587 |expr1| expr2 ? expr1 : expr1 if-then-else | |
588 | |
589 |expr2| expr3 || expr3 .. logical OR | |
590 | |
591 |expr3| expr4 && expr4 .. logical AND | |
592 | |
593 |expr4| expr5 == expr5 equal | |
594 expr5 != expr5 not equal | |
595 expr5 > expr5 greater than | |
596 expr5 >= expr5 greater than or equal | |
597 expr5 < expr5 smaller than | |
598 expr5 <= expr5 smaller than or equal | |
599 expr5 =~ expr5 regexp matches | |
600 expr5 !~ expr5 regexp doesn't match | |
601 | |
602 expr5 ==? expr5 equal, ignoring case | |
603 expr5 ==# expr5 equal, match case | |
604 etc. As above, append ? for ignoring case, # for | |
605 matching case | |
606 | |
685 | 607 expr5 is expr5 same |List| instance |
608 expr5 isnot expr5 different |List| instance | |
79 | 609 |
610 |expr5| expr6 + expr6 .. number addition or list concatenation | |
7 | 611 expr6 - expr6 .. number subtraction |
612 expr6 . expr6 .. string concatenation | |
613 | |
614 |expr6| expr7 * expr7 .. number multiplication | |
615 expr7 / expr7 .. number division | |
616 expr7 % expr7 .. number modulo | |
617 | |
618 |expr7| ! expr7 logical NOT | |
619 - expr7 unary minus | |
620 + expr7 unary plus | |
102 | 621 |
685 | 622 |expr8| expr8[expr1] byte of a String or item of a |List| |
623 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
624 expr8.name entry in a |Dictionary| | |
625 expr8(expr1, ...) function call with |Funcref| variable | |
102 | 626 |
627 |expr9| number number constant | |
26 | 628 "string" string constant, backslash is special |
99 | 629 'string' string constant, ' is doubled |
685 | 630 [expr1, ...] |List| |
631 {expr1: expr1, ...} |Dictionary| | |
7 | 632 &option option value |
633 (expr1) nested expression | |
634 variable internal variable | |
635 va{ria}ble internal variable with curly braces | |
636 $VAR environment variable | |
637 @r contents of register 'r' | |
638 function(expr1, ...) function call | |
639 func{ti}on(expr1, ...) function call with curly braces | |
640 | |
641 | |
642 ".." indicates that the operations in this level can be concatenated. | |
643 Example: > | |
644 &nu || &list && &shell == "csh" | |
645 | |
646 All expressions within one level are parsed from left to right. | |
647 | |
648 | |
649 expr1 *expr1* *E109* | |
650 ----- | |
651 | |
652 expr2 ? expr1 : expr1 | |
653 | |
654 The expression before the '?' is evaluated to a number. If it evaluates to | |
655 non-zero, the result is the value of the expression between the '?' and ':', | |
656 otherwise the result is the value of the expression after the ':'. | |
657 Example: > | |
658 :echo lnum == 1 ? "top" : lnum | |
659 | |
660 Since the first expression is an "expr2", it cannot contain another ?:. The | |
661 other two expressions can, thus allow for recursive use of ?:. | |
662 Example: > | |
663 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
664 | |
665 To keep this readable, using |line-continuation| is suggested: > | |
666 :echo lnum == 1 | |
667 :\ ? "top" | |
668 :\ : lnum == 1000 | |
669 :\ ? "last" | |
670 :\ : lnum | |
671 | |
1156 | 672 You should always put a space before the ':', otherwise it can be mistaken for |
673 use in a variable such as "a:1". | |
674 | |
7 | 675 |
676 expr2 and expr3 *expr2* *expr3* | |
677 --------------- | |
678 | |
679 *expr-barbar* *expr-&&* | |
680 The "||" and "&&" operators take one argument on each side. The arguments | |
681 are (converted to) Numbers. The result is: | |
682 | |
683 input output ~ | |
684 n1 n2 n1 || n2 n1 && n2 ~ | |
685 zero zero zero zero | |
686 zero non-zero non-zero zero | |
687 non-zero zero non-zero zero | |
688 non-zero non-zero non-zero non-zero | |
689 | |
690 The operators can be concatenated, for example: > | |
691 | |
692 &nu || &list && &shell == "csh" | |
693 | |
694 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
695 | |
696 &nu || (&list && &shell == "csh") | |
697 | |
698 Once the result is known, the expression "short-circuits", that is, further | |
699 arguments are not evaluated. This is like what happens in C. For example: > | |
700 | |
701 let a = 1 | |
702 echo a || b | |
703 | |
704 This is valid even if there is no variable called "b" because "a" is non-zero, | |
705 so the result must be non-zero. Similarly below: > | |
706 | |
707 echo exists("b") && b == "yes" | |
708 | |
709 This is valid whether "b" has been defined or not. The second clause will | |
710 only be evaluated if "b" has been defined. | |
711 | |
712 | |
713 expr4 *expr4* | |
714 ----- | |
715 | |
716 expr5 {cmp} expr5 | |
717 | |
718 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
719 if it evaluates to true. | |
720 | |
1621 | 721 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 722 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
723 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
724 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
725 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
726 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 727 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
728 *expr-is?* *expr-isnot?* | |
7 | 729 use 'ignorecase' match case ignore case ~ |
730 equal == ==# ==? | |
731 not equal != !=# !=? | |
732 greater than > ># >? | |
733 greater than or equal >= >=# >=? | |
734 smaller than < <# <? | |
735 smaller than or equal <= <=# <=? | |
736 regexp matches =~ =~# =~? | |
737 regexp doesn't match !~ !~# !~? | |
2908 | 738 same instance is is# is? |
739 different instance isnot isnot# isnot? | |
7 | 740 |
741 Examples: | |
742 "abc" ==# "Abc" evaluates to 0 | |
743 "abc" ==? "Abc" evaluates to 1 | |
744 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
745 | |
85 | 746 *E691* *E692* |
685 | 747 A |List| can only be compared with a |List| and only "equal", "not equal" and |
748 "is" can be used. This compares the values of the list, recursively. | |
749 Ignoring case means case is ignored when comparing item values. | |
79 | 750 |
114 | 751 *E735* *E736* |
685 | 752 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
753 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
114 | 754 recursively. Ignoring case means case is ignored when comparing item values. |
755 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
756 *E694* |
685 | 757 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
|
758 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
|
759 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
|
760 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
|
761 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
|
762 values use string(): > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
763 echo string(Partial1) == string(Partial2) |
685 | 764 |
2908 | 765 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
766 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
767 of a |List| is different from the original |List|. When using "is" without | |
768 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
769 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
|
770 values are different: > |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
771 echo 4 == '4' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
772 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
773 echo 4 is '4' |
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 echo 0 is [] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
776 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
777 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
79 | 778 |
7 | 779 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
|
780 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
|
781 echo 0 == 'x' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
782 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
783 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
|
784 echo [0] == ['x'] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
785 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
786 Inside a List or Dictionary this conversion is not used. |
7 | 787 |
788 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
789 results in the mathematical difference (comparing byte values), not | |
790 necessarily the alphabetical difference in the local language. | |
791 | |
1621 | 792 When using the operators with a trailing '#', or the short version and |
1156 | 793 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 794 |
795 When using the operators with a trailing '?', or the short version and | |
1156 | 796 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
797 | |
798 'smartcase' is not used. | |
7 | 799 |
800 The "=~" and "!~" operators match the lefthand argument with the righthand | |
801 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
802 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
803 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
804 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
805 single-quote string, see |literal-string|. | |
806 Since a string is considered to be a single line, a multi-line pattern | |
807 (containing \n, backslash-n) will not match. However, a literal NL character | |
808 can be matched like an ordinary character. Examples: | |
809 "foo\nbar" =~ "\n" evaluates to 1 | |
810 "foo\nbar" =~ "\\n" evaluates to 0 | |
811 | |
812 | |
813 expr5 and expr6 *expr5* *expr6* | |
814 --------------- | |
685 | 815 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
79 | 816 expr6 - expr6 .. Number subtraction *expr--* |
817 expr6 . expr6 .. String concatenation *expr-.* | |
818 | |
692 | 819 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 820 result is a new list with the two lists Concatenated. |
79 | 821 |
3214 | 822 expr7 * expr7 .. Number multiplication *expr-star* |
823 expr7 / expr7 .. Number division *expr-/* | |
824 expr7 % expr7 .. Number modulo *expr-%* | |
7 | 825 |
826 For all, except ".", Strings are converted to Numbers. | |
3214 | 827 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 828 |
829 Note the difference between "+" and ".": | |
830 "123" + "456" = 579 | |
831 "123" . "456" = "123456" | |
832 | |
1621 | 833 Since '.' has the same precedence as '+' and '-', you need to read: > |
834 1 . 90 + 90.0 | |
835 As: > | |
836 (1 . 90) + 90.0 | |
837 That works, since the String "190" is automatically converted to the Number | |
838 190, which can be added to the Float 90.0. However: > | |
839 1 . 90 * 90.0 | |
840 Should be read as: > | |
841 1 . (90 * 90.0) | |
842 Since '.' has lower precedence than '*'. This does NOT work, since this | |
843 attempts to concatenate a Float and a String. | |
844 | |
845 When dividing a Number by zero the result depends on the value: | |
846 0 / 0 = -0x80000000 (like NaN for Float) | |
847 >0 / 0 = 0x7fffffff (like positive infinity) | |
848 <0 / 0 = -0x7fffffff (like negative infinity) | |
849 (before Vim 7.2 it was always 0x7fffffff) | |
850 | |
7 | 851 When the righthand side of '%' is zero, the result is 0. |
852 | |
685 | 853 None of these work for |Funcref|s. |
79 | 854 |
1621 | 855 . and % do not work for Float. *E804* |
856 | |
7 | 857 |
858 expr7 *expr7* | |
859 ----- | |
860 ! expr7 logical NOT *expr-!* | |
861 - expr7 unary minus *expr-unary--* | |
862 + expr7 unary plus *expr-unary-+* | |
863 | |
864 For '!' non-zero becomes zero, zero becomes one. | |
865 For '-' the sign of the number is changed. | |
866 For '+' the number is unchanged. | |
867 | |
868 A String will be converted to a Number first. | |
869 | |
1621 | 870 These three can be repeated and mixed. Examples: |
7 | 871 !-1 == 0 |
872 !!8 == 1 | |
873 --9 == 9 | |
874 | |
875 | |
876 expr8 *expr8* | |
877 ----- | |
685 | 878 expr8[expr1] item of String or |List| *expr-[]* *E111* |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
879 *E909* *subscript* |
102 | 880 If expr8 is a Number or String this results in a String that contains the |
881 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
|
882 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
883 an alternative, or use `split()` to turn the string into a list of characters. |
55 | 884 |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
885 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
|
886 text column numbers start with one! Example, to get the byte under the |
55 | 887 cursor: > |
823 | 888 :let c = getline(".")[col(".") - 1] |
7 | 889 |
890 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
|
891 String. A negative index always results in an empty string (reason: backward |
55 | 892 compatibility). Use [-1:] to get the last byte. |
893 | |
685 | 894 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
55 | 895 for possible index values. If the index is out of range this results in an |
1621 | 896 error. Example: > |
55 | 897 :let item = mylist[-1] " get last item |
898 | |
685 | 899 Generally, if a |List| index is equal to or higher than the length of the |
900 |List|, or more negative than the length of the |List|, this results in an | |
901 error. | |
55 | 902 |
99 | 903 |
102 | 904 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
905 | |
906 If expr8 is a Number or String this results in the substring with the bytes | |
907 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
|
908 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
|
909 |byteidx()| for computing the indexes. |
55 | 910 |
911 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
912 string minus one is used. | |
913 | |
914 A negative number can be used to measure from the end of the string. -1 is | |
915 the last character, -2 the last but one, etc. | |
916 | |
917 If an index goes out of range for the string characters are omitted. If | |
918 expr1b is smaller than expr1a the result is an empty string. | |
919 | |
920 Examples: > | |
921 :let c = name[-1:] " last byte of a string | |
922 :let c = name[-2:-2] " last but one byte of a string | |
923 :let s = line(".")[4:] " from the fifth byte to the end | |
924 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
925 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
926 *sublist* *slice* |
685 | 927 If expr8 is a |List| this results in a new |List| with the items indicated by |
1621 | 928 the indexes expr1a and expr1b. This works like with a String, as explained |
685 | 929 just above, except that indexes out of range cause an error. Examples: > |
55 | 930 :let l = mylist[:3] " first four items |
931 :let l = mylist[4:4] " List with one item | |
932 :let l = mylist[:] " shallow copy of a List | |
933 | |
685 | 934 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
935 error. | |
936 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
937 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
|
938 for a sublist: > |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
939 mylist[n:] " uses variable n |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
940 mylist[s:] " uses namespace s:, error! |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
941 |
685 | 942 |
943 expr8.name entry in a |Dictionary| *expr-entry* | |
944 | |
945 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
946 name will be used as a key in the |Dictionary|. This is just like: | |
947 expr8[name]. | |
99 | 948 |
949 The name must consist of alphanumeric characters, just like a variable name, | |
950 but it may start with a number. Curly braces cannot be used. | |
951 | |
952 There must not be white space before or after the dot. | |
953 | |
954 Examples: > | |
955 :let dict = {"one": 1, 2: "two"} | |
956 :echo dict.one | |
957 :echo dict .2 | |
958 | |
959 Note that the dot is also used for String concatenation. To avoid confusion | |
960 always put spaces around the dot for String concatenation. | |
961 | |
962 | |
685 | 963 expr8(expr1, ...) |Funcref| function call |
102 | 964 |
965 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
966 | |
967 | |
968 | |
969 *expr9* | |
7 | 970 number |
971 ------ | |
3224 | 972 number number constant *expr-number* |
973 *hex-number* *octal-number* | |
7 | 974 |
975 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
976 | |
1621 | 977 *floating-point-format* |
978 Floating point numbers can be written in two forms: | |
979 | |
980 [-+]{N}.{M} | |
6530 | 981 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 982 |
983 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
984 contain digits. | |
985 [-+] means there is an optional plus or minus sign. | |
986 {exp} is the exponent, power of 10. | |
987 Only a decimal point is accepted, not a comma. No matter what the current | |
988 locale is. | |
989 {only when compiled with the |+float| feature} | |
990 | |
991 Examples: | |
992 123.456 | |
993 +0.0001 | |
994 55.0 | |
995 -0.123 | |
996 1.234e03 | |
997 1.0E-6 | |
998 -3.1416e+88 | |
999 | |
1000 These are INVALID: | |
1001 3. empty {M} | |
1002 1e40 missing .{M} | |
1003 | |
1698 | 1004 *float-pi* *float-e* |
1005 A few useful values to copy&paste: > | |
1006 :let pi = 3.14159265359 | |
1007 :let e = 2.71828182846 | |
1008 | |
1621 | 1009 Rationale: |
1010 Before floating point was introduced, the text "123.456" was interpreted as | |
1011 the two numbers "123" and "456", both converted to a string and concatenated, | |
1012 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 1013 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 1014 incompatibility was accepted in favor of being able to use the normal notation |
1015 for floating point numbers. | |
1016 | |
1017 *floating-point-precision* | |
1018 The precision and range of floating points numbers depends on what "double" | |
1019 means in the library Vim was compiled with. There is no way to change this at | |
1020 runtime. | |
1021 | |
1022 The default for displaying a |Float| is to use 6 decimal places, like using | |
1023 printf("%g", f). You can select something else when using the |printf()| | |
1024 function. Example: > | |
1025 :echo printf('%.15e', atan(1)) | |
1026 < 7.853981633974483e-01 | |
1027 | |
1028 | |
7 | 1029 |
6884 | 1030 string *string* *String* *expr-string* *E114* |
7 | 1031 ------ |
1032 "string" string constant *expr-quote* | |
1033 | |
1034 Note that double quotes are used. | |
1035 | |
1036 A string constant accepts these special characters: | |
1037 \... three-digit octal number (e.g., "\316") | |
1038 \.. two-digit octal number (must be followed by non-digit) | |
1039 \. one-digit octal number (must be followed by non-digit) | |
1040 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1041 \x. byte specified with one hex number (must be followed by non-hex char) | |
1042 \X.. same as \x.. | |
1043 \X. same as \x. | |
1621 | 1044 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1045 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1046 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1047 \b backspace <BS> |
1048 \e escape <Esc> | |
1049 \f formfeed <FF> | |
1050 \n newline <NL> | |
1051 \r return <CR> | |
1052 \t tab <Tab> | |
1053 \\ backslash | |
1054 \" double quote | |
2152 | 1055 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
1056 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
1057 utf-8 character, use \uxxxx as mentioned above. | |
7 | 1058 |
1156 | 1059 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1060 encodings. Use "\u00ff" to store character 255 according to the current value | |
1061 of 'encoding'. | |
1062 | |
7 | 1063 Note that "\000" and "\x00" force the end of the string. |
1064 | |
1065 | |
1066 literal-string *literal-string* *E115* | |
1067 --------------- | |
26 | 1068 'string' string constant *expr-'* |
7 | 1069 |
1070 Note that single quotes are used. | |
1071 | |
1621 | 1072 This string is taken as it is. No backslashes are removed or have a special |
99 | 1073 meaning. The only exception is that two quotes stand for one quote. |
26 | 1074 |
1075 Single quoted strings are useful for patterns, so that backslashes do not need | |
1621 | 1076 to be doubled. These two commands are equivalent: > |
26 | 1077 if a =~ "\\s*" |
1078 if a =~ '\s*' | |
7 | 1079 |
1080 | |
1081 option *expr-option* *E112* *E113* | |
1082 ------ | |
1083 &option option value, local value if possible | |
1084 &g:option global option value | |
1085 &l:option local option value | |
1086 | |
1087 Examples: > | |
1088 echo "tabstop is " . &tabstop | |
1089 if &insertmode | |
1090 | |
1091 Any option name can be used here. See |options|. When using the local value | |
1092 and there is no buffer-local or window-local value, the global value is used | |
1093 anyway. | |
1094 | |
1095 | |
1156 | 1096 register *expr-register* *@r* |
7 | 1097 -------- |
1098 @r contents of register 'r' | |
1099 | |
1100 The result is the contents of the named register, as a single string. | |
1101 Newlines are inserted where required. To get the contents of the unnamed | |
1621 | 1102 register use @" or @@. See |registers| for an explanation of the available |
336 | 1103 registers. |
1104 | |
1105 When using the '=' register you get the expression itself, not what it | |
1106 evaluates to. Use |eval()| to evaluate it. | |
7 | 1107 |
1108 | |
1109 nesting *expr-nesting* *E110* | |
1110 ------- | |
1111 (expr1) nested expression | |
1112 | |
1113 | |
1114 environment variable *expr-env* | |
1115 -------------------- | |
1116 $VAR environment variable | |
1117 | |
1118 The String value of any environment variable. When it is not defined, the | |
1119 result is an empty string. | |
1120 *expr-env-expand* | |
1121 Note that there is a difference between using $VAR directly and using | |
1122 expand("$VAR"). Using it directly will only expand environment variables that | |
1123 are known inside the current Vim session. Using expand() will first try using | |
1124 the environment variables known inside the current Vim session. If that | |
1125 fails, a shell will be used to expand the variable. This can be slow, but it | |
1126 does expand all variables that the shell knows about. Example: > | |
6180 | 1127 :echo $shell |
1128 :echo expand("$shell") | |
1129 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1130 variable (if your shell supports it). |
1131 | |
1132 | |
1133 internal variable *expr-variable* | |
1134 ----------------- | |
1135 variable internal variable | |
1136 See below |internal-variables|. | |
1137 | |
1138 | |
170 | 1139 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1140 ------------- |
1141 function(expr1, ...) function call | |
1142 See below |functions|. | |
1143 | |
1144 | |
1145 ============================================================================== | |
2596 | 1146 3. Internal variable *internal-variables* *E461* |
1147 | |
7 | 1148 An internal variable name can be made up of letters, digits and '_'. But it |
1149 cannot start with a digit. It's also possible to use curly braces, see | |
1150 |curly-braces-names|. | |
1151 | |
1152 An internal variable is created with the ":let" command |:let|. | |
87 | 1153 An internal variable is explicitly destroyed with the ":unlet" command |
1154 |:unlet|. | |
1155 Using a name that is not an internal variable or refers to a variable that has | |
1156 been destroyed results in an error. | |
7 | 1157 |
1158 There are several name spaces for variables. Which one is to be used is | |
1159 specified by what is prepended: | |
1160 | |
1161 (nothing) In a function: local to a function; otherwise: global | |
1162 |buffer-variable| b: Local to the current buffer. | |
1163 |window-variable| w: Local to the current window. | |
819 | 1164 |tabpage-variable| t: Local to the current tab page. |
7 | 1165 |global-variable| g: Global. |
1166 |local-variable| l: Local to a function. | |
1167 |script-variable| s: Local to a |:source|'ed Vim script. | |
1168 |function-argument| a: Function argument (only inside a function). | |
5815 | 1169 |vim-variable| v: Global, predefined by Vim. |
7 | 1170 |
685 | 1171 The scope name by itself can be used as a |Dictionary|. For example, to |
1172 delete all script-local variables: > | |
133 | 1173 :for k in keys(s:) |
1174 : unlet s:[k] | |
1175 :endfor | |
1176 < | |
4358 | 1177 *buffer-variable* *b:var* *b:* |
7 | 1178 A variable name that is preceded with "b:" is local to the current buffer. |
1179 Thus you can have several "b:foo" variables, one for each buffer. | |
1180 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1181 |:bdelete|. | |
1182 | |
1183 One local buffer variable is predefined: | |
4264 | 1184 *b:changedtick* *changetick* |
7 | 1185 b:changedtick The total number of changes to the current buffer. It is |
1186 incremented for each change. An undo command is also a change | |
1187 in this case. This can be used to perform an action only when | |
1188 the buffer has changed. Example: > | |
1189 :if my_changedtick != b:changedtick | |
1621 | 1190 : let my_changedtick = b:changedtick |
1191 : call My_Update() | |
7 | 1192 :endif |
1193 < | |
4358 | 1194 *window-variable* *w:var* *w:* |
7 | 1195 A variable name that is preceded with "w:" is local to the current window. It |
1196 is deleted when the window is closed. | |
1197 | |
4437 | 1198 *tabpage-variable* *t:var* *t:* |
819 | 1199 A variable name that is preceded with "t:" is local to the current tab page, |
1200 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
|
1201 without the |+windows| feature} |
819 | 1202 |
4358 | 1203 *global-variable* *g:var* *g:* |
7 | 1204 Inside functions global variables are accessed with "g:". Omitting this will |
1621 | 1205 access a variable local to a function. But "g:" can also be used in any other |
7 | 1206 place if you like. |
1207 | |
4358 | 1208 *local-variable* *l:var* *l:* |
7 | 1209 Inside functions local variables are accessed without prepending anything. |
1156 | 1210 But you can also prepend "l:" if you like. However, without prepending "l:" |
1211 you may run into reserved variable names. For example "count". By itself it | |
1212 refers to "v:count". Using "l:count" you can have a local variable with the | |
1213 same name. | |
7 | 1214 |
1215 *script-variable* *s:var* | |
1216 In a Vim script variables starting with "s:" can be used. They cannot be | |
1217 accessed from outside of the scripts, thus are local to the script. | |
1218 | |
1219 They can be used in: | |
1220 - commands executed while the script is sourced | |
1221 - functions defined in the script | |
1222 - autocommands defined in the script | |
1223 - functions and autocommands defined in functions and autocommands which were | |
1224 defined in the script (recursively) | |
1225 - user defined commands defined in the script | |
1226 Thus not in: | |
1227 - other scripts sourced from this one | |
1228 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1229 - menus |
7 | 1230 - etc. |
1231 | |
1156 | 1232 Script variables can be used to avoid conflicts with global variable names. |
1233 Take this example: > | |
7 | 1234 |
1235 let s:counter = 0 | |
1236 function MyCounter() | |
1237 let s:counter = s:counter + 1 | |
1238 echo s:counter | |
1239 endfunction | |
1240 command Tick call MyCounter() | |
1241 | |
1242 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1243 that script will not be changed, only the "s:counter" in the script where | |
1244 "Tick" was defined is used. | |
1245 | |
1246 Another example that does the same: > | |
1247 | |
1248 let s:counter = 0 | |
1249 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1250 | |
1251 When calling a function and invoking a user-defined command, the context for | |
9 | 1252 script variables is set to the script where the function or command was |
7 | 1253 defined. |
1254 | |
1255 The script variables are also available when a function is defined inside a | |
1256 function that is defined in a script. Example: > | |
1257 | |
1258 let s:counter = 0 | |
1259 function StartCounting(incr) | |
1260 if a:incr | |
1261 function MyCounter() | |
1262 let s:counter = s:counter + 1 | |
1263 endfunction | |
1264 else | |
1265 function MyCounter() | |
1266 let s:counter = s:counter - 1 | |
1267 endfunction | |
1268 endif | |
1269 endfunction | |
1270 | |
1271 This defines the MyCounter() function either for counting up or counting down | |
1272 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1273 called, the s:counter variable will be accessible in MyCounter(). | |
1274 | |
1275 When the same script is sourced again it will use the same script variables. | |
1276 They will remain valid as long as Vim is running. This can be used to | |
1277 maintain a counter: > | |
1278 | |
1279 if !exists("s:counter") | |
1280 let s:counter = 1 | |
1281 echo "script executed for the first time" | |
1282 else | |
1283 let s:counter = s:counter + 1 | |
1284 echo "script executed " . s:counter . " times now" | |
1285 endif | |
1286 | |
1287 Note that this means that filetype plugins don't get a different set of script | |
1288 variables for each buffer. Use local buffer variables instead |b:var|. | |
1289 | |
1290 | |
4358 | 1291 Predefined Vim variables: *vim-variable* *v:var* *v:* |
7 | 1292 |
189 | 1293 *v:beval_col* *beval_col-variable* |
1294 v:beval_col The number of the column, over which the mouse pointer is. | |
1295 This is the byte index in the |v:beval_lnum| line. | |
1296 Only valid while evaluating the 'balloonexpr' option. | |
1297 | |
1298 *v:beval_bufnr* *beval_bufnr-variable* | |
1299 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1300 valid while evaluating the 'balloonexpr' option. | |
1301 | |
1302 *v:beval_lnum* *beval_lnum-variable* | |
1303 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1304 valid while evaluating the 'balloonexpr' option. | |
1305 | |
1306 *v:beval_text* *beval_text-variable* | |
374 | 1307 v:beval_text The text under or after the mouse pointer. Usually a word as |
1308 it is useful for debugging a C program. 'iskeyword' applies, | |
1309 but a dot and "->" before the position is included. When on a | |
1310 ']' the text before it is used, including the matching '[' and | |
189 | 1311 word before it. When on a Visual area within one line the |
1312 highlighted text is used. | |
1313 Only valid while evaluating the 'balloonexpr' option. | |
1314 | |
1315 *v:beval_winnr* *beval_winnr-variable* | |
1316 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1317 valid while evaluating the 'balloonexpr' option. The first |
1318 window has number zero (unlike most other places where a | |
1319 window gets a number). | |
189 | 1320 |
844 | 1321 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1322 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
|
1323 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
|
1324 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1325 |
7 | 1326 *v:charconvert_from* *charconvert_from-variable* |
1327 v:charconvert_from | |
1328 The name of the character encoding of a file to be converted. | |
1329 Only valid while evaluating the 'charconvert' option. | |
1330 | |
1331 *v:charconvert_to* *charconvert_to-variable* | |
1332 v:charconvert_to | |
1333 The name of the character encoding of a file after conversion. | |
1334 Only valid while evaluating the 'charconvert' option. | |
1335 | |
1336 *v:cmdarg* *cmdarg-variable* | |
1337 v:cmdarg This variable is used for two purposes: | |
1338 1. The extra arguments given to a file read/write command. | |
1339 Currently these are "++enc=" and "++ff=". This variable is | |
1340 set before an autocommand event for a file read/write | |
1341 command is triggered. There is a leading space to make it | |
1342 possible to append this variable directly after the | |
1621 | 1343 read/write command. Note: The "+cmd" argument isn't |
7 | 1344 included here, because it will be executed anyway. |
1345 2. When printing a PostScript file with ":hardcopy" this is | |
1346 the argument for the ":hardcopy" command. This can be used | |
1347 in 'printexpr'. | |
1348 | |
1349 *v:cmdbang* *cmdbang-variable* | |
1350 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1351 was used the value is 1, otherwise it is 0. Note that this | |
1352 can only be used in autocommands. For user commands |<bang>| | |
1353 can be used. | |
1354 | |
6909 | 1355 *v:completed_item* *completed_item-variable* |
1356 v:completed_item | |
1357 |Dictionary| containing the |complete-items| for the most | |
1358 recently completed word after |CompleteDone|. The | |
1359 |Dictionary| is empty if the completion failed. | |
1360 | |
7 | 1361 *v:count* *count-variable* |
1362 v:count The count given for the last Normal mode command. Can be used | |
1621 | 1363 to get the count before a mapping. Read-only. Example: > |
7 | 1364 :map _x :<C-U>echo "the count is " . v:count<CR> |
1365 < Note: The <C-U> is required to remove the line range that you | |
1366 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1367 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1368 just like what happens in the command, "d6w" for the example. |
667 | 1369 Also used for evaluating the 'formatexpr' option. |
7 | 1370 "count" also works, for backwards compatibility. |
1371 | |
1372 *v:count1* *count1-variable* | |
1373 v:count1 Just like "v:count", but defaults to one when no count is | |
1374 used. | |
1375 | |
1376 *v:ctype* *ctype-variable* | |
1377 v:ctype The current locale setting for characters of the runtime | |
1378 environment. This allows Vim scripts to be aware of the | |
1379 current locale encoding. Technical: it's the value of | |
1380 LC_CTYPE. When not using a locale the value is "C". | |
1381 This variable can not be set directly, use the |:language| | |
1382 command. | |
1383 See |multi-lang|. | |
1384 | |
1385 *v:dying* *dying-variable* | |
1621 | 1386 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1387 one. When multiple signals are caught the number increases. |
1388 Can be used in an autocommand to check if Vim didn't | |
1389 terminate normally. {only works on Unix} | |
1390 Example: > | |
1391 :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
|
1392 < 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
|
1393 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
|
1394 |
7 | 1395 *v:errmsg* *errmsg-variable* |
1396 v:errmsg Last given error message. It's allowed to set this variable. | |
1397 Example: > | |
1398 :let v:errmsg = "" | |
1399 :silent! next | |
1400 :if v:errmsg != "" | |
1401 : ... handle error | |
1402 < "errmsg" also works, for backwards compatibility. | |
1403 | |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1404 *v:errors* *errors-variable* |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1405 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
|
1406 This is a list of strings. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1407 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
|
1408 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
|
1409 :let v:errors = [] |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1410 < 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
|
1411 list by the assert function. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1412 |
7 | 1413 *v:exception* *exception-variable* |
1414 v:exception The value of the exception most recently caught and not | |
1415 finished. See also |v:throwpoint| and |throw-variables|. | |
1416 Example: > | |
1417 :try | |
1418 : throw "oops" | |
1419 :catch /.*/ | |
1420 : echo "caught" v:exception | |
1421 :endtry | |
1422 < Output: "caught oops". | |
1423 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1424 *v:false* *false-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1425 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
|
1426 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1427 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
|
1428 echo v:false |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1429 < false ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1430 |
179 | 1431 *v:fcs_reason* *fcs_reason-variable* |
1432 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
1433 Can be used in an autocommand to decide what to do and/or what | |
1434 to set v:fcs_choice to. Possible values: | |
1435 deleted file no longer exists | |
1436 conflict file contents, mode or timestamp was | |
1437 changed and buffer is modified | |
1438 changed file contents has changed | |
1439 mode mode of file changed | |
1440 time only file timestamp changed | |
1441 | |
1442 *v:fcs_choice* *fcs_choice-variable* | |
1443 v:fcs_choice What should happen after a |FileChangedShell| event was | |
1444 triggered. Can be used in an autocommand to tell Vim what to | |
1445 do with the affected buffer: | |
1446 reload Reload the buffer (does not work if | |
1447 the file was deleted). | |
1448 ask Ask the user what to do, as if there | |
1449 was no autocommand. Except that when | |
1450 only the timestamp changed nothing | |
1451 will happen. | |
1452 <empty> Nothing, the autocommand should do | |
1453 everything that needs to be done. | |
1454 The default is empty. If another (invalid) value is used then | |
1455 Vim behaves like it is empty, there is no warning message. | |
1456 | |
7 | 1457 *v:fname_in* *fname_in-variable* |
579 | 1458 v:fname_in The name of the input file. Valid while evaluating: |
7 | 1459 option used for ~ |
1460 'charconvert' file to be converted | |
1461 'diffexpr' original file | |
1462 'patchexpr' original file | |
1463 'printexpr' file to be printed | |
593 | 1464 And set to the swap file name for |SwapExists|. |
7 | 1465 |
1466 *v:fname_out* *fname_out-variable* | |
1467 v:fname_out The name of the output file. Only valid while | |
1468 evaluating: | |
1469 option used for ~ | |
1470 'charconvert' resulting converted file (*) | |
1471 'diffexpr' output of diff | |
1472 'patchexpr' resulting patched file | |
1473 (*) When doing conversion for a write command (e.g., ":w | |
1621 | 1474 file") it will be equal to v:fname_in. When doing conversion |
7 | 1475 for a read command (e.g., ":e file") it will be a temporary |
1476 file and different from v:fname_in. | |
1477 | |
1478 *v:fname_new* *fname_new-variable* | |
1479 v:fname_new The name of the new version of the file. Only valid while | |
1480 evaluating 'diffexpr'. | |
1481 | |
1482 *v:fname_diff* *fname_diff-variable* | |
1483 v:fname_diff The name of the diff (patch) file. Only valid while | |
1484 evaluating 'patchexpr'. | |
1485 | |
1486 *v:folddashes* *folddashes-variable* | |
1487 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
1488 fold. | |
29 | 1489 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1490 |
1491 *v:foldlevel* *foldlevel-variable* | |
1492 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 1493 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1494 |
1495 *v:foldend* *foldend-variable* | |
1496 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 1497 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1498 |
1499 *v:foldstart* *foldstart-variable* | |
1500 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 1501 Read-only in the |sandbox|. |fold-foldtext| |
7 | 1502 |
5460 | 1503 *v:hlsearch* *hlsearch-variable* |
6413 | 1504 v:hlsearch Variable that indicates whether search highlighting is on. |
1505 Setting it makes sense only if 'hlsearch' is enabled which | |
1506 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
|
1507 like the |:nohlsearch| command, setting it to one acts like > |
5460 | 1508 let &hlsearch = &hlsearch |
6918 | 1509 < Note that the value is restored when returning from a |
1510 function. |function-search-undo|. | |
1511 | |
11 | 1512 *v:insertmode* *insertmode-variable* |
1513 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
1514 events. Values: | |
1515 i Insert mode | |
1516 r Replace mode | |
1517 v Virtual Replace mode | |
1518 | |
102 | 1519 *v:key* *key-variable* |
685 | 1520 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 1521 evaluating the expression used with |map()| and |filter()|. |
1522 Read-only. | |
1523 | |
7 | 1524 *v:lang* *lang-variable* |
1525 v:lang The current locale setting for messages of the runtime | |
1526 environment. This allows Vim scripts to be aware of the | |
1527 current language. Technical: it's the value of LC_MESSAGES. | |
1528 The value is system dependent. | |
1529 This variable can not be set directly, use the |:language| | |
1530 command. | |
1531 It can be different from |v:ctype| when messages are desired | |
1532 in a different language than what is used for character | |
1533 encoding. See |multi-lang|. | |
1534 | |
1535 *v:lc_time* *lc_time-variable* | |
1536 v:lc_time The current locale setting for time messages of the runtime | |
1537 environment. This allows Vim scripts to be aware of the | |
1538 current language. Technical: it's the value of LC_TIME. | |
1539 This variable can not be set directly, use the |:language| | |
1540 command. See |multi-lang|. | |
1541 | |
1542 *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
|
1543 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
|
1544 '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
|
1545 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
|
1546 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
|
1547 |sandbox|. |
7 | 1548 |
1029 | 1549 *v:mouse_win* *mouse_win-variable* |
1550 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
1551 First window has number 1, like with |winnr()|. The value is | |
1552 zero when there was no mouse button click. | |
1553 | |
1554 *v:mouse_lnum* *mouse_lnum-variable* | |
1555 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
1556 This is the text line number, not the screen line number. The | |
1557 value is zero when there was no mouse button click. | |
1558 | |
1559 *v:mouse_col* *mouse_col-variable* | |
1560 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
1561 This is the screen column number, like with |virtcol()|. The | |
1562 value is zero when there was no mouse button click. | |
1563 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1564 *v:none* *none-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1565 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
|
1566 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1567 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
|
1568 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
|
1569 echo v:none |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1570 < none ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1571 |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1572 *v:null* *null-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1573 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
|
1574 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1575 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
|
1576 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
|
1577 echo v:null |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1578 < null ~ |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1579 |
1733 | 1580 *v:oldfiles* *oldfiles-variable* |
1581 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
1582 startup. These are the files that Vim remembers marks for. | |
1583 The length of the List is limited by the ' argument of the | |
1584 'viminfo' option (default is 100). | |
5618 | 1585 When the |viminfo| file is not used the List is empty. |
1733 | 1586 Also see |:oldfiles| and |c_#<|. |
1587 The List can be modified, but this has no effect on what is | |
1588 stored in the |viminfo| file later. If you use values other | |
1589 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
|
1590 {only when compiled with the |+viminfo| feature} |
1733 | 1591 |
6935 | 1592 *v:option_new* |
1593 v:option_new New value of the option. Valid while executing an |OptionSet| | |
1594 autocommand. | |
1595 *v:option_old* | |
1596 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
1597 autocommand. | |
1598 *v:option_type* | |
1599 v:option_type Scope of the set command. Valid while executing an | |
1600 |OptionSet| autocommand. Can be either "global" or "local" | |
1490 | 1601 *v:operator* *operator-variable* |
1602 v:operator The last operator given in Normal mode. This is a single | |
1603 character except for commands starting with <g> or <z>, | |
1604 in which case it is two characters. Best used alongside | |
1605 |v:prevcount| and |v:register|. Useful if you want to cancel | |
1606 Operator-pending mode and then use the operator, e.g.: > | |
1607 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
1608 < The value remains set until another operator is entered, thus | |
1609 don't expect it to be empty. | |
1610 v:operator is not set for |:delete|, |:yank| or other Ex | |
1611 commands. | |
1612 Read-only. | |
1613 | |
7 | 1614 *v:prevcount* *prevcount-variable* |
1615 v:prevcount The count given for the last but one Normal mode command. | |
1616 This is the v:count value of the previous command. Useful if | |
1490 | 1617 you want to cancel Visual or Operator-pending mode and then |
1618 use the count, e.g.: > | |
7 | 1619 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
1620 < Read-only. | |
1621 | |
170 | 1622 *v:profiling* *profiling-variable* |
1621 | 1623 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 1624 See |profiling|. |
1625 | |
7 | 1626 *v:progname* *progname-variable* |
1627 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 1628 invoked. Allows you to do special initialisations for |view|, |
1629 |evim| etc., or any other name you might symlink to Vim. | |
7 | 1630 Read-only. |
1631 | |
5780 | 1632 *v:progpath* *progpath-variable* |
1633 v:progpath Contains the command with which Vim was invoked, including the | |
1634 path. Useful if you want to message a Vim server using a | |
1635 |--remote-expr|. | |
5782 | 1636 To get the full path use: > |
1637 echo exepath(v:progpath) | |
1638 < NOTE: This does not work when the command is a relative path | |
1639 and the current directory has changed. | |
5780 | 1640 Read-only. |
1641 | |
7 | 1642 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1643 v:register The name of the register in effect for the current normal mode |
3492 | 1644 command (regardless of whether that command actually used a |
1645 register). Or for the currently executing normal mode mapping | |
1646 (use this in custom commands that take a register). | |
1647 If none is supplied it is the default register '"', unless | |
1648 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
1649 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1650 Also see |getreg()| and |setreg()| |
7 | 1651 |
540 | 1652 *v:scrollstart* *scrollstart-variable* |
1653 v:scrollstart String describing the script or function that caused the | |
1654 screen to scroll up. It's only set when it is empty, thus the | |
1655 first reason is remembered. It is set to "Unknown" for a | |
1656 typed command. | |
1657 This can be used to find out why your script causes the | |
1658 hit-enter prompt. | |
1659 | |
7 | 1660 *v:servername* *servername-variable* |
1661 v:servername The resulting registered |x11-clientserver| name if any. | |
1662 Read-only. | |
1663 | |
1621 | 1664 |
1665 v:searchforward *v:searchforward* *searchforward-variable* | |
1666 Search direction: 1 after a forward search, 0 after a | |
1667 backward search. It is reset to forward when directly setting | |
1668 the last search pattern, see |quote/|. | |
1669 Note that the value is restored when returning from a | |
1670 function. |function-search-undo|. | |
1671 Read-write. | |
1672 | |
7 | 1673 *v:shell_error* *shell_error-variable* |
1674 v:shell_error Result of the last shell command. When non-zero, the last | |
1675 shell command had an error. When zero, there was no problem. | |
1676 This only works when the shell returns the error code to Vim. | |
1677 The value -1 is often used when the command could not be | |
1678 executed. Read-only. | |
1679 Example: > | |
1680 :!mv foo bar | |
1681 :if v:shell_error | |
1682 : echo 'could not rename "foo" to "bar"!' | |
1683 :endif | |
1684 < "shell_error" also works, for backwards compatibility. | |
1685 | |
1686 *v:statusmsg* *statusmsg-variable* | |
1687 v:statusmsg Last given status message. It's allowed to set this variable. | |
1688 | |
579 | 1689 *v:swapname* *swapname-variable* |
1690 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
1691 the swap file found. Read-only. | |
1692 | |
1693 *v:swapchoice* *swapchoice-variable* | |
1694 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
1695 for handling an existing swap file: | |
1696 'o' Open read-only | |
1697 'e' Edit anyway | |
1698 'r' Recover | |
1699 'd' Delete swapfile | |
1700 'q' Quit | |
1701 'a' Abort | |
1621 | 1702 The value should be a single-character string. An empty value |
579 | 1703 results in the user being asked, as would happen when there is |
1704 no SwapExists autocommand. The default is empty. | |
1705 | |
590 | 1706 *v:swapcommand* *swapcommand-variable* |
625 | 1707 v:swapcommand Normal mode command to be executed after a file has been |
590 | 1708 opened. Can be used for a |SwapExists| autocommand to have |
1621 | 1709 another Vim open the file and jump to the right place. For |
590 | 1710 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 1711 For ":edit +cmd file" the value is ":cmd\r". |
590 | 1712 |
7 | 1713 *v:termresponse* *termresponse-variable* |
1714 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
1621 | 1715 termcap entry. It is set when Vim receives an escape sequence |
7 | 1716 that starts with ESC [ or CSI and ends in a 'c', with only |
1717 digits, ';' and '.' in between. | |
1718 When this option is set, the TermResponse autocommand event is | |
1719 fired, so that you can react to the response from the | |
1720 terminal. | |
1721 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
1722 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
1723 patch level (since this was introduced in patch 95, it's | |
1724 always 95 or bigger). Pc is always zero. | |
1725 {only when compiled with |+termresponse| feature} | |
1726 | |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1727 *v:testing* *testing-variable* |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1728 v:testing Must be set before using `garbagecollect_for_testing()`. |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1729 |
7 | 1730 *v:this_session* *this_session-variable* |
1731 v:this_session Full filename of the last loaded or saved session file. See | |
1732 |:mksession|. It is allowed to set this variable. When no | |
1733 session file has been saved, this variable is empty. | |
1734 "this_session" also works, for backwards compatibility. | |
1735 | |
1736 *v:throwpoint* *throwpoint-variable* | |
1737 v:throwpoint The point where the exception most recently caught and not | |
1621 | 1738 finished was thrown. Not set when commands are typed. See |
7 | 1739 also |v:exception| and |throw-variables|. |
1740 Example: > | |
1741 :try | |
1742 : throw "oops" | |
1743 :catch /.*/ | |
1744 : echo "Exception from" v:throwpoint | |
1745 :endtry | |
1746 < Output: "Exception from test.vim, line 2" | |
1747 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1748 *v:true* *true-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1749 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
|
1750 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1751 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
|
1752 echo v:true |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1753 < true ~ |
102 | 1754 *v:val* *val-variable* |
1621 | 1755 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 1756 valid while evaluating the expression used with |map()| and |
102 | 1757 |filter()|. Read-only. |
1758 | |
7 | 1759 *v:version* *version-variable* |
1760 v:version Version number of Vim: Major version number times 100 plus | |
1761 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
1762 is 501. Read-only. "version" also works, for backwards | |
1763 compatibility. | |
1764 Use |has()| to check if a certain patch was included, e.g.: > | |
5786 | 1765 if has("patch-7.4.123") |
7 | 1766 < Note that patch numbers are specific to the version, thus both |
1767 version 5.0 and 5.1 may have a patch 123, but these are | |
1768 completely different. | |
1769 | |
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1770 *v:vim_did_enter* *vim_did_enter-variable* |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1771 v:vim_did_enter Zero until most of startup is done. It is set to one just |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1772 before |VimEnter| autocommands are triggered. |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1773 |
7 | 1774 *v:warningmsg* *warningmsg-variable* |
1775 v:warningmsg Last given warning message. It's allowed to set this variable. | |
1776 | |
2609 | 1777 *v:windowid* *windowid-variable* |
1778 v:windowid When any X11 based GUI is running or when running in a | |
1779 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 1780 set to the window ID. |
1781 When an MS-Windows GUI is running this will be set to the | |
1782 window handle. | |
1783 Otherwise the value is zero. | |
1784 Note: for windows inside Vim use |winnr()|. | |
2609 | 1785 |
7 | 1786 ============================================================================== |
1787 4. Builtin Functions *functions* | |
1788 | |
1789 See |function-list| for a list grouped by what the function is used for. | |
1790 | |
236 | 1791 (Use CTRL-] on the function name to jump to the full explanation.) |
7 | 1792 |
1793 USAGE RESULT DESCRIPTION ~ | |
1794 | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1795 abs({expr}) Float or Number absolute value of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1796 acos({expr}) Float arc cosine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1797 add({list}, {item}) List append {item} to |List| {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1798 alloc_fail({id}, {countdown}, {repeat}) |
7557
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1799 none make memory allocation fail |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1800 and({expr}, {expr}) Number bitwise AND |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1801 append({lnum}, {string}) Number append {string} below line {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1802 append({lnum}, {list}) Number append lines {list} below line {lnum} |
7 | 1803 argc() Number number of files in the argument list |
55 | 1804 argidx() Number current index in the argument list |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1805 arglistid([{winnr} [, {tabnr}]]) Number argument list id |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1806 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
|
1807 argv() List the argument list |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1808 assert_equal({exp}, {act} [, {msg}]) none assert {exp} is equal to {act} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1809 assert_exception({error} [, {msg}]) none assert {error} is in v:exception |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1810 assert_fails({cmd} [, {error}]) none assert {cmd} fails |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1811 assert_false({actual} [, {msg}]) none assert {actual} is false |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1812 assert_match({pat}, {text} [, {msg}]) none assert {pat} matches {text} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1813 assert_notequal({exp}, {act} [, {msg}]) none assert {exp} is not equal {act} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1814 assert_notmatch({pat}, {text} [, {msg}]) none assert {pat} not matches {text} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1815 assert_true({actual} [, {msg}]) none assert {actual} is true |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1816 asin({expr}) Float arc sine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1817 atan({expr}) Float arc tangent of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1818 atan2({expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1819 browse({save}, {title}, {initdir}, {default}) |
7 | 1820 String put up a file requester |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1821 browsedir({title}, {initdir}) String put up a directory requester |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1822 bufexists({expr}) Number TRUE if buffer {expr} exists |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1823 buflisted({expr}) Number TRUE if buffer {expr} is listed |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1824 bufloaded({expr}) Number TRUE if buffer {expr} is loaded |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1825 bufname({expr}) String Name of the buffer {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1826 bufnr({expr} [, {create}]) Number Number of the buffer {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1827 bufwinnr({expr}) Number window number of buffer {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1828 byte2line({byte}) Number line number at byte count {byte} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1829 byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1830 byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1831 call({func}, {arglist} [, {dict}]) |
102 | 1832 any call {func} with arguments {arglist} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1833 ceil({expr}) Float round {expr} up |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1834 ch_close({handle}) none close {handle} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1835 ch_evalexpr({handle}, {expr} [, {options}]) |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1836 any evaluate {expr} on JSON {handle} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1837 ch_evalraw({handle}, {string} [, {options}]) |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1838 any evaluate {string} on raw {handle} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1839 ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1840 ch_getjob({channel}) Job get the Job of {channel} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1841 ch_info({handle}) String info about channel {handle} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1842 ch_log({msg} [, {handle}]) none write {msg} in the channel log file |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1843 ch_logfile({fname} [, {mode}]) none start logging channel activity |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1844 ch_open({address} [, {options}]) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1845 Channel open a channel to {address} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1846 ch_read({handle} [, {options}]) String read from {handle} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1847 ch_readraw({handle} [, {options}]) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1848 String read raw from {handle} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1849 ch_sendexpr({handle}, {expr} [, {options}]) |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1850 any send {expr} over JSON {handle} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1851 ch_sendraw({handle}, {string} [, {options}]) |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
1852 any send {string} over raw {handle} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1853 ch_setoptions({handle}, {options}) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1854 none set options for {handle} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1855 ch_status({handle}) String status of channel {handle} |
1621 | 1856 changenr() Number current change number |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1857 char2nr({expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1858 cindent({lnum}) Number C indent for line {lnum} |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1859 clearmatches() none clear all matches |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1860 col({expr}) Number column nr of cursor or mark |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1861 complete({startcol}, {matches}) none set Insert mode completion |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1862 complete_add({expr}) Number add completion match |
1621 | 1863 complete_check() Number check for key typed during completion |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1864 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
7 | 1865 Number number of choice picked by user |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1866 copy({expr}) any make a shallow copy of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1867 cos({expr}) Float cosine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1868 cosh({expr}) Float hyperbolic cosine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1869 count({list}, {expr} [, {ic} [, {start}]]) |
95 | 1870 Number count how many {expr} are in {list} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1871 cscope_connection([{num} , {dbpath} [, {prepend}]]) |
7 | 1872 Number checks existence of cscope connection |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1873 cursor({lnum}, {col} [, {off}]) |
6385 | 1874 Number move cursor to {lnum}, {col}, {off} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1875 cursor({list}) Number move cursor to position in {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1876 deepcopy({expr} [, {noref}]) any make a full copy of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1877 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
7 | 1878 did_filetype() Number TRUE if FileType autocommand event used |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1879 diff_filler({lnum}) Number diff filler lines about {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1880 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1881 disable_char_avail_for_testing({expr}) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1882 none test without typeahead |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1883 empty({expr}) Number TRUE if {expr} is empty |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1884 escape({string}, {chars}) String escape {chars} in {string} with '\' |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1885 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
|
1886 eventhandler() Number TRUE if inside an event handler |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1887 executable({expr}) Number 1 if executable {expr} exists |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1888 exepath({expr}) String full path of the command {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1889 exists({expr}) Number TRUE if {expr} exists |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1890 extend({expr1}, {expr2} [, {expr3}]) |
824 | 1891 List/Dict insert items of {expr2} into {expr1} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1892 exp({expr}) Float exponential of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1893 expand({expr} [, {nosuf} [, {list}]]) |
3398 | 1894 any expand special keywords in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1895 feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1896 filereadable({file}) Number TRUE if {file} is a readable file |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1897 filewritable({file}) Number TRUE if {file} is a writable file |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1898 filter({expr}, {string}) List/Dict remove items from {expr} where |
102 | 1899 {string} is 0 |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1900 finddir({name}[, {path}[, {count}]]) |
824 | 1901 String find directory {name} in {path} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1902 findfile({name}[, {path}[, {count}]]) |
824 | 1903 String find file {name} in {path} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1904 float2nr({expr}) Number convert Float {expr} to a Number |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1905 floor({expr}) Float round {expr} down |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1906 fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1907 fnameescape({fname}) String escape special characters in {fname} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1908 fnamemodify({fname}, {mods}) String modify file name |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1909 foldclosed({lnum}) Number first line of fold at {lnum} if closed |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1910 foldclosedend({lnum}) Number last line of fold at {lnum} if closed |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1911 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
|
1912 foldtext() String line displayed for closed fold |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1913 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
|
1914 foreground() Number bring the Vim window to the foreground |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1915 function({name} [, {arglist}] [, {dict}]) |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
1916 Funcref reference to function {name} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1917 garbagecollect([{atexit}]) none free memory, breaking cyclic references |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1918 garbagecollect_for_testing() none free memory right now |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1919 get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1920 get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1921 getbufline({expr}, {lnum} [, {end}]) |
435 | 1922 List lines {lnum} to {end} of buffer {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1923 getbufvar({expr}, {varname} [, {def}]) |
4157 | 1924 any variable {varname} in buffer {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1925 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
|
1926 getcharmod() Number modifiers for the last typed character |
7013 | 1927 getcharsearch() Dict last character search |
7 | 1928 getcmdline() String return the current command-line |
1929 getcmdpos() Number return cursor position in command-line | |
6153 | 1930 getcmdtype() String return current command-line type |
1931 getcmdwintype() String return current command-line window type | |
5944 | 1932 getcurpos() List position of the cursor |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1933 getcwd([{winnr} [, {tabnr}]]) String get the current working directory |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1934 getfontname([{name}]) String name of font being used |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1935 getfperm({fname}) String file permissions of file {fname} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1936 getfsize({fname}) Number size in bytes of file {fname} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1937 getftime({fname}) Number last modification time of file |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1938 getftype({fname}) String description of type of file {fname} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1939 getline({lnum}) String line {lnum} of current buffer |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1940 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1941 getloclist({nr}) List list of location list items |
1326 | 1942 getmatches() List list of current matches |
1548 | 1943 getpid() Number process ID of Vim |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1944 getpos({expr}) List position of cursor, mark, etc. |
230 | 1945 getqflist() List list of quickfix items |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1946 getreg([{regname} [, 1 [, {list}]]]) |
5796 | 1947 String or List contents of register |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1948 getregtype([{regname}]) String type of register |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1949 gettabvar({nr}, {varname} [, {def}]) |
4157 | 1950 any variable {varname} in tab {nr} or {def} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1951 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
831 | 1952 any {name} in {winnr} in tab page {tabnr} |
7 | 1953 getwinposx() Number X coord in pixels of GUI Vim window |
1954 getwinposy() Number Y coord in pixels of GUI Vim window | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1955 getwinvar({nr}, {varname} [, {def}]) |
4157 | 1956 any variable {varname} in window {nr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1957 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
3398 | 1958 any expand file wildcards in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1959 glob2regpat({expr}) String convert a glob pat into a search pat |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1960 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
1754 | 1961 String do glob({expr}) for all dirs in {path} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1962 has({feature}) Number TRUE if feature {feature} supported |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1963 has_key({dict}, {key}) Number TRUE if {dict} has entry {key} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1964 haslocaldir([{winnr} [, {tabnr}]]) |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1965 Number TRUE if the window executed |:lcd| |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1966 hasmapto({what} [, {mode} [, {abbr}]]) |
782 | 1967 Number TRUE if mapping to {what} exists |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1968 histadd({history}, {item}) String add an item to a history |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1969 histdel({history} [, {item}]) String remove an item from a history |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1970 histget({history} [, {index}]) String get the item {index} from a history |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1971 histnr({history}) Number highest index of a history |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1972 hlexists({name}) Number TRUE if highlight group {name} exists |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1973 hlID({name}) Number syntax ID of highlight group {name} |
7 | 1974 hostname() String name of the machine Vim is running on |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1975 iconv({expr}, {from}, {to}) String convert encoding of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1976 indent({lnum}) Number indent of line {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1977 index({list}, {expr} [, {start} [, {ic}]]) |
95 | 1978 Number index in {list} where {expr} appears |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1979 input({prompt} [, {text} [, {completion}]]) |
531 | 1980 String get input from the user |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1981 inputdialog({prompt} [, {text} [, {completion}]]]) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1982 String like input() but in a GUI dialog |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1983 inputlist({textlist}) Number let the user pick from a choice list |
55 | 1984 inputrestore() Number restore typeahead |
1985 inputsave() Number save and clear typeahead | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1986 inputsecret({prompt} [, {text}]) String like input() but hiding the text |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1987 insert({list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1988 invert({expr}) Number bitwise invert |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1989 isdirectory({directory}) Number TRUE if {directory} is a directory |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1990 islocked({expr}) Number TRUE if {expr} is locked |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1991 isnan({expr}) Number TRUE if {expr} is NaN |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1992 items({dict}) List key-value pairs in {dict} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1993 job_getchannel({job}) Channel get the channel handle for {job} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1994 job_info({job}) Dict get information about {job} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1995 job_setoptions({job}, {options}) none set options for {job} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1996 job_start({command} [, {options}]) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1997 Job start a job |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1998 job_status({job}) String get the status of {job} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1999 job_stop({job} [, {how}]) Number stop {job} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2000 join({list} [, {sep}]) String join {list} items into one String |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2001 js_decode({string}) any decode JS style JSON |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2002 js_encode({expr}) String encode JS style JSON |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2003 json_decode({string}) any decode JSON |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2004 json_encode({expr}) String encode JSON |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2005 keys({dict}) List keys in {dict} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2006 len({expr}) Number the length of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2007 libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2008 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2009 line({expr}) Number line nr of cursor, last line or mark |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2010 line2byte({lnum}) Number byte count of line {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2011 lispindent({lnum}) Number Lisp indent for line {lnum} |
7 | 2012 localtime() Number current time |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2013 log({expr}) Float natural logarithm (base e) of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2014 log10({expr}) Float logarithm of Float {expr} to base 10 |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2015 luaeval({expr}[, {expr}]) any evaluate |Lua| expression |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2016 map({expr}, {string}) List/Dict change each item in {expr} to {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2017 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) |
3224 | 2018 String or Dict |
2019 rhs of mapping {name} in mode {mode} | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2020 mapcheck({name}[, {mode} [, {abbr}]]) |
782 | 2021 String check for mappings matching {name} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2022 match({expr}, {pat}[, {start}[, {count}]]) |
7 | 2023 Number position where {pat} matches in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2024 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
1326 | 2025 Number highlight {pattern} with {group} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2026 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) |
5979 | 2027 Number highlight positions with {group} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2028 matcharg({nr}) List arguments of |:match| |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2029 matchdelete({id}) Number delete match identified by {id} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2030 matchend({expr}, {pat}[, {start}[, {count}]]) |
7 | 2031 Number position where {pat} ends in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2032 matchlist({expr}, {pat}[, {start}[, {count}]]) |
158 | 2033 List match and submatches of {pat} in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2034 matchstr({expr}, {pat}[, {start}[, {count}]]) |
19 | 2035 String {count}'th match of {pat} in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2036 matchstrpos({expr}, {pat}[, {start}[, {count}]]) |
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2037 List {count}'th match of {pat} in {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2038 max({list}) Number maximum value of items in {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2039 min({list}) Number minimum value of items in {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2040 mkdir({name} [, {path} [, {prot}]]) |
168 | 2041 Number create directory {name} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2042 mode([expr]) String current editing mode |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2043 mzeval({expr}) any evaluate |MzScheme| expression |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2044 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2045 nr2char({expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2046 or({expr}, {expr}) Number bitwise OR |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2047 pathshorten({expr}) String shorten directory names in a path |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2048 perleval({expr}) any evaluate |Perl| expression |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2049 pow({x}, {y}) Float {x} to the power of {y} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2050 prevnonblank({lnum}) Number line nr of non-blank line <= {lnum} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2051 printf({fmt}, {expr1}...) String format text |
1621 | 2052 pumvisible() Number whether popup menu is visible |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2053 pyeval({expr}) any evaluate |Python| expression |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2054 py3eval({expr}) any evaluate |python3| expression |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2055 range({expr} [, {max} [, {stride}]]) |
99 | 2056 List items from {expr} to {max} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2057 readfile({fname} [, {binary} [, {max}]]) |
168 | 2058 List get list of lines from file {fname} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2059 reltime([{start} [, {end}]]) List get time value |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2060 reltimefloat({time}) Float turn the time value into a Float |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2061 reltimestr({time}) String turn time value into a String |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2062 remote_expr({server}, {string} [, {idvar}]) |
7 | 2063 String send expression |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2064 remote_foreground({server}) Number bring Vim server to the foreground |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2065 remote_peek({serverid} [, {retvar}]) |
7 | 2066 Number check for reply string |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2067 remote_read({serverid}) String read reply string |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2068 remote_send({server}, {string} [, {idvar}]) |
7 | 2069 String send key sequence |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2070 remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2071 remove({dict}, {key}) any remove entry {key} from {dict} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2072 rename({from}, {to}) Number rename (move) file from {from} to {to} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2073 repeat({expr}, {count}) String repeat {expr} {count} times |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2074 resolve({filename}) String get filename a shortcut points to |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2075 reverse({list}) List reverse {list} in-place |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2076 round({expr}) Float round off {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2077 screenattr({row}, {col}) Number attribute at screen position |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2078 screenchar({row}, {col}) Number character at screen position |
3986 | 2079 screencol() Number current cursor column |
2080 screenrow() Number current cursor row | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2081 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
1496 | 2082 Number search for {pattern} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2083 searchdecl({name} [, {global} [, {thisblock}]]) |
1621 | 2084 Number search for variable declaration |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2085 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
55 | 2086 Number search for other end of start/end pair |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2087 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
667 | 2088 List search for other end of start/end pair |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2089 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
667 | 2090 List search for {pattern} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2091 server2client({clientid}, {string}) |
7 | 2092 Number send reply string |
2093 serverlist() String get a list of available servers | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2094 setbufvar({expr}, {varname}, {val}) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2095 none set {varname} in buffer {expr} to {val} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2096 setcharsearch({dict}) Dict set character search from {dict} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2097 setcmdpos({pos}) Number set cursor position in command-line |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2098 setfperm({fname}, {mode}) Number set {fname} file permissions to {mode} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2099 setline({lnum}, {line}) Number set line {lnum} to {line} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2100 setloclist({nr}, {list}[, {action}]) |
647 | 2101 Number modify location list using {list} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2102 setmatches({list}) Number restore a list of matches |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2103 setpos({expr}, {list}) Number set the {expr} position to {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2104 setqflist({list}[, {action}]) Number modify quickfix list using {list} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2105 setreg({n}, {v}[, {opt}]) Number set register to value and type |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2106 settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2107 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2108 none set {varname} in window {winnr} in tab |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2109 page {tabnr} to {val} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2110 setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2111 sha256({string}) String SHA256 checksum of {string} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2112 shellescape({string} [, {special}]) |
1661 | 2113 String escape {string} for use as shell |
985 | 2114 command argument |
3875 | 2115 shiftwidth() Number effective value of 'shiftwidth' |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2116 simplify({filename}) String simplify filename as much as possible |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2117 sin({expr}) Float sine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2118 sinh({expr}) Float hyperbolic sine of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2119 sort({list} [, {func} [, {dict}]]) |
2902 | 2120 List sort {list}, using {func} to compare |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2121 soundfold({word}) String sound-fold {word} |
344 | 2122 spellbadword() String badly spelled word at cursor |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2123 spellsuggest({word} [, {max} [, {capital}]]) |
537 | 2124 List spelling suggestions |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2125 split({expr} [, {pat} [, {keepempty}]]) |
685 | 2126 List make |List| from {pat} separated {expr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2127 sqrt({expr}) Float square root of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2128 str2float({expr}) Float convert String to Float |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2129 str2nr({expr} [, {base}]) Number convert String to Number |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2130 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2131 strcharpart({str}, {start}[, {len}]) |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2132 String {len} characters of {str} at {start} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2133 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2134 strftime({format}[, {time}]) String time in specified format |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2135 strgetchar({str}, {index}) Number get char {index} from {str} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2136 stridx({haystack}, {needle}[, {start}]) |
133 | 2137 Number index of {needle} in {haystack} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2138 string({expr}) String String representation of {expr} value |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2139 strlen({expr}) Number length of the String {expr} |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2140 strpart({str}, {start}[, {len}]) |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2141 String {len} characters of {str} at {start} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2142 strridx({haystack}, {needle} [, {start}]) |
140 | 2143 Number last index of {needle} in {haystack} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2144 strtrans({expr}) String translate string to make it printable |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2145 strwidth({expr}) Number display cell length of the String {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2146 submatch({nr}[, {list}]) String or List |
5794 | 2147 specific match in ":s" or substitute() |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2148 substitute({expr}, {pat}, {sub}, {flags}) |
7 | 2149 String all {pat} in {expr} replaced with {sub} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2150 synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2151 synIDattr({synID}, {what} [, {mode}]) |
7 | 2152 String attribute {what} of syntax ID {synID} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2153 synIDtrans({synID}) Number translated syntax ID of {synID} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2154 synconcealed({lnum}, {col}) List info about concealing |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2155 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2156 system({expr} [, {input}]) String output of shell command/filter {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2157 systemlist({expr} [, {input}]) List output of shell command/filter {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2158 tabpagebuflist([{arg}]) List list of buffer numbers in tab page |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2159 tabpagenr([{arg}]) Number number of current or last tab page |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2160 tabpagewinnr({tabarg}[, {arg}]) Number number of current window in tab page |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2161 taglist({expr}) List list of tags matching {expr} |
1621 | 2162 tagfiles() List tags files used |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2163 tan({expr}) Float tangent of {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2164 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
|
2165 tempname() String name for a temporary file |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2166 timer_start({time}, {callback} [, {options}]) |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2167 Number create a timer |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2168 timer_stop({timer}) none stop a timer |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2169 tolower({expr}) String the String {expr} switched to lowercase |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2170 toupper({expr}) String the String {expr} switched to uppercase |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2171 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
15 | 2172 to chars in {tostr} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2173 trunc({expr}) Float truncate Float {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2174 type({name}) Number type of variable {name} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2175 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
|
2176 undotree() List undo file tree |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2177 uniq({list} [, {func} [, {dict}]]) |
5747 | 2178 List remove adjacent duplicates from a list |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2179 values({dict}) List values in {dict} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2180 virtcol({expr}) Number screen column of cursor or mark |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2181 visualmode([expr]) String last visual mode used |
4151 | 2182 wildmenumode() Number whether 'wildmenu' mode is active |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2183 win_findbuf({bufnr}) List find windows containing {bufnr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2184 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2185 win_gotoid({expr}) Number go to window with ID {expr} |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2186 win_id2tabwin({expr}) List get tab and window nr from window ID |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2187 win_id2win({expr}) Number get window nr from window ID |
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2188 winbufnr({nr}) Number buffer number of window {nr} |
7 | 2189 wincol() Number window column of the cursor |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2190 winheight({nr}) Number height of window {nr} |
7 | 2191 winline() Number window line of the cursor |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2192 winnr([{expr}]) Number number of current window |
55 | 2193 winrestcmd() String returns command to restore window sizes |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2194 winrestview({dict}) none restore view of current window |
712 | 2195 winsaveview() Dict save view of current window |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2196 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
|
2197 wordcount() Dict get byte/char/word statistics |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2198 writefile({list}, {fname} [, {flags}]) |
158 | 2199 Number write list of lines to file {fname} |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2200 xor({expr}, {expr}) Number bitwise XOR |
7 | 2201 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2202 |
1621 | 2203 abs({expr}) *abs()* |
2204 Return the absolute value of {expr}. When {expr} evaluates to | |
2205 a |Float| abs() returns a |Float|. When {expr} can be | |
2206 converted to a |Number| abs() returns a |Number|. Otherwise | |
2207 abs() gives an error message and returns -1. | |
2208 Examples: > | |
2209 echo abs(1.456) | |
2210 < 1.456 > | |
2211 echo abs(-5.456) | |
2212 < 5.456 > | |
2213 echo abs(-4) | |
2214 < 4 | |
2215 {only available when compiled with the |+float| feature} | |
2216 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2217 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2218 acos({expr}) *acos()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2219 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
|
2220 |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
|
2221 {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
|
2222 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2223 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2224 :echo acos(0) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2225 < 1.570796 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2226 :echo acos(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2227 < 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
|
2228 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2229 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2230 |
82 | 2231 add({list}, {expr}) *add()* |
685 | 2232 Append the item {expr} to |List| {list}. Returns the |
2233 resulting |List|. Examples: > | |
82 | 2234 :let alist = add([1, 2, 3], item) |
2235 :call add(mylist, "woodstock") | |
685 | 2236 < Note that when {expr} is a |List| it is appended as a single |
692 | 2237 item. Use |extend()| to concatenate |Lists|. |
85 | 2238 Use |insert()| to add an item at another position. |
55 | 2239 |
82 | 2240 |
7513
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2241 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
|
2242 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
|
2243 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
|
2244 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
|
2245 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
|
2246 |
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2247 |
3214 | 2248 and({expr}, {expr}) *and()* |
2249 Bitwise AND on the two arguments. The arguments are converted | |
2250 to a number. A List, Dict or Float argument causes an error. | |
2251 Example: > | |
2252 :let flag = and(bits, 0x80) | |
2253 | |
2254 | |
82 | 2255 append({lnum}, {expr}) *append()* |
685 | 2256 When {expr} is a |List|: Append each item of the |List| as a |
2257 text line below line {lnum} in the current buffer. | |
153 | 2258 Otherwise append {expr} as one text line below line {lnum} in |
2259 the current buffer. | |
2260 {lnum} can be zero to insert a line before the first one. | |
82 | 2261 Returns 1 for failure ({lnum} out of range or out of memory), |
1621 | 2262 0 for success. Example: > |
55 | 2263 :let failed = append(line('$'), "# THE END") |
82 | 2264 :let failed = append(0, ["Chapter 1", "the beginning"]) |
55 | 2265 < |
7 | 2266 *argc()* |
2267 argc() The result is the number of files in the argument list of the | |
2268 current window. See |arglist|. | |
2269 | |
2270 *argidx()* | |
2271 argidx() The result is the current index in the argument list. 0 is | |
2272 the first file. argc() - 1 is the last one. See |arglist|. | |
2273 | |
5942 | 2274 *arglistid()* |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2275 arglistid([{winnr} [, {tabnr}]]) |
5942 | 2276 Return the argument list ID. This is a number which |
2277 identifies the argument list being used. Zero is used for the | |
6153 | 2278 global argument list. See |arglist|. |
2279 Return -1 if the arguments are invalid. | |
5942 | 2280 |
2281 Without arguments use the current window. | |
2282 With {winnr} only use this window in the current tab page. | |
2283 With {winnr} and {tabnr} use the window in the specified tab | |
2284 page. | |
2285 | |
7 | 2286 *argv()* |
818 | 2287 argv([{nr}]) The result is the {nr}th file in the argument list of the |
7 | 2288 current window. See |arglist|. "argv(0)" is the first one. |
2289 Example: > | |
2290 :let i = 0 | |
2291 :while i < argc() | |
1621 | 2292 : let f = escape(fnameescape(argv(i)), '.') |
7 | 2293 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
2294 : let i = i + 1 | |
2295 :endwhile | |
818 | 2296 < Without the {nr} argument a |List| with the whole |arglist| is |
2297 returned. | |
2298 | |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2299 *assert_equal()* |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2300 assert_equal({expected}, {actual} [, {msg}]) |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2301 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
|
2302 added to |v:errors|. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2303 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
|
2304 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
|
2305 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
|
2306 always matters. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2307 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
|
2308 {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
|
2309 Example: > |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2310 assert_equal('foo', 'bar') |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2311 < 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
|
2312 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
|
2313 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2314 assert_exception({error} [, {msg}]) *assert_exception()* |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2315 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
|
2316 message is added to |v:errors|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2317 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
|
2318 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
|
2319 with translations: > |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2320 try |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2321 commandthatfails |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2322 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
|
2323 catch |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2324 call assert_exception('E492:') |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2325 endtry |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2326 |
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2327 assert_fails({cmd} [, {error}]) *assert_fails()* |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2328 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
|
2329 NOT produce an error. |
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2330 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
|
2331 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2332 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
|
2333 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
|
2334 |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
|
2335 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
|
2336 number the assert fails. |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2337 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
|
2338 got {actual}" is produced. |
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2339 |
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2340 *assert_match()* |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2341 assert_match({pattern}, {actual} [, {msg}]) |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2342 When {pattern} does not match {actual} an error message is |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2343 added to |v:errors|. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2344 |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2345 {pattern} is used as with |=~|: The matching is always done |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2346 like 'magic' was set and 'cpoptions' is empty, no matter what |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2347 the actual value of 'magic' or 'cpoptions' is. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2348 |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2349 {actual} is used as a string, automatic conversion applies. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2350 Use "^" and "$" to match with the start and end of the text. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2351 Use both to match the whole text. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2352 |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2353 When {msg} is omitted an error in the form "Pattern {pattern} |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2354 does not match {actual}" is produced. |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2355 Example: > |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2356 assert_match('^f.*o$', 'foobar') |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2357 < Will result in a string to be added to |v:errors|: |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2358 test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~ |
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2359 |
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2360 *assert_notequal()* |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2361 assert_notequal({expected}, {actual} [, {msg}]) |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2362 The opposite of `assert_equal()`: add an error message to |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2363 |v:errors| when {expected} and {actual} are equal. |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2364 |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2365 *assert_notmatch()* |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2366 assert_notmatch({pattern}, {actual} [, {msg}]) |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2367 The opposite of `assert_match()`: add an error message to |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2368 |v:errors| when {pattern} matches {actual}. |
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2369 |
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2370 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
|
2371 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
|
2372 |v:errors|, like with |assert_equal()|. |
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2373 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
|
2374 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
|
2375 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
|
2376 got {actual}" is produced. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2377 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2378 asin({expr}) *asin()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2379 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
|
2380 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
|
2381 {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
|
2382 [-1, 1]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2383 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2384 :echo asin(0.8) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2385 < 0.927295 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2386 :echo asin(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2387 < -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
|
2388 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2389 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2390 |
1621 | 2391 atan({expr}) *atan()* |
2392 Return the principal value of the arc tangent of {expr}, in | |
2393 the range [-pi/2, +pi/2] radians, as a |Float|. | |
2394 {expr} must evaluate to a |Float| or a |Number|. | |
2395 Examples: > | |
2396 :echo atan(100) | |
2397 < 1.560797 > | |
2398 :echo atan(-4.01) | |
2399 < -1.326405 | |
2400 {only available when compiled with the |+float| feature} | |
2401 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2402 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2403 atan2({expr1}, {expr2}) *atan2()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2404 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
|
2405 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
|
2406 {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
|
2407 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2408 :echo atan2(-1, 1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2409 < -0.785398 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2410 :echo atan2(1, -1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2411 < 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
|
2412 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2413 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2414 |
7 | 2415 *browse()* |
2416 browse({save}, {title}, {initdir}, {default}) | |
2417 Put up a file requester. This only works when "has("browse")" | |
2418 returns non-zero (only in some GUI versions). | |
2419 The input fields are: | |
2420 {save} when non-zero, select file to write | |
2421 {title} title for the requester | |
2422 {initdir} directory to start browsing in | |
2423 {default} default file name | |
2424 When the "Cancel" button is hit, something went wrong, or | |
2425 browsing is not possible, an empty string is returned. | |
2426 | |
29 | 2427 *browsedir()* |
2428 browsedir({title}, {initdir}) | |
2429 Put up a directory requester. This only works when | |
2430 "has("browse")" returns non-zero (only in some GUI versions). | |
2431 On systems where a directory browser is not supported a file | |
2432 browser is used. In that case: select a file in the directory | |
2433 to be used. | |
2434 The input fields are: | |
2435 {title} title for the requester | |
2436 {initdir} directory to start browsing in | |
2437 When the "Cancel" button is hit, something went wrong, or | |
2438 browsing is not possible, an empty string is returned. | |
2439 | |
7 | 2440 bufexists({expr}) *bufexists()* |
2441 The result is a Number, which is non-zero if a buffer called | |
2442 {expr} exists. | |
9 | 2443 If the {expr} argument is a number, buffer numbers are used. |
7 | 2444 If the {expr} argument is a string it must match a buffer name |
9 | 2445 exactly. The name can be: |
2446 - Relative to the current directory. | |
2447 - A full path. | |
1621 | 2448 - The name of a buffer with 'buftype' set to "nofile". |
9 | 2449 - A URL name. |
7 | 2450 Unlisted buffers will be found. |
2451 Note that help files are listed by their short name in the | |
2452 output of |:buffers|, but bufexists() requires using their | |
2453 long name to be able to find them. | |
1621 | 2454 bufexists() may report a buffer exists, but to use the name |
2455 with a |:buffer| command you may need to use |expand()|. Esp | |
2456 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
7 | 2457 Use "bufexists(0)" to test for the existence of an alternate |
2458 file name. | |
2459 *buffer_exists()* | |
2460 Obsolete name: buffer_exists(). | |
2461 | |
2462 buflisted({expr}) *buflisted()* | |
2463 The result is a Number, which is non-zero if a buffer called | |
2464 {expr} exists and is listed (has the 'buflisted' option set). | |
9 | 2465 The {expr} argument is used like with |bufexists()|. |
7 | 2466 |
2467 bufloaded({expr}) *bufloaded()* | |
2468 The result is a Number, which is non-zero if a buffer called | |
2469 {expr} exists and is loaded (shown in a window or hidden). | |
9 | 2470 The {expr} argument is used like with |bufexists()|. |
7 | 2471 |
2472 bufname({expr}) *bufname()* | |
2473 The result is the name of a buffer, as it is displayed by the | |
2474 ":ls" command. | |
2475 If {expr} is a Number, that buffer number's name is given. | |
2476 Number zero is the alternate buffer for the current window. | |
2477 If {expr} is a String, it is used as a |file-pattern| to match | |
1621 | 2478 with the buffer names. This is always done like 'magic' is |
7 | 2479 set and 'cpoptions' is empty. When there is more than one |
2480 match an empty string is returned. | |
2481 "" or "%" can be used for the current buffer, "#" for the | |
2482 alternate buffer. | |
2483 A full match is preferred, otherwise a match at the start, end | |
1156 | 2484 or middle of the buffer name is accepted. If you only want a |
2485 full match then put "^" at the start and "$" at the end of the | |
2486 pattern. | |
7 | 2487 Listed buffers are found first. If there is a single match |
2488 with a listed buffer, that one is returned. Next unlisted | |
2489 buffers are searched for. | |
2490 If the {expr} is a String, but you want to use it as a buffer | |
2491 number, force it to be a Number by adding zero to it: > | |
2492 :echo bufname("3" + 0) | |
2493 < If the buffer doesn't exist, or doesn't have a name, an empty | |
2494 string is returned. > | |
2495 bufname("#") alternate buffer name | |
2496 bufname(3) name of buffer 3 | |
2497 bufname("%") name of current buffer | |
2498 bufname("file2") name of buffer where "file2" matches. | |
2499 < *buffer_name()* | |
2500 Obsolete name: buffer_name(). | |
2501 | |
2502 *bufnr()* | |
707 | 2503 bufnr({expr} [, {create}]) |
2504 The result is the number of a buffer, as it is displayed by | |
7 | 2505 the ":ls" command. For the use of {expr}, see |bufname()| |
707 | 2506 above. |
2507 If the buffer doesn't exist, -1 is returned. Or, if the | |
2508 {create} argument is present and not zero, a new, unlisted, | |
2509 buffer is created and its number is returned. | |
7 | 2510 bufnr("$") is the last buffer: > |
2511 :let last_buffer = bufnr("$") | |
2512 < The result is a Number, which is the highest buffer number | |
2513 of existing buffers. Note that not all buffers with a smaller | |
2514 number necessarily exist, because ":bwipeout" may have removed | |
2515 them. Use bufexists() to test for the existence of a buffer. | |
2516 *buffer_number()* | |
2517 Obsolete name: buffer_number(). | |
2518 *last_buffer_nr()* | |
2519 Obsolete name for bufnr("$"): last_buffer_nr(). | |
2520 | |
2521 bufwinnr({expr}) *bufwinnr()* | |
2522 The result is a Number, which is the number of the first | |
2523 window associated with buffer {expr}. For the use of {expr}, | |
1621 | 2524 see |bufname()| above. If buffer {expr} doesn't exist or |
7 | 2525 there is no such window, -1 is returned. Example: > |
2526 | |
2527 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
2528 | |
2529 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
2530 |:wincmd|. | |
1156 | 2531 Only deals with the current tab page. |
7 | 2532 |
2533 byte2line({byte}) *byte2line()* | |
2534 Return the line number that contains the character at byte | |
2535 count {byte} in the current buffer. This includes the | |
2536 end-of-line character, depending on the 'fileformat' option | |
2537 for the current buffer. The first character has byte count | |
2538 one. | |
2539 Also see |line2byte()|, |go| and |:goto|. | |
2540 {not available when compiled without the |+byte_offset| | |
2541 feature} | |
2542 | |
18 | 2543 byteidx({expr}, {nr}) *byteidx()* |
2544 Return byte index of the {nr}'th character in the string | |
2545 {expr}. Use zero for the first character, it returns zero. | |
2546 This function is only useful when there are multibyte | |
2547 characters, otherwise the returned value is equal to {nr}. | |
5413 | 2548 Composing characters are not counted separately, their byte |
2549 length is added to the preceding base character. See | |
2550 |byteidxcomp()| below for counting composing characters | |
2551 separately. | |
18 | 2552 Example : > |
2553 echo matchstr(str, ".", byteidx(str, 3)) | |
2554 < will display the fourth character. Another way to do the | |
2555 same: > | |
2556 let s = strpart(str, byteidx(str, 3)) | |
2557 echo strpart(s, 0, byteidx(s, 1)) | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2558 < Also see |strgetchar()| and |strcharpart()|. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2559 |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2560 If there are less than {nr} characters -1 is returned. |
18 | 2561 If there are exactly {nr} characters the length of the string |
5413 | 2562 in bytes is returned. |
2563 | |
2564 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
2565 Like byteidx(), except that a composing character is counted | |
2566 as a separate character. Example: > | |
2567 let s = 'e' . nr2char(0x301) | |
2568 echo byteidx(s, 1) | |
2569 echo byteidxcomp(s, 1) | |
2570 echo byteidxcomp(s, 2) | |
2571 < The first and third echo result in 3 ('e' plus composing | |
2572 character is 3 bytes), the second echo results in 1 ('e' is | |
2573 one byte). | |
2574 Only works different from byteidx() when 'encoding' is set to | |
2575 a Unicode encoding. | |
18 | 2576 |
102 | 2577 call({func}, {arglist} [, {dict}]) *call()* *E699* |
685 | 2578 Call function {func} with the items in |List| {arglist} as |
79 | 2579 arguments. |
685 | 2580 {func} can either be a |Funcref| or the name of a function. |
79 | 2581 a:firstline and a:lastline are set to the cursor line. |
2582 Returns the return value of the called function. | |
102 | 2583 {dict} is for functions with the "dict" attribute. It will be |
2584 used to set the local variable "self". |Dictionary-function| | |
79 | 2585 |
1621 | 2586 ceil({expr}) *ceil()* |
2587 Return the smallest integral value greater than or equal to | |
2588 {expr} as a |Float| (round up). | |
2589 {expr} must evaluate to a |Float| or a |Number|. | |
2590 Examples: > | |
2591 echo ceil(1.456) | |
2592 < 2.0 > | |
2593 echo ceil(-5.456) | |
2594 < -5.0 > | |
2595 echo ceil(4.0) | |
2596 < 4.0 | |
2597 {only available when compiled with the |+float| feature} | |
2598 | |
777 | 2599 changenr() *changenr()* |
2600 Return the number of the most recent change. This is the same | |
2601 number as what is displayed with |:undolist| and can be used | |
2602 with the |:undo| command. | |
2603 When a change was made it is the number of that change. After | |
2604 redo it is the number of the redone change. After undo it is | |
2605 one less than the number of the undone change. | |
2606 | |
4051 | 2607 char2nr({expr}[, {utf8}]) *char2nr()* |
7 | 2608 Return number value of the first char in {expr}. Examples: > |
2609 char2nr(" ") returns 32 | |
2610 char2nr("ABC") returns 65 | |
4051 | 2611 < When {utf8} is omitted or zero, the current 'encoding' is used. |
2612 Example for "utf-8": > | |
1156 | 2613 char2nr("á") returns 225 |
2614 char2nr("á"[0]) returns 195 | |
4051 | 2615 < With {utf8} set to 1, always treat as utf-8 characters. |
2616 A combining character is a separate character. | |
2965 | 2617 |nr2char()| does the opposite. |
7 | 2618 |
2619 cindent({lnum}) *cindent()* | |
2620 Get the amount of indent for line {lnum} according the C | |
2621 indenting rules, as with 'cindent'. | |
2622 The indent is counted in spaces, the value of 'tabstop' is | |
2623 relevant. {lnum} is used just like in |getline()|. | |
2624 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
2625 feature, -1 is returned. | |
548 | 2626 See |C-indenting|. |
7 | 2627 |
1326 | 2628 clearmatches() *clearmatches()* |
2629 Clears all matches previously defined by |matchadd()| and the | |
2630 |:match| commands. | |
2631 | |
7 | 2632 *col()* |
24 | 2633 col({expr}) The result is a Number, which is the byte index of the column |
7 | 2634 position given with {expr}. The accepted positions are: |
2635 . the cursor position | |
2636 $ the end of the cursor line (the result is the | |
3513 | 2637 number of bytes in the cursor line plus one) |
7 | 2638 'x position of mark x (if the mark is not set, 0 is |
2639 returned) | |
6447 | 2640 v In Visual mode: the start of the Visual area (the |
2641 cursor is the end). When not in Visual mode | |
2642 returns the cursor position. Differs from |'<| in | |
2643 that it's updated right away. | |
1317 | 2644 Additionally {expr} can be [lnum, col]: a |List| with the line |
2645 and column number. Most useful when the column is "$", to get | |
1621 | 2646 the last column of a specific line. When "lnum" or "col" is |
1317 | 2647 out of range then col() returns zero. |
1156 | 2648 To get the line number use |line()|. To get both use |
703 | 2649 |getpos()|. |
7 | 2650 For the screen column position use |virtcol()|. |
2651 Note that only marks in the current file can be used. | |
2652 Examples: > | |
2653 col(".") column of cursor | |
2654 col("$") length of cursor line plus one | |
2655 col("'t") column of mark t | |
2656 col("'" . markname) column of mark markname | |
1621 | 2657 < The first column is 1. 0 is returned for an error. |
1156 | 2658 For an uppercase mark the column may actually be in another |
2659 buffer. | |
7 | 2660 For the cursor position, when 'virtualedit' is active, the |
2661 column is one higher if the cursor is after the end of the | |
2662 line. This can be used to obtain the column in Insert mode: > | |
2663 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
2664 \<C-O>:set ve=all<CR> | |
2665 \<C-O>:echo col(".") . "\n" <Bar> | |
2666 \let &ve = save_ve<CR> | |
2667 < | |
464 | 2668 |
724 | 2669 complete({startcol}, {matches}) *complete()* *E785* |
2670 Set the matches for Insert mode completion. | |
2671 Can only be used in Insert mode. You need to use a mapping | |
1156 | 2672 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
2673 with an expression mapping. | |
724 | 2674 {startcol} is the byte offset in the line where the completed |
2675 text start. The text up to the cursor is the original text | |
2676 that will be replaced by the matches. Use col('.') for an | |
2677 empty string. "col('.') - 1" will replace one character by a | |
2678 match. | |
2679 {matches} must be a |List|. Each |List| item is one match. | |
2680 See |complete-items| for the kind of items that are possible. | |
2681 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
|
2682 inserting anything that would cause completion to stop. |
724 | 2683 The match can be selected with CTRL-N and CTRL-P as usual with |
2684 Insert mode completion. The popup menu will appear if | |
2685 specified, see |ins-completion-menu|. | |
2686 Example: > | |
1156 | 2687 inoremap <F5> <C-R>=ListMonths()<CR> |
724 | 2688 |
2689 func! ListMonths() | |
2690 call complete(col('.'), ['January', 'February', 'March', | |
2691 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
2692 \ 'October', 'November', 'December']) | |
2693 return '' | |
2694 endfunc | |
2695 < This isn't very useful, but it shows how it works. Note that | |
2696 an empty string is returned to avoid a zero being inserted. | |
2697 | |
464 | 2698 complete_add({expr}) *complete_add()* |
2699 Add {expr} to the list of matches. Only to be used by the | |
2700 function specified with the 'completefunc' option. | |
2701 Returns 0 for failure (empty string or out of memory), | |
2702 1 when the match was added, 2 when the match was already in | |
2703 the list. | |
1621 | 2704 See |complete-functions| for an explanation of {expr}. It is |
786 | 2705 the same as one item in the list that 'omnifunc' would return. |
464 | 2706 |
2707 complete_check() *complete_check()* | |
2708 Check for a key typed while looking for completion matches. | |
2709 This is to be used when looking for matches takes some time. | |
2710 Returns non-zero when searching for matches is to be aborted, | |
2711 zero otherwise. | |
2712 Only to be used by the function specified with the | |
2713 'completefunc' option. | |
2714 | |
7 | 2715 *confirm()* |
2716 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
2717 Confirm() offers the user a dialog, from which a choice can be | |
2718 made. It returns the number of the choice. For the first | |
2719 choice this is 1. | |
2720 Note: confirm() is only supported when compiled with dialog | |
2721 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
|
2722 |
7 | 2723 {msg} is displayed in a |dialog| with {choices} as the |
2724 alternatives. When {choices} is missing or empty, "&OK" is | |
2725 used (and translated). | |
2726 {msg} is a String, use '\n' to include a newline. Only on | |
2727 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
|
2728 |
7 | 2729 {choices} is a String, with the individual choices separated |
2730 by '\n', e.g. > | |
2731 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
2732 < The letter after the '&' is the shortcut key for that choice. | |
2733 Thus you can type 'c' to select "Cancel". The shortcut does | |
2734 not need to be the first letter: > | |
2735 confirm("file has been modified", "&Save\nSave &All") | |
2736 < For the console, the first letter of each choice is used as | |
2737 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
|
2738 |
7 | 2739 The optional {default} argument is the number of the choice |
2740 that is made if the user hits <CR>. Use 1 to make the first | |
2741 choice the default one. Use 0 to not set a default. If | |
2742 {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
|
2743 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2744 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
|
2745 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
|
2746 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
|
2747 "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
|
2748 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
|
2749 |
7 | 2750 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
2751 or another valid interrupt key, confirm() returns 0. | |
2752 | |
2753 An example: > | |
2754 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
2755 :if choice == 0 | |
2756 : echo "make up your mind!" | |
2757 :elseif choice == 3 | |
2758 : echo "tasteful" | |
2759 :else | |
2760 : echo "I prefer bananas myself." | |
2761 :endif | |
2762 < In a GUI dialog, buttons are used. The layout of the buttons | |
2763 depends on the 'v' flag in 'guioptions'. If it is included, | |
1621 | 2764 the buttons are always put vertically. Otherwise, confirm() |
7 | 2765 tries to put the buttons in one horizontal line. If they |
2766 don't fit, a vertical layout is used anyway. For some systems | |
2767 the horizontal layout is always used. | |
2768 | |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2769 ch_close({handle}) *ch_close()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2770 Close {handle}. See |channel-close|. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2771 {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
|
2772 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2773 {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
|
2774 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2775 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
|
2776 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
|
2777 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
|
2778 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
|
2779 {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
|
2780 *E917* |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2781 {options} must be a Dictionary. It must not have a "callback" |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2782 entry. It can have a "timeout" entry to specify the timeout |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2783 for this specific request. |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2784 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2785 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
|
2786 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
|
2787 empty string. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2788 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2789 {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
|
2790 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2791 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
|
2792 Send {string} over {handle}. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2793 {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
|
2794 |
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2795 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
|
2796 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
|
2797 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
|
2798 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
|
2799 is removed. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2800 See |channel-use|. |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2801 |
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2802 {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
|
2803 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2804 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2805 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
|
2806 {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
|
2807 {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
|
2808 socket output. |
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2809 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
|
2810 {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
|
2811 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2812 ch_getjob({channel}) *ch_getjob()* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2813 Get the Job associated with {channel}. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2814 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
|
2815 will result in "fail". |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2816 |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2817 {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
|
2818 |+job| features} |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2819 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2820 ch_info({handle}) *ch_info()* |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2821 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
|
2822 items are: |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2823 "id" number of the channel |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2824 "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
|
2825 When opened with ch_open(): |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2826 "hostname" the hostname of the address |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2827 "port" the port of the address |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2828 "sock_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2829 "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
|
2830 "sock_io" "socket" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2831 "sock_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2832 When opened with job_start(): |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2833 "out_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2834 "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
|
2835 "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
|
2836 "out_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2837 "err_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2838 "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
|
2839 "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
|
2840 "err_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2841 "in_status" "open" or "closed" |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2842 "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
|
2843 "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
|
2844 "in_timeout" timeout in msec |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2845 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2846 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
|
2847 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
|
2848 |ch_logfile()|. |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2849 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
|
2850 message. |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2851 {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
|
2852 Channel must open. |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2853 |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2854 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
|
2855 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
|
2856 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
|
2857 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2858 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
|
2859 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
|
2860 |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2861 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
|
2862 "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
|
2863 |
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2864 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2865 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
|
2866 Open a channel to {address}. See |channel|. |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2867 Returns a Channel. Use |ch_status()| to check for failure. |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2868 |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2869 {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
|
2870 "localhost:8765". |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2871 |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2872 If {options} is given it must be a |Dictionary|. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2873 See |channel-open-options|. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2874 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2875 {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
|
2876 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2877 ch_read({handle} [, {options}]) *ch_read()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2878 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
|
2879 {handle} can be Channel or a Job that has a Channel. |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2880 See |channel-more|. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2881 {only available when compiled with the |+channel| feature} |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2882 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2883 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
|
2884 Like ch_read() but for a JS and JSON channel does not decode |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2885 the message. See |channel-more|. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2886 {only available when compiled with the |+channel| feature} |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2887 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2888 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
|
2889 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
|
2890 according to the type of channel. The function cannot be used |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2891 with a raw channel. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2892 See |channel-use|. *E912* |
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. |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2894 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2895 {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
|
2896 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2897 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
|
2898 Send {string} over {handle}. |
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
2899 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
|
2900 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
|
2901 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
|
2902 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
|
2903 is removed. |
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
2904 See |channel-use|. |
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2905 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2906 {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
|
2907 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2908 ch_setoptions({handle}, {options}) *ch_setoptions()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2909 Set options on {handle}: |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2910 "callback" the channel callback |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2911 "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
|
2912 "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
|
2913 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
|
2914 {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
|
2915 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2916 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
|
2917 lost. |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2918 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2919 These options cannot be changed: |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2920 "waittime" only applies to "ch_open()| |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2921 |
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2922 ch_status({handle}) *ch_status()* |
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2923 Return the status of {handle}: |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2924 "fail" failed to open the channel |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2925 "open" channel can be used |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
2926 "buffered" channel can be read, not written to |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2927 "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
|
2928 {handle} can be Channel or a Job that has a Channel. |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
2929 "buffered" is used when the channel was closed but there is |
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
2930 still data that can be obtained with |ch_read()|. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
2931 |
55 | 2932 *copy()* |
1621 | 2933 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 2934 different from using {expr} directly. |
685 | 2935 When {expr} is a |List| a shallow copy is created. This means |
2936 that the original |List| can be changed without changing the | |
1621 | 2937 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
|
2938 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
|
2939 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
|
2940 Also see |deepcopy()|. |
55 | 2941 |
1621 | 2942 cos({expr}) *cos()* |
2943 Return the cosine of {expr}, measured in radians, as a |Float|. | |
2944 {expr} must evaluate to a |Float| or a |Number|. | |
2945 Examples: > | |
2946 :echo cos(100) | |
2947 < 0.862319 > | |
2948 :echo cos(-4.01) | |
2949 < -0.646043 | |
2950 {only available when compiled with the |+float| feature} | |
2951 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2952 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2953 cosh({expr}) *cosh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2954 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
|
2955 [1, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2956 {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
|
2957 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2958 :echo cosh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2959 < 1.127626 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2960 :echo cosh(-0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2961 < -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
|
2962 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2963 |
1621 | 2964 |
102 | 2965 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
79 | 2966 Return the number of times an item with value {expr} appears |
685 | 2967 in |List| or |Dictionary| {comp}. |
102 | 2968 If {start} is given then start with the item with this index. |
685 | 2969 {start} can only be used with a |List|. |
79 | 2970 When {ic} is given and it's non-zero then case is ignored. |
2971 | |
2972 | |
7 | 2973 *cscope_connection()* |
2974 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
2975 Checks for the existence of a |cscope| connection. If no | |
2976 parameters are specified, then the function returns: | |
2977 0, if cscope was not available (not compiled in), or | |
2978 if there are no cscope connections; | |
2979 1, if there is at least one cscope connection. | |
2980 | |
2981 If parameters are specified, then the value of {num} | |
2982 determines how existence of a cscope connection is checked: | |
2983 | |
2984 {num} Description of existence check | |
2985 ----- ------------------------------ | |
2986 0 Same as no parameters (e.g., "cscope_connection()"). | |
2987 1 Ignore {prepend}, and use partial string matches for | |
2988 {dbpath}. | |
2989 2 Ignore {prepend}, and use exact string matches for | |
2990 {dbpath}. | |
2991 3 Use {prepend}, use partial string matches for both | |
2992 {dbpath} and {prepend}. | |
2993 4 Use {prepend}, use exact string matches for both | |
2994 {dbpath} and {prepend}. | |
2995 | |
2996 Note: All string comparisons are case sensitive! | |
2997 | |
2998 Examples. Suppose we had the following (from ":cs show"): > | |
2999 | |
3000 # pid database name prepend path | |
3001 0 27664 cscope.out /usr/local | |
3002 < | |
3003 Invocation Return Val ~ | |
3004 ---------- ---------- > | |
3005 cscope_connection() 1 | |
3006 cscope_connection(1, "out") 1 | |
3007 cscope_connection(2, "out") 0 | |
3008 cscope_connection(3, "out") 0 | |
3009 cscope_connection(3, "out", "local") 1 | |
3010 cscope_connection(4, "out") 0 | |
3011 cscope_connection(4, "out", "local") 0 | |
3012 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
3013 < | |
703 | 3014 cursor({lnum}, {col} [, {off}]) *cursor()* |
3015 cursor({list}) | |
1156 | 3016 Positions the cursor at the column (byte count) {col} in the |
3017 line {lnum}. The first column is one. | |
5938 | 3018 |
703 | 3019 When there is one argument {list} this is used as a |List| |
5938 | 3020 with two, three or four item: |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3021 [{lnum}, {col}] |
5938 | 3022 [{lnum}, {col}, {off}] |
3023 [{lnum}, {col}, {off}, {curswant}] | |
6009 | 3024 This is like the return value of |getpos()| or |getcurpos()|, |
5944 | 3025 but without the first item. |
5938 | 3026 |
7 | 3027 Does not change the jumplist. |
3028 If {lnum} is greater than the number of lines in the buffer, | |
3029 the cursor will be positioned at the last line in the buffer. | |
3030 If {lnum} is zero, the cursor will stay in the current line. | |
493 | 3031 If {col} is greater than the number of bytes in the line, |
7 | 3032 the cursor will be positioned at the last character in the |
3033 line. | |
3034 If {col} is zero, the cursor will stay in the current column. | |
5944 | 3035 If {curswant} is given it is used to set the preferred column |
6180 | 3036 for vertical movement. Otherwise {col} is used. |
6385 | 3037 |
703 | 3038 When 'virtualedit' is used {off} specifies the offset in |
3039 screen columns from the start of the character. E.g., a | |
1266 | 3040 position within a <Tab> or after the last character. |
1851 | 3041 Returns 0 when the position could be set, -1 otherwise. |
7 | 3042 |
55 | 3043 |
164 | 3044 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
1621 | 3045 Make a copy of {expr}. For Numbers and Strings this isn't |
55 | 3046 different from using {expr} directly. |
685 | 3047 When {expr} is a |List| a full copy is created. This means |
3048 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
|
3049 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
|
3050 |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
|
3051 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
|
3052 the original |List|. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3053 A |Dictionary| is copied in a similar way as a |List|. |
685 | 3054 When {noref} is omitted or zero a contained |List| or |
3055 |Dictionary| is only copied once. All references point to | |
3056 this single copy. With {noref} set to 1 every occurrence of a | |
3057 |List| or |Dictionary| results in a new copy. This also means | |
3058 that a cyclic reference causes deepcopy() to fail. | |
114 | 3059 *E724* |
3060 Nesting is possible up to 100 levels. When there is an item | |
164 | 3061 that refers back to a higher level making a deep copy with |
3062 {noref} set to 1 will fail. | |
55 | 3063 Also see |copy()|. |
3064 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3065 delete({fname} [, {flags}]) *delete()* |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3066 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
|
3067 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
|
3068 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3069 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
|
3070 {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
|
3071 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3072 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
|
3073 {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
|
3074 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
|
3075 |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3076 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
|
3077 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
|
3078 |
685 | 3079 Use |remove()| to delete an item from a |List|. |
4229 | 3080 To delete a line from the buffer use |:delete|. Use |:exe| |
3081 when the line number is in a variable. | |
7 | 3082 |
3083 *did_filetype()* | |
3084 did_filetype() Returns non-zero when autocommands are being executed and the | |
3085 FileType event has been triggered at least once. Can be used | |
3086 to avoid triggering the FileType event again in the scripts | |
3087 that detect the file type. |FileType| | |
3088 When editing another file, the counter is reset, thus this | |
3089 really checks if the FileType event has been triggered for the | |
3090 current buffer. This allows an autocommand that starts | |
3091 editing another buffer to set 'filetype' and load a syntax | |
3092 file. | |
3093 | |
32 | 3094 diff_filler({lnum}) *diff_filler()* |
3095 Returns the number of filler lines above line {lnum}. | |
3096 These are the lines that were inserted at this point in | |
3097 another diff'ed window. These filler lines are shown in the | |
3098 display but don't exist in the buffer. | |
3099 {lnum} is used like with |getline()|. Thus "." is the current | |
3100 line, "'m" mark m, etc. | |
3101 Returns 0 if the current window is not in diff mode. | |
3102 | |
3103 diff_hlID({lnum}, {col}) *diff_hlID()* | |
3104 Returns the highlight ID for diff mode at line {lnum} column | |
3105 {col} (byte index). When the current line does not have a | |
3106 diff change zero is returned. | |
3107 {lnum} is used like with |getline()|. Thus "." is the current | |
3108 line, "'m" mark m, etc. | |
3109 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
3110 line. | |
3111 The highlight ID can be used with |synIDattr()| to obtain | |
3112 syntax information about the highlighting. | |
3113 | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3114 *disable_char_avail_for_testing()* |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3115 disable_char_avail_for_testing({expr}) |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3116 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
|
3117 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
|
3118 function normally. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3119 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
|
3120 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
|
3121 |
85 | 3122 empty({expr}) *empty()* |
3123 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
|
3124 - 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
|
3125 items. |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3126 - 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
|
3127 - |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
|
3128 - 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
|
3129 - 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
|
3130 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3131 For a long |List| this is much faster than comparing the |
685 | 3132 length with zero. |
85 | 3133 |
7 | 3134 escape({string}, {chars}) *escape()* |
3135 Escape the characters in {chars} that occur in {string} with a | |
3136 backslash. Example: > | |
3137 :echo escape('c:\program files\vim', ' \') | |
3138 < results in: > | |
3139 c:\\program\ files\\vim | |
1621 | 3140 < Also see |shellescape()|. |
3141 | |
3142 *eval()* | |
95 | 3143 eval({string}) Evaluate {string} and return the result. Especially useful to |
3144 turn the result of |string()| back into the original value. | |
1621 | 3145 This works for Numbers, Floats, Strings and composites of |
3146 them. Also works for |Funcref|s that refer to existing | |
3147 functions. | |
95 | 3148 |
7 | 3149 eventhandler() *eventhandler()* |
3150 Returns 1 when inside an event handler. That is that Vim got | |
3151 interrupted while waiting for the user to type a character, | |
3152 e.g., when dropping a file on Vim. This means interactive | |
3153 commands cannot be used. Otherwise zero is returned. | |
3154 | |
3155 executable({expr}) *executable()* | |
3156 This function checks if an executable with the name {expr} | |
3157 exists. {expr} must be the name of the program without any | |
10 | 3158 arguments. |
3159 executable() uses the value of $PATH and/or the normal | |
3160 searchpath for programs. *PATHEXT* | |
3161 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
3162 optionally be included. Then the extensions in $PATHEXT are | |
1621 | 3163 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
3164 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
10 | 3165 used. A dot by itself can be used in $PATHEXT to try using |
1621 | 3166 the name without an extension. When 'shell' looks like a |
10 | 3167 Unix shell, then the name is also tried without adding an |
3168 extension. | |
3169 On MS-DOS and MS-Windows it only checks if the file exists and | |
3170 is not a directory, not if it's really executable. | |
819 | 3171 On MS-Windows an executable in the same directory as Vim is |
3172 always found. Since this directory is added to $PATH it | |
3173 should also work to execute it |win32-PATH|. | |
7 | 3174 The result is a Number: |
3175 1 exists | |
3176 0 does not exist | |
3177 -1 not implemented on this system | |
3178 | |
5782 | 3179 exepath({expr}) *exepath()* |
3180 If {expr} is an executable and is either an absolute path, a | |
3181 relative path or found in $PATH, return the full path. | |
3182 Note that the current directory is used when {expr} starts | |
3183 with "./", which may be a problem for Vim: > | |
3184 echo exepath(v:progpath) | |
5814 | 3185 < If {expr} cannot be found in $PATH or is not executable then |
5782 | 3186 an empty string is returned. |
3187 | |
7 | 3188 *exists()* |
3189 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
3190 defined, zero otherwise. The {expr} argument is a string, | |
3191 which contains one of these: | |
3192 &option-name Vim option (only checks if it exists, | |
3193 not if it really works) | |
3194 +option-name Vim option that works. | |
3195 $ENVNAME environment variable (could also be | |
3196 done by comparing with an empty | |
3197 string) | |
3198 *funcname built-in function (see |functions|) | |
3199 or user defined function (see | |
5862 | 3200 |user-functions|). Also works for a |
3201 variable that is a Funcref. | |
7 | 3202 varname internal variable (see |
1621 | 3203 |internal-variables|). Also works |
685 | 3204 for |curly-braces-names|, |Dictionary| |
3205 entries, |List| items, etc. Beware | |
1668 | 3206 that evaluating an index may cause an |
3207 error message for an invalid | |
3208 expression. E.g.: > | |
3209 :let l = [1, 2, 3] | |
3210 :echo exists("l[5]") | |
3211 < 0 > | |
3212 :echo exists("l[xx]") | |
3213 < E121: Undefined variable: xx | |
3214 0 | |
7 | 3215 :cmdname Ex command: built-in command, user |
3216 command or command modifier |:command|. | |
3217 Returns: | |
3218 1 for match with start of a command | |
3219 2 full match with a command | |
3220 3 matches several user commands | |
3221 To check for a supported command | |
3222 always check the return value to be 2. | |
864 | 3223 :2match The |:2match| command. |
3224 :3match The |:3match| command. | |
7 | 3225 #event autocommand defined for this event |
3226 #event#pattern autocommand defined for this event and | |
3227 pattern (the pattern is taken | |
3228 literally and compared to the | |
3229 autocommand patterns character by | |
3230 character) | |
613 | 3231 #group autocommand group exists |
3232 #group#event autocommand defined for this group and | |
3233 event. | |
3234 #group#event#pattern | |
856 | 3235 autocommand defined for this group, |
613 | 3236 event and pattern. |
615 | 3237 ##event autocommand for this event is |
3238 supported. | |
7 | 3239 For checking for a supported feature use |has()|. |
3240 | |
3241 Examples: > | |
3242 exists("&shortname") | |
3243 exists("$HOSTNAME") | |
3244 exists("*strftime") | |
3245 exists("*s:MyFunc") | |
3246 exists("bufcount") | |
3247 exists(":Make") | |
613 | 3248 exists("#CursorHold") |
7 | 3249 exists("#BufReadPre#*.gz") |
613 | 3250 exists("#filetypeindent") |
3251 exists("#filetypeindent#FileType") | |
3252 exists("#filetypeindent#FileType#*") | |
615 | 3253 exists("##ColorScheme") |
7 | 3254 < There must be no space between the symbol (&/$/*/#) and the |
3255 name. | |
867 | 3256 There must be no extra characters after the name, although in |
3257 a few cases this is ignored. That may become more strict in | |
3258 the future, thus don't count on it! | |
3259 Working example: > | |
3260 exists(":make") | |
3261 < NOT working example: > | |
3262 exists(":make install") | |
859 | 3263 |
3264 < Note that the argument must be a string, not the name of the | |
3265 variable itself. For example: > | |
7 | 3266 exists(bufcount) |
3267 < This doesn't check for existence of the "bufcount" variable, | |
853 | 3268 but gets the value of "bufcount", and checks if that exists. |
7 | 3269 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3270 exp({expr}) *exp()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3271 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
|
3272 [0, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3273 {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
|
3274 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3275 :echo exp(2) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3276 < 7.389056 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3277 :echo exp(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3278 < 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
|
3279 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3280 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3281 |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3282 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
7 | 3283 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
|
3284 'wildignorecase' applies. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3285 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3286 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
|
3287 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
|
3288 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
|
3289 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
|
3290 file name contains a space] |
7 | 3291 |
1621 | 3292 If the expansion fails, the result is an empty string. A name |
4869 | 3293 for a non-existing file is not included, unless {expr} does |
3294 not start with '%', '#' or '<', see below. | |
7 | 3295 |
3296 When {expr} starts with '%', '#' or '<', the expansion is done | |
3297 like for the |cmdline-special| variables with their associated | |
3298 modifiers. Here is a short overview: | |
3299 | |
3300 % current file name | |
3301 # alternate file name | |
3302 #n alternate file name n | |
3303 <cfile> file name under the cursor | |
3304 <afile> autocmd file name | |
3305 <abuf> autocmd buffer number (as a String!) | |
3306 <amatch> autocmd matched name | |
5734 | 3307 <sfile> sourced script file or function name |
2662 | 3308 <slnum> sourced script file line number |
7 | 3309 <cword> word under the cursor |
3310 <cWORD> WORD under the cursor | |
3311 <client> the {clientid} of the last received | |
3312 message |server2client()| | |
3313 Modifiers: | |
3314 :p expand to full path | |
3315 :h head (last path component removed) | |
3316 :t tail (last path component only) | |
3317 :r root (one extension removed) | |
3318 :e extension only | |
3319 | |
3320 Example: > | |
3321 :let &tags = expand("%:p:h") . "/tags" | |
3322 < Note that when expanding a string that starts with '%', '#' or | |
3323 '<', any following text is ignored. This does NOT work: > | |
3324 :let doesntwork = expand("%:h.bak") | |
3325 < Use this: > | |
3326 :let doeswork = expand("%:h") . ".bak" | |
3327 < Also note that expanding "<cfile>" and others only returns the | |
3328 referenced file name without further expansion. If "<cfile>" | |
3329 is "~/.cshrc", you need to do another expand() to have the | |
3330 "~/" expanded into the path of the home directory: > | |
3331 :echo expand(expand("<cfile>")) | |
3332 < | |
3333 There cannot be white space between the variables and the | |
3334 following modifier. The |fnamemodify()| function can be used | |
3335 to modify normal file names. | |
3336 | |
3337 When using '%' or '#', and the current or alternate file name | |
3338 is not defined, an empty string is used. Using "%:p" in a | |
3339 buffer with no name, results in the current directory, with a | |
3340 '/' added. | |
3341 | |
3342 When {expr} does not start with '%', '#' or '<', it is | |
3343 expanded like a file name is expanded on the command line. | |
3344 'suffixes' and 'wildignore' are used, unless the optional | |
3398 | 3345 {nosuf} argument is given and it is non-zero. |
3346 Names for non-existing files are included. The "**" item can | |
3347 be used to search in a directory tree. For example, to find | |
3348 all "README" files in the current directory and below: > | |
444 | 3349 :echo expand("**/README") |
3350 < | |
7 | 3351 Expand() can also be used to expand variables and environment |
3352 variables that are only known in a shell. But this can be | |
6180 | 3353 slow, because a shell may be used to do the expansion. See |
3354 |expr-env-expand|. | |
7 | 3355 The expanded variable is still handled like a list of file |
1621 | 3356 names. When an environment variable cannot be expanded, it is |
7 | 3357 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
3358 "$FOOBAR". | |
3359 | |
3360 See |glob()| for finding existing files. See |system()| for | |
3361 getting the raw output of an external command. | |
3362 | |
102 | 3363 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
692 | 3364 {expr1} and {expr2} must be both |Lists| or both |
3365 |Dictionaries|. | |
3366 | |
3367 If they are |Lists|: Append {expr2} to {expr1}. | |
102 | 3368 If {expr3} is given insert the items of {expr2} before item |
3369 {expr3} in {expr1}. When {expr3} is zero insert before the | |
3370 first item. When {expr3} is equal to len({expr1}) then | |
3371 {expr2} is appended. | |
79 | 3372 Examples: > |
3373 :echo sort(extend(mylist, [7, 5])) | |
3374 :call extend(mylist, [2, 3], 1) | |
1699 | 3375 < When {expr1} is the same List as {expr2} then the number of |
3376 items copied is equal to the original length of the List. | |
3377 E.g., when {expr3} is 1 you get N new copies of the first item | |
3378 (where N is the original length of the List). | |
3379 Use |add()| to concatenate one item to a list. To concatenate | |
82 | 3380 two lists into a new list use the + operator: > |
79 | 3381 :let newlist = [1, 2, 3] + [4, 5] |
102 | 3382 < |
692 | 3383 If they are |Dictionaries|: |
102 | 3384 Add all entries from {expr2} to {expr1}. |
3385 If a key exists in both {expr1} and {expr2} then {expr3} is | |
3386 used to decide what to do: | |
3387 {expr3} = "keep": keep the value of {expr1} | |
3388 {expr3} = "force": use the value of {expr2} | |
856 | 3389 {expr3} = "error": give an error message *E737* |
102 | 3390 When {expr3} is omitted then "force" is assumed. |
3391 | |
3392 {expr1} is changed when {expr2} is not empty. If necessary | |
3393 make a copy of {expr1} first. | |
3394 {expr2} remains unchanged. | |
6823 | 3395 When {expr1} is locked and {expr2} is not empty the operation |
3396 fails. | |
102 | 3397 Returns {expr1}. |
3398 | |
79 | 3399 |
842 | 3400 feedkeys({string} [, {mode}]) *feedkeys()* |
3401 Characters in {string} are queued for processing as if they | |
6549 | 3402 come from a mapping or were typed by the user. |
3403 By default the string is added to the end of the typeahead | |
3404 buffer, thus if a mapping is still being executed the | |
3405 characters come after them. Use the 'i' flag to insert before | |
3406 other characters, they will be executed next, before any | |
3407 characters from a mapping. | |
842 | 3408 The function does not wait for processing of keys contained in |
3409 {string}. | |
3410 To include special keys into {string}, use double-quotes | |
3411 and "\..." notation |expr-quote|. For example, | |
1215 | 3412 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
842 | 3413 feedkeys('\<CR>') pushes 5 characters. |
3414 If {mode} is absent, keys are remapped. | |
3415 {mode} is a String, which can contain these character flags: | |
843 | 3416 'm' Remap keys. This is default. |
3417 'n' Do not remap keys. | |
3418 't' Handle keys as if typed; otherwise they are handled as | |
3419 if coming from a mapping. This matters for undo, | |
3420 opening folds, etc. | |
6549 | 3421 '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
|
3422 '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
|
3423 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
|
3424 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
|
3425 (possibly with an empty {string}) to execute all the |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3426 typeahead. Note that when Vim ends in Insert mode it |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3427 will behave as if <Esc> is typed, to avoid getting |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3428 stuck, waiting for a character to be typed before the |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3429 script continues. |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3430 '!' When used with 'x' will not end Insert mode. Can be |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3431 used in a test when a timer is set to exit Insert mode |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3432 a little later. Useful for testing CursorHoldI. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3433 |
842 | 3434 Return value is always 0. |
3435 | |
7 | 3436 filereadable({file}) *filereadable()* |
3437 The result is a Number, which is TRUE when a file with the | |
3438 name {file} exists, and can be read. If {file} doesn't exist, | |
3439 or is a directory, the result is FALSE. {file} is any | |
3440 expression, which is used as a String. | |
1156 | 3441 If you don't care about the file being readable you can use |
3442 |glob()|. | |
7 | 3443 *file_readable()* |
3444 Obsolete name: file_readable(). | |
3445 | |
95 | 3446 |
1156 | 3447 filewritable({file}) *filewritable()* |
3448 The result is a Number, which is 1 when a file with the | |
3449 name {file} exists, and can be written. If {file} doesn't | |
1621 | 3450 exist, or is not writable, the result is 0. If {file} is a |
1156 | 3451 directory, and we can write to it, the result is 2. |
3452 | |
3453 | |
102 | 3454 filter({expr}, {string}) *filter()* |
685 | 3455 {expr} must be a |List| or a |Dictionary|. |
102 | 3456 For each item in {expr} evaluate {string} and when the result |
685 | 3457 is zero remove the item from the |List| or |Dictionary|. |
102 | 3458 Inside {string} |v:val| has the value of the current item. |
685 | 3459 For a |Dictionary| |v:key| has the key of the current item. |
102 | 3460 Examples: > |
3461 :call filter(mylist, 'v:val !~ "OLD"') | |
3462 < Removes the items where "OLD" appears. > | |
3463 :call filter(mydict, 'v:key >= 8') | |
3464 < Removes the items with a key below 8. > | |
3465 :call filter(var, 0) | |
685 | 3466 < Removes all the items, thus clears the |List| or |Dictionary|. |
99 | 3467 |
102 | 3468 Note that {string} is the result of expression and is then |
3469 used as an expression again. Often it is good to use a | |
3470 |literal-string| to avoid having to double backslashes. | |
3471 | |
685 | 3472 The operation is done in-place. If you want a |List| or |
3473 |Dictionary| to remain unmodified make a copy first: > | |
650 | 3474 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
102 | 3475 |
685 | 3476 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 3477 When an error is encountered while evaluating {string} no |
3478 further items in {expr} are processed. | |
95 | 3479 |
3480 | |
19 | 3481 finddir({name}[, {path}[, {count}]]) *finddir()* |
1095 | 3482 Find directory {name} in {path}. Supports both downwards and |
3483 upwards recursive directory searches. See |file-searching| | |
3484 for the syntax of {path}. | |
3485 Returns the path of the first found match. When the found | |
3486 directory is below the current directory a relative path is | |
3487 returned. Otherwise a full path is returned. | |
19 | 3488 If {path} is omitted or empty then 'path' is used. |
3489 If the optional {count} is given, find {count}'s occurrence of | |
794 | 3490 {name} in {path} instead of the first one. |
809 | 3491 When {count} is negative return all the matches in a |List|. |
19 | 3492 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
|
3493 {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
|
3494 feature} |
794 | 3495 |
3496 findfile({name}[, {path}[, {count}]]) *findfile()* | |
3497 Just like |finddir()|, but find a file instead of a directory. | |
3498 Uses 'suffixesadd'. | |
19 | 3499 Example: > |
3500 :echo findfile("tags.vim", ".;") | |
1156 | 3501 < Searches from the directory of the current file upwards until |
3502 it finds the file "tags.vim". | |
7 | 3503 |
1621 | 3504 float2nr({expr}) *float2nr()* |
3505 Convert {expr} to a Number by omitting the part after the | |
3506 decimal point. | |
3507 {expr} must evaluate to a |Float| or a Number. | |
3508 When the value of {expr} is out of range for a |Number| the | |
3509 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
3510 in -0x80000000. | |
3511 Examples: > | |
3512 echo float2nr(3.95) | |
3513 < 3 > | |
3514 echo float2nr(-23.45) | |
3515 < -23 > | |
3516 echo float2nr(1.0e100) | |
3517 < 2147483647 > | |
3518 echo float2nr(-1.0e150) | |
3519 < -2147483647 > | |
3520 echo float2nr(1.0e-100) | |
3521 < 0 | |
3522 {only available when compiled with the |+float| feature} | |
3523 | |
3524 | |
3525 floor({expr}) *floor()* | |
3526 Return the largest integral value less than or equal to | |
3527 {expr} as a |Float| (round down). | |
3528 {expr} must evaluate to a |Float| or a |Number|. | |
3529 Examples: > | |
3530 echo floor(1.856) | |
3531 < 1.0 > | |
3532 echo floor(-5.456) | |
3533 < -6.0 > | |
3534 echo floor(4.0) | |
3535 < 4.0 | |
3536 {only available when compiled with the |+float| feature} | |
3537 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3538 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3539 fmod({expr1}, {expr2}) *fmod()* |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3540 Return the remainder of {expr1} / {expr2}, even if the |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3541 division is not representable. Returns {expr1} - i * {expr2} |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3542 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
|
3543 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
|
3544 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
|
3545 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
|
3546 {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
|
3547 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3548 :echo fmod(12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3549 < 0.13 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3550 :echo fmod(-12.33, 1.22) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3551 < -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
|
3552 {only available when compiled with |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3553 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3554 |
1586 | 3555 fnameescape({string}) *fnameescape()* |
1621 | 3556 Escape {string} for use as file name command argument. All |
1586 | 3557 characters that have a special meaning, such as '%' and '|' |
3558 are escaped with a backslash. | |
1621 | 3559 For most systems the characters escaped are |
3560 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
3561 appears in a filename, it depends on the value of 'isfname'. | |
1700 | 3562 A leading '+' and '>' is also escaped (special after |:edit| |
3563 and |:write|). And a "-" by itself (special after |:cd|). | |
1586 | 3564 Example: > |
1700 | 3565 :let fname = '+some str%nge|name' |
1586 | 3566 :exe "edit " . fnameescape(fname) |
3567 < results in executing: > | |
1700 | 3568 edit \+some\ str\%nge\|name |
1586 | 3569 |
7 | 3570 fnamemodify({fname}, {mods}) *fnamemodify()* |
3571 Modify file name {fname} according to {mods}. {mods} is a | |
3572 string of characters like it is used for file names on the | |
3573 command line. See |filename-modifiers|. | |
3574 Example: > | |
3575 :echo fnamemodify("main.c", ":p:h") | |
3576 < results in: > | |
3577 /home/mool/vim/vim/src | |
1621 | 3578 < Note: Environment variables don't work in {fname}, use |
7 | 3579 |expand()| first then. |
3580 | |
3581 foldclosed({lnum}) *foldclosed()* | |
3582 The result is a Number. If the line {lnum} is in a closed | |
3583 fold, the result is the number of the first line in that fold. | |
3584 If the line {lnum} is not in a closed fold, -1 is returned. | |
3585 | |
3586 foldclosedend({lnum}) *foldclosedend()* | |
3587 The result is a Number. If the line {lnum} is in a closed | |
3588 fold, the result is the number of the last line in that fold. | |
3589 If the line {lnum} is not in a closed fold, -1 is returned. | |
3590 | |
3591 foldlevel({lnum}) *foldlevel()* | |
3592 The result is a Number, which is the foldlevel of line {lnum} | |
1621 | 3593 in the current buffer. For nested folds the deepest level is |
7 | 3594 returned. If there is no fold at line {lnum}, zero is |
3595 returned. It doesn't matter if the folds are open or closed. | |
3596 When used while updating folds (from 'foldexpr') -1 is | |
3597 returned for lines where folds are still to be updated and the | |
3598 foldlevel is unknown. As a special case the level of the | |
3599 previous line is usually available. | |
3600 | |
3601 *foldtext()* | |
3602 foldtext() Returns a String, to be displayed for a closed fold. This is | |
3603 the default function used for the 'foldtext' option and should | |
3604 only be called from evaluating 'foldtext'. It uses the | |
3605 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
3606 The returned string looks like this: > | |
3607 +-- 45 lines: abcdef | |
1621 | 3608 < The number of dashes depends on the foldlevel. The "45" is |
7 | 3609 the number of lines in the fold. "abcdef" is the text in the |
3610 first non-blank line of the fold. Leading white space, "//" | |
3611 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
3612 options is removed. | |
3613 {not available when compiled without the |+folding| feature} | |
3614 | |
29 | 3615 foldtextresult({lnum}) *foldtextresult()* |
3616 Returns the text that is displayed for the closed fold at line | |
3617 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
3618 When there is no closed fold at {lnum} an empty string is | |
3619 returned. | |
3620 {lnum} is used like with |getline()|. Thus "." is the current | |
3621 line, "'m" mark m, etc. | |
3622 Useful when exporting folded text, e.g., to HTML. | |
3623 {not available when compiled without the |+folding| feature} | |
3624 | |
7 | 3625 *foreground()* |
1621 | 3626 foreground() Move the Vim window to the foreground. Useful when sent from |
7 | 3627 a client to a Vim server. |remote_send()| |
3628 On Win32 systems this might not work, the OS does not always | |
3629 allow a window to bring itself to the foreground. Use | |
3630 |remote_foreground()| instead. | |
3631 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
3632 Win32 console version} | |
3633 | |
82 | 3634 |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3635 *function()* *E700* *E922* *E923* |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3636 function({name} [, {arglist}] [, {dict}]) |
685 | 3637 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
|
3638 {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
|
3639 internal function. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3640 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3641 {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
|
3642 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
|
3643 argument is not allowed. E.g.: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3644 let FuncWithArg = function(dict.Func, [arg]) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3645 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
|
3646 < |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3647 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
|
3648 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
|
3649 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
|
3650 |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3651 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
|
3652 arguments. Example: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3653 func Callback(arg1, arg2, name) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3654 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3655 let Func = function('Callback', ['one', 'two']) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3656 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3657 call Func('name') |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3658 < Invokes the function as with: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3659 call Callback('one', 'two', 'name') |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3660 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3661 < 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
|
3662 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
|
3663 arguments. Example: > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3664 func Callback(arg1, arg2, name) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3665 ... |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3666 let Func = function('Callback', ['one']) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3667 let Func2 = function(Func, ['two']) |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3668 ... |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3669 call Func2('name') |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3670 < Invokes the function as with: > |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3671 call Callback('one', 'two', 'name') |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3672 |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3673 < 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
|
3674 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
|
3675 function Callback() dict |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3676 echo "called for " . self.name |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3677 endfunction |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3678 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3679 let context = {"name": "example"} |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3680 let Func = function('Callback', context) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3681 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3682 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
|
3683 < 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
|
3684 arguments, these two are equivalent: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3685 let Func = function('Callback', context) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3686 let Func = context.Callback |
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3687 |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3688 < 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
|
3689 function Callback(arg1, count) dict |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3690 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3691 let context = {"name": "example"} |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3692 let Func = function('Callback', ['one'], context) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3693 ... |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3694 call Func(500) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3695 < Invokes the function as with: > |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3696 call context.Callback('one', 500) |
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3697 |
82 | 3698 |
3224 | 3699 garbagecollect([{atexit}]) *garbagecollect()* |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3700 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs| |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3701 that have circular references. |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3702 |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3703 There is hardly ever a need to invoke this function, as it is |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3704 automatically done when Vim runs out of memory or is waiting |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3705 for the user to press a key after 'updatetime'. Items without |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3706 circular references are always freed when they become unused. |
685 | 3707 This is useful if you have deleted a very big |List| and/or |
3708 |Dictionary| with circular references in a script that runs | |
3709 for a long time. | |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3710 |
3224 | 3711 When the optional {atexit} argument is one, garbage |
1405 | 3712 collection will also be done when exiting Vim, if it wasn't |
3713 done before. This is useful when checking for memory leaks. | |
370 | 3714 |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3715 garbagecollect_for_testing() *garbagecollect_for_testing()* |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3716 Like garbagecollect(), but executed right away. This must |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3717 only be called directly to avoid any structure to exist |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3718 internally, and |v:testing| must have been set before calling |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3719 any function. |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3720 |
140 | 3721 get({list}, {idx} [, {default}]) *get()* |
685 | 3722 Get item {idx} from |List| {list}. When this item is not |
82 | 3723 available return {default}. Return zero when {default} is |
3724 omitted. | |
102 | 3725 get({dict}, {key} [, {default}]) |
685 | 3726 Get item with key {key} from |Dictionary| {dict}. When this |
102 | 3727 item is not available return {default}. Return zero when |
3728 {default} is omitted. | |
3729 | |
435 | 3730 *getbufline()* |
3731 getbufline({expr}, {lnum} [, {end}]) | |
685 | 3732 Return a |List| with the lines starting from {lnum} to {end} |
3733 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
3734 |List| with only the line {lnum} is returned. | |
435 | 3735 |
3736 For the use of {expr}, see |bufname()| above. | |
3737 | |
448 | 3738 For {lnum} and {end} "$" can be used for the last line of the |
3739 buffer. Otherwise a number must be used. | |
435 | 3740 |
3741 When {lnum} is smaller than 1 or bigger than the number of | |
685 | 3742 lines in the buffer, an empty |List| is returned. |
435 | 3743 |
3744 When {end} is greater than the number of lines in the buffer, | |
3745 it is treated as {end} is set to the number of lines in the | |
685 | 3746 buffer. When {end} is before {lnum} an empty |List| is |
435 | 3747 returned. |
3748 | |
448 | 3749 This function works only for loaded buffers. For unloaded and |
685 | 3750 non-existing buffers, an empty |List| is returned. |
435 | 3751 |
3752 Example: > | |
3753 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
82 | 3754 |
4157 | 3755 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
82 | 3756 The result is the value of option or local buffer variable |
3757 {varname} in buffer {expr}. Note that the name without "b:" | |
3758 must be used. | |
1668 | 3759 When {varname} is empty returns a dictionary with all the |
3760 buffer-local variables. | |
216 | 3761 This also works for a global or buffer-local option, but it |
3762 doesn't work for a global variable, window-local variable or | |
3763 window-local option. | |
82 | 3764 For the use of {expr}, see |bufname()| above. |
4157 | 3765 When the buffer or variable doesn't exist {def} or an empty |
3766 string is returned, there is no error message. | |
82 | 3767 Examples: > |
3768 :let bufmodified = getbufvar(1, "&mod") | |
3769 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
3770 < | |
7 | 3771 getchar([expr]) *getchar()* |
867 | 3772 Get a single character from the user or input stream. |
7 | 3773 If [expr] is omitted, wait until a character is available. |
3774 If [expr] is 0, only get a character when one is available. | |
867 | 3775 Return zero otherwise. |
7 | 3776 If [expr] is 1, only check if a character is available, it is |
867 | 3777 not consumed. Return zero if no character available. |
3778 | |
5555 | 3779 Without [expr] and when [expr] is 0 a whole character or |
867 | 3780 special key is returned. If it is an 8-bit character, the |
3781 result is a number. Use nr2char() to convert it to a String. | |
3782 Otherwise a String is returned with the encoded character. | |
3783 For a special key it's a sequence of bytes starting with 0x80 | |
872 | 3784 (decimal: 128). This is the same value as the string |
3785 "\<Key>", e.g., "\<Left>". The returned value is also a | |
3786 String when a modifier (shift, control, alt) was used that is | |
3787 not included in the character. | |
867 | 3788 |
5968 | 3789 When [expr] is 0 and Esc is typed, there will be a short delay |
3790 while Vim waits to see if this is the start of an escape | |
3791 sequence. | |
3792 | |
5555 | 3793 When [expr] is 1 only the first byte is returned. For a |
872 | 3794 one-byte character it is the character itself as a number. |
3795 Use nr2char() to convert it to a String. | |
867 | 3796 |
3224 | 3797 Use getcharmod() to obtain any additional modifiers. |
3798 | |
1029 | 3799 When the user clicks a mouse button, the mouse event will be |
3800 returned. The position can then be found in |v:mouse_col|, | |
3801 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
3802 mouse as it would normally happen: > | |
3803 let c = getchar() | |
1621 | 3804 if c == "\<LeftMouse>" && v:mouse_win > 0 |
1029 | 3805 exe v:mouse_win . "wincmd w" |
3806 exe v:mouse_lnum | |
3807 exe "normal " . v:mouse_col . "|" | |
3808 endif | |
3809 < | |
7 | 3810 There is no prompt, you will somehow have to make clear to the |
3811 user that a character has to be typed. | |
3812 There is no mapping for the character. | |
3813 Key codes are replaced, thus when the user presses the <Del> | |
3814 key you get the code for the <Del> key, not the raw character | |
3815 sequence. Examples: > | |
3816 getchar() == "\<Del>" | |
3817 getchar() == "\<S-Left>" | |
3818 < This example redefines "f" to ignore case: > | |
3819 :nmap f :call FindChar()<CR> | |
3820 :function FindChar() | |
3821 : let c = nr2char(getchar()) | |
3822 : while col('.') < col('$') - 1 | |
3823 : normal l | |
3824 : if getline('.')[col('.') - 1] ==? c | |
3825 : break | |
3826 : endif | |
3827 : endwhile | |
3828 :endfunction | |
6421 | 3829 < |
6647 | 3830 You may also receive synthetic characters, such as |
6421 | 3831 |<CursorHold>|. Often you will want to ignore this and get |
3832 another character: > | |
3833 :function GetKey() | |
3834 : let c = getchar() | |
3835 : while c == "\<CursorHold>" | |
3836 : let c = getchar() | |
3837 : endwhile | |
3838 : return c | |
3839 :endfunction | |
7 | 3840 |
3841 getcharmod() *getcharmod()* | |
3842 The result is a Number which is the state of the modifiers for | |
3843 the last obtained character with getchar() or in another way. | |
3844 These values are added together: | |
3845 2 shift | |
3846 4 control | |
3847 8 alt (meta) | |
3224 | 3848 16 meta (when it's different from ALT) |
3849 32 mouse double click | |
3850 64 mouse triple click | |
3851 96 mouse quadruple click (== 32 + 64) | |
3852 128 command (Macintosh only) | |
7 | 3853 Only the modifiers that have not been included in the |
1621 | 3854 character itself are obtained. Thus Shift-a results in "A" |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3855 without a modifier. |
7 | 3856 |
6991 | 3857 getcharsearch() *getcharsearch()* |
3858 Return the current character search information as a {dict} | |
3859 with the following entries: | |
3860 | |
3861 char character previously used for a character | |
3862 search (|t|, |f|, |T|, or |F|); empty string | |
3863 if no character search has been performed | |
3864 forward direction of character search; 1 for forward, | |
3865 0 for backward | |
3866 until type of character search; 1 for a |t| or |T| | |
3867 character search, 0 for an |f| or |F| | |
3868 character search | |
3869 | |
3870 This can be useful to always have |;| and |,| search | |
3871 forward/backward regardless of the direction of the previous | |
3872 character search: > | |
3873 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
3874 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
3875 < Also see |setcharsearch()|. | |
3876 | |
7 | 3877 getcmdline() *getcmdline()* |
3878 Return the current command-line. Only works when the command | |
3879 line is being edited, thus requires use of |c_CTRL-\_e| or | |
3880 |c_CTRL-R_=|. | |
3881 Example: > | |
3882 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
531 | 3883 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
7 | 3884 |
95 | 3885 getcmdpos() *getcmdpos()* |
7 | 3886 Return the position of the cursor in the command line as a |
3887 byte count. The first column is 1. | |
3888 Only works when editing the command line, thus requires use of | |
3456 | 3889 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3890 Returns 0 otherwise. | |
531 | 3891 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
3892 | |
3893 getcmdtype() *getcmdtype()* | |
3894 Return the current command-line type. Possible return values | |
3895 are: | |
532 | 3896 : normal Ex command |
3897 > debug mode command |debug-mode| | |
3898 / forward search command | |
3899 ? backward search command | |
3900 @ |input()| command | |
3901 - |:insert| or |:append| command | |
6213 | 3902 = |i_CTRL-R_=| |
531 | 3903 Only works when editing the command line, thus requires use of |
3456 | 3904 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
3905 Returns an empty string otherwise. | |
531 | 3906 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
7 | 3907 |
6153 | 3908 getcmdwintype() *getcmdwintype()* |
3909 Return the current |command-line-window| type. Possible return | |
3910 values are the same as |getcmdtype()|. Returns an empty string | |
3911 when not in the command-line window. | |
3912 | |
5944 | 3913 *getcurpos()* |
3914 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
3915 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
|
3916 [bufnum, lnum, col, off, curswant] ~ |
5944 | 3917 The "curswant" number is the preferred column when moving the |
3918 cursor vertically. | |
3919 This can be used to save and restore the cursor position: > | |
3920 let save_cursor = getcurpos() | |
3921 MoveTheCursorAround | |
3922 call setpos('.', save_cursor) | |
6153 | 3923 < |
7 | 3924 *getcwd()* |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3925 getcwd([{winnr} [, {tabnr}]]) |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3926 The result is a String, which is the name of the current |
7 | 3927 working directory. |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3928 Without arguments, for the current window. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3929 |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3930 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
|
3931 in the current tab page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3932 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
|
3933 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
|
3934 Return an empty string if the arguments are invalid. |
7 | 3935 |
3936 getfsize({fname}) *getfsize()* | |
3937 The result is a Number, which is the size in bytes of the | |
3938 given file {fname}. | |
3939 If {fname} is a directory, 0 is returned. | |
3940 If the file {fname} can't be found, -1 is returned. | |
1293 | 3941 If the size of {fname} is too big to fit in a Number then -2 |
3942 is returned. | |
7 | 3943 |
37 | 3944 getfontname([{name}]) *getfontname()* |
3945 Without an argument returns the name of the normal font being | |
3946 used. Like what is used for the Normal highlight group | |
3947 |hl-Normal|. | |
3948 With an argument a check is done whether {name} is a valid | |
3949 font name. If not then an empty string is returned. | |
3950 Otherwise the actual font name is returned, or {name} if the | |
3951 GUI does not support obtaining the real name. | |
824 | 3952 Only works when the GUI is running, thus not in your vimrc or |
819 | 3953 gvimrc file. Use the |GUIEnter| autocommand to use this |
3954 function just after the GUI has started. | |
37 | 3955 Note that the GTK 2 GUI accepts any font name, thus checking |
3956 for a valid name does not work. | |
3957 | |
20 | 3958 getfperm({fname}) *getfperm()* |
3959 The result is a String, which is the read, write, and execute | |
3960 permissions of the given file {fname}. | |
3961 If {fname} does not exist or its directory cannot be read, an | |
3962 empty string is returned. | |
3963 The result is of the form "rwxrwxrwx", where each group of | |
3964 "rwx" flags represent, in turn, the permissions of the owner | |
3965 of the file, the group the file belongs to, and other users. | |
3966 If a user does not have a given permission the flag for this | |
3750 | 3967 is replaced with the string "-". Examples: > |
20 | 3968 :echo getfperm("/etc/passwd") |
3750 | 3969 :echo getfperm(expand("~/.vimrc")) |
20 | 3970 < This will hopefully (from a security point of view) display |
3971 the string "rw-r--r--" or even "rw-------". | |
205 | 3972 |
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
3973 For setting permissins use |setfperm()|. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
3974 |
7 | 3975 getftime({fname}) *getftime()* |
3976 The result is a Number, which is the last modification time of | |
3977 the given file {fname}. The value is measured as seconds | |
3978 since 1st Jan 1970, and may be passed to strftime(). See also | |
3979 |localtime()| and |strftime()|. | |
3980 If the file {fname} can't be found -1 is returned. | |
3981 | |
20 | 3982 getftype({fname}) *getftype()* |
3983 The result is a String, which is a description of the kind of | |
3984 file of the given file {fname}. | |
3985 If {fname} does not exist an empty string is returned. | |
3986 Here is a table over different kinds of files and their | |
3987 results: | |
3988 Normal file "file" | |
3989 Directory "dir" | |
3990 Symbolic link "link" | |
3991 Block device "bdev" | |
3992 Character device "cdev" | |
3993 Socket "socket" | |
3994 FIFO "fifo" | |
3995 All other "other" | |
3996 Example: > | |
3997 getftype("/home") | |
3998 < Note that a type such as "link" will only be returned on | |
3999 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
|
4000 "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
|
4001 directory returns "dir" instead of "link". |
20 | 4002 |
7 | 4003 *getline()* |
82 | 4004 getline({lnum} [, {end}]) |
4005 Without {end} the result is a String, which is line {lnum} | |
4006 from the current buffer. Example: > | |
7 | 4007 getline(1) |
4008 < When {lnum} is a String that doesn't start with a | |
4009 digit, line() is called to translate the String into a Number. | |
4010 To get the line under the cursor: > | |
4011 getline(".") | |
4012 < When {lnum} is smaller than 1 or bigger than the number of | |
4013 lines in the buffer, an empty string is returned. | |
4014 | |
685 | 4015 When {end} is given the result is a |List| where each item is |
4016 a line from the current buffer in the range {lnum} to {end}, | |
82 | 4017 including line {end}. |
4018 {end} is used in the same way as {lnum}. | |
4019 Non-existing lines are silently omitted. | |
685 | 4020 When {end} is before {lnum} an empty |List| is returned. |
82 | 4021 Example: > |
4022 :let start = line('.') | |
4023 :let end = search("^$") - 1 | |
4024 :let lines = getline(start, end) | |
4025 | |
1156 | 4026 < To get lines from another buffer see |getbufline()| |
4027 | |
647 | 4028 getloclist({nr}) *getloclist()* |
4029 Returns a list with all the entries in the location list for | |
4030 window {nr}. When {nr} is zero the current window is used. | |
4031 For a location list window, the displayed location list is | |
648 | 4032 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
|
4033 returned. Otherwise, same as |getqflist()|. |
82 | 4034 |
1326 | 4035 getmatches() *getmatches()* |
4036 Returns a |List| with all matches previously defined by | |
4037 |matchadd()| and the |:match| commands. |getmatches()| is | |
4038 useful in combination with |setmatches()|, as |setmatches()| | |
4039 can restore a list of matches saved by |getmatches()|. | |
4040 Example: > | |
4041 :echo getmatches() | |
4042 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
4043 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
4044 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
4045 :let m = getmatches() | |
4046 :call clearmatches() | |
4047 :echo getmatches() | |
4048 < [] > | |
4049 :call setmatches(m) | |
4050 :echo getmatches() | |
4051 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
4052 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
4053 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
4054 :unlet m | |
4055 < | |
5968 | 4056 *getpid()* |
4057 getpid() Return a Number which is the process ID of the Vim process. | |
4058 On Unix and MS-Windows this is a unique number, until Vim | |
4059 exits. On MS-DOS it's always zero. | |
4060 | |
4061 *getpos()* | |
4062 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
4063 see |line()|. For getting the cursor position see | |
4064 |getcurpos()|. | |
4065 The result is a |List| with four numbers: | |
4066 [bufnum, lnum, col, off] | |
4067 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
4068 is the buffer number of the mark. | |
4069 "lnum" and "col" are the position in the buffer. The first | |
4070 column is 1. | |
4071 The "off" number is zero, unless 'virtualedit' is used. Then | |
4072 it is the offset in screen columns from the start of the | |
4073 character. E.g., a position within a <Tab> or after the last | |
4074 character. | |
4075 Note that for '< and '> Visual mode matters: when it is "V" | |
4076 (visual line mode) the column of '< is zero and the column of | |
4077 '> is a large number. | |
4078 This can be used to save and restore the position of a mark: > | |
4079 let save_a_mark = getpos("'a") | |
4080 ... | |
6421 | 4081 call setpos("'a", save_a_mark) |
5968 | 4082 < Also see |getcurpos()| and |setpos()|. |
4083 | |
1326 | 4084 |
230 | 4085 getqflist() *getqflist()* |
4086 Returns a list with all the current quickfix errors. Each | |
4087 list item is a dictionary with these entries: | |
4088 bufnr number of buffer that has the file name, use | |
4089 bufname() to get the name | |
4090 lnum line number in the buffer (first line is 1) | |
4091 col column number (first column is 1) | |
233 | 4092 vcol non-zero: "col" is visual column |
4093 zero: "col" is byte index | |
230 | 4094 nr error number |
1065 | 4095 pattern search pattern used to locate the error |
230 | 4096 text description of the error |
4097 type type of the error, 'E', '1', etc. | |
4098 valid non-zero: recognized error message | |
4099 | |
515 | 4100 When there is no error list or it's empty an empty list is |
1065 | 4101 returned. Quickfix list entries with non-existing buffer |
4102 number are returned with "bufnr" set to zero. | |
515 | 4103 |
230 | 4104 Useful application: Find pattern matches in multiple files and |
4105 do something with them: > | |
4106 :vimgrep /theword/jg *.c | |
4107 :for d in getqflist() | |
4108 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
4109 :endfor | |
4110 | |
4111 | |
5796 | 4112 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
7 | 4113 The result is a String, which is the contents of register |
236 | 4114 {regname}. Example: > |
7 | 4115 :let cliptext = getreg('*') |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4116 < When {regname} was not set the result is a empty string. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4117 |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4118 getreg('=') returns the last evaluated value of the expression |
236 | 4119 register. (For use in maps.) |
282 | 4120 getreg('=', 1) returns the expression itself, so that it can |
4121 be restored with |setreg()|. For other registers the extra | |
4122 argument is ignored, thus you can always give it. | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4123 |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4124 If {list} is present and non-zero, the result type is changed |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4125 to |List|. Each list item is one text line. Use it if you care |
5796 | 4126 about zero bytes possibly present inside register: without |
4127 third argument both NLs and zero bytes are represented as NLs | |
4128 (see |NL-used-for-Nul|). | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4129 When the register was not set an empty list is returned. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4130 |
7 | 4131 If {regname} is not specified, |v:register| is used. |
4132 | |
82 | 4133 |
7 | 4134 getregtype([{regname}]) *getregtype()* |
4135 The result is a String, which is type of register {regname}. | |
4136 The value will be one of: | |
4137 "v" for |characterwise| text | |
4138 "V" for |linewise| text | |
4139 "<CTRL-V>{width}" for |blockwise-visual| text | |
5596 | 4140 "" for an empty or unknown register |
7 | 4141 <CTRL-V> is one character with value 0x16. |
4142 If {regname} is not specified, |v:register| is used. | |
4143 | |
4157 | 4144 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4145 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
|
4146 {tabnr}. |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4147 Tabs are numbered starting with one. |
6197 | 4148 When {varname} is empty a dictionary with all tab-local |
4149 variables is returned. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4150 Note that the name without "t:" must be used. |
4157 | 4151 When the tab or variable doesn't exist {def} or an empty |
4152 string is returned, there is no error message. | |
4153 | |
4154 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
1156 | 4155 Get the value of window-local variable {varname} in window |
4156 {winnr} in tab page {tabnr}. | |
4157 When {varname} starts with "&" get the value of a window-local | |
4158 option. | |
4157 | 4159 When {varname} is empty a dictionary with all window-local |
4160 variables is returned. | |
4161 Note that {varname} must be the name without "w:". | |
831 | 4162 Tabs are numbered starting with one. For the current tabpage |
4163 use |getwinvar()|. | |
4164 When {winnr} is zero the current window is used. | |
4165 This also works for a global option, buffer-local option and | |
4166 window-local option, but it doesn't work for a global variable | |
4167 or buffer-local variable. | |
4157 | 4168 When the tab, window or variable doesn't exist {def} or an |
4169 empty string is returned, there is no error message. | |
831 | 4170 Examples: > |
4171 :let list_is_on = gettabwinvar(1, 2, '&list') | |
4172 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
1266 | 4173 < |
7 | 4174 *getwinposx()* |
4175 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
4176 the left hand side of the GUI Vim window. The result will be | |
4177 -1 if the information is not available. | |
4178 | |
4179 *getwinposy()* | |
4180 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
1621 | 4181 the top of the GUI Vim window. The result will be -1 if the |
7 | 4182 information is not available. |
4183 | |
4157 | 4184 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
831 | 4185 Like |gettabwinvar()| for the current tabpage. |
7 | 4186 Examples: > |
4187 :let list_is_on = getwinvar(2, '&list') | |
4188 :echo "myvar = " . getwinvar(1, 'myvar') | |
4189 < | |
6663 | 4190 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
1754 | 4191 Expand the file wildcards in {expr}. See |wildcards| for the |
1156 | 4192 use of special characters. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4193 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4194 Unless the optional {nosuf} argument is given and is non-zero, |
1754 | 4195 the 'suffixes' and 'wildignore' options apply: Names matching |
4196 one of the patterns in 'wildignore' will be skipped and | |
4197 'suffixes' affect the ordering of matches. | |
2662 | 4198 'wildignorecase' always applies. |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4199 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4200 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
|
4201 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
|
4202 you also get filenames containing newlines correctly. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4203 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
|
4204 matches, they are separated by <NL> characters. |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4205 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4206 If the expansion fails, the result is an empty String or List. |
6663 | 4207 |
3445 | 4208 A name for a non-existing file is not included. A symbolic |
4209 link is only included if it points to an existing file. | |
6663 | 4210 However, when the {alllinks} argument is present and it is |
4211 non-zero then all symbolic links are included. | |
7 | 4212 |
4213 For most systems backticks can be used to get files names from | |
4214 any external command. Example: > | |
4215 :let tagfiles = glob("`find . -name tags -print`") | |
4216 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
4217 < The result of the program inside the backticks should be one | |
1621 | 4218 item per line. Spaces inside an item are allowed. |
7 | 4219 |
4220 See |expand()| for expanding special Vim variables. See | |
4221 |system()| for getting the raw output of an external command. | |
4222 | |
6697 | 4223 glob2regpat({expr}) *glob2regpat()* |
4224 Convert a file pattern, as used by glob(), into a search | |
4225 pattern. The result can be used to match with a string that | |
4226 is a file name. E.g. > | |
4227 if filename =~ glob2regpat('Make*.mak') | |
4228 < This is equivalent to: > | |
4229 if filename =~ '^Make.*\.mak$' | |
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4230 < 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
|
4231 empty string. |
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4232 |
6663 | 4233 *globpath()* |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4234 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
7 | 4235 Perform glob() on all directories in {path} and concatenate |
4236 the results. Example: > | |
4237 :echo globpath(&rtp, "syntax/c.vim") | |
5873 | 4238 < |
4239 {path} is a comma-separated list of directory names. Each | |
7 | 4240 directory name is prepended to {expr} and expanded like with |
1754 | 4241 |glob()|. A path separator is inserted when needed. |
7 | 4242 To add a comma inside a directory name escape it with a |
4243 backslash. Note that on MS-Windows a directory may have a | |
4244 trailing backslash, remove it if you put a comma after it. | |
4245 If the expansion fails for one of the directories, there is no | |
4246 error message. | |
5873 | 4247 |
4248 Unless the optional {nosuf} argument is given and is non-zero, | |
1754 | 4249 the 'suffixes' and 'wildignore' options apply: Names matching |
4250 one of the patterns in 'wildignore' will be skipped and | |
4251 'suffixes' affect the ordering of matches. | |
7 | 4252 |
5873 | 4253 When {list} is present and it is non-zero the result is a List |
4254 with all matching files. The advantage of using a List is, you | |
4255 also get filenames containing newlines correctly. Otherwise | |
4256 the result is a String and when there are several matches, | |
4257 they are separated by <NL> characters. Example: > | |
4258 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
4259 < | |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4260 {alllinks} is used as with |glob()|. |
6663 | 4261 |
444 | 4262 The "**" item can be used to search in a directory tree. |
4263 For example, to find all "README.txt" files in the directories | |
4264 in 'runtimepath' and below: > | |
4265 :echo globpath(&rtp, "**/README.txt") | |
1668 | 4266 < Upwards search and limiting the depth of "**" is not |
4267 supported, thus using 'path' will not always work properly. | |
4268 | |
7 | 4269 *has()* |
4270 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
4271 supported, zero otherwise. The {feature} argument is a | |
4272 string. See |feature-list| below. | |
4273 Also see |exists()|. | |
4274 | |
102 | 4275 |
4276 has_key({dict}, {key}) *has_key()* | |
685 | 4277 The result is a Number, which is 1 if |Dictionary| {dict} has |
4278 an entry with key {key}. Zero otherwise. | |
102 | 4279 |
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4280 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4281 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
|
4282 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
|
4283 |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4284 Without arguments use the current window. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4285 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
|
4286 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
|
4287 page. |
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4288 Return 0 if the arguments are invalid. |
102 | 4289 |
782 | 4290 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
7 | 4291 The result is a Number, which is 1 if there is a mapping that |
4292 contains {what} in somewhere in the rhs (what it is mapped to) | |
4293 and this mapping exists in one of the modes indicated by | |
4294 {mode}. | |
782 | 4295 When {abbr} is there and it is non-zero use abbreviations |
786 | 4296 instead of mappings. Don't forget to specify Insert and/or |
4297 Command-line mode. | |
7 | 4298 Both the global mappings and the mappings local to the current |
4299 buffer are checked for a match. | |
4300 If no matching mapping is found 0 is returned. | |
4301 The following characters are recognized in {mode}: | |
4302 n Normal mode | |
4303 v Visual mode | |
4304 o Operator-pending mode | |
4305 i Insert mode | |
4306 l Language-Argument ("r", "f", "t", etc.) | |
4307 c Command-line mode | |
4308 When {mode} is omitted, "nvo" is used. | |
4309 | |
4310 This function is useful to check if a mapping already exists | |
1621 | 4311 to a function in a Vim script. Example: > |
7 | 4312 :if !hasmapto('\ABCdoit') |
4313 : map <Leader>d \ABCdoit | |
4314 :endif | |
4315 < This installs the mapping to "\ABCdoit" only if there isn't | |
4316 already a mapping to "\ABCdoit". | |
4317 | |
4318 histadd({history}, {item}) *histadd()* | |
4319 Add the String {item} to the history {history} which can be | |
4320 one of: *hist-names* | |
4321 "cmd" or ":" command line history | |
4322 "search" or "/" search pattern history | |
1621 | 4323 "expr" or "=" typed expression history |
7 | 4324 "input" or "@" input line history |
3682 | 4325 "debug" or ">" debug command history |
4326 The {history} string does not need to be the whole name, one | |
4327 character is sufficient. | |
7 | 4328 If {item} does already exist in the history, it will be |
4329 shifted to become the newest entry. | |
4330 The result is a Number: 1 if the operation was successful, | |
4331 otherwise 0 is returned. | |
4332 | |
4333 Example: > | |
4334 :call histadd("input", strftime("%Y %b %d")) | |
4335 :let date=input("Enter date: ") | |
4336 < This function is not available in the |sandbox|. | |
4337 | |
4338 histdel({history} [, {item}]) *histdel()* | |
236 | 4339 Clear {history}, i.e. delete all its entries. See |hist-names| |
7 | 4340 for the possible values of {history}. |
4341 | |
1668 | 4342 If the parameter {item} evaluates to a String, it is used as a |
4343 regular expression. All entries matching that expression will | |
4344 be removed from the history (if there are any). | |
7 | 4345 Upper/lowercase must match, unless "\c" is used |/\c|. |
1668 | 4346 If {item} evaluates to a Number, it will be interpreted as |
4347 an index, see |:history-indexing|. The respective entry will | |
4348 be removed if it exists. | |
7 | 4349 |
4350 The result is a Number: 1 for a successful operation, | |
4351 otherwise 0 is returned. | |
4352 | |
4353 Examples: | |
4354 Clear expression register history: > | |
4355 :call histdel("expr") | |
4356 < | |
4357 Remove all entries starting with "*" from the search history: > | |
4358 :call histdel("/", '^\*') | |
4359 < | |
4360 The following three are equivalent: > | |
4361 :call histdel("search", histnr("search")) | |
4362 :call histdel("search", -1) | |
4363 :call histdel("search", '^'.histget("search", -1).'$') | |
4364 < | |
4365 To delete the last search pattern and use the last-but-one for | |
4366 the "n" command and 'hlsearch': > | |
4367 :call histdel("search", -1) | |
4368 :let @/ = histget("search", -1) | |
4369 | |
4370 histget({history} [, {index}]) *histget()* | |
4371 The result is a String, the entry with Number {index} from | |
4372 {history}. See |hist-names| for the possible values of | |
4373 {history}, and |:history-indexing| for {index}. If there is | |
4374 no such entry, an empty String is returned. When {index} is | |
4375 omitted, the most recent item from the history is used. | |
4376 | |
4377 Examples: | |
4378 Redo the second last search from history. > | |
4379 :execute '/' . histget("search", -2) | |
4380 | |
4381 < Define an Ex command ":H {num}" that supports re-execution of | |
4382 the {num}th entry from the output of |:history|. > | |
4383 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
4384 < | |
4385 histnr({history}) *histnr()* | |
4386 The result is the Number of the current entry in {history}. | |
4387 See |hist-names| for the possible values of {history}. | |
4388 If an error occurred, -1 is returned. | |
4389 | |
4390 Example: > | |
4391 :let inp_index = histnr("expr") | |
4392 < | |
4393 hlexists({name}) *hlexists()* | |
4394 The result is a Number, which is non-zero if a highlight group | |
4395 called {name} exists. This is when the group has been | |
4396 defined in some way. Not necessarily when highlighting has | |
4397 been defined for it, it may also have been used for a syntax | |
4398 item. | |
4399 *highlight_exists()* | |
4400 Obsolete name: highlight_exists(). | |
4401 | |
4402 *hlID()* | |
4403 hlID({name}) The result is a Number, which is the ID of the highlight group | |
4404 with name {name}. When the highlight group doesn't exist, | |
4405 zero is returned. | |
4406 This can be used to retrieve information about the highlight | |
1621 | 4407 group. For example, to get the background color of the |
7 | 4408 "Comment" group: > |
4409 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
4410 < *highlightID()* | |
4411 Obsolete name: highlightID(). | |
4412 | |
4413 hostname() *hostname()* | |
4414 The result is a String, which is the name of the machine on | |
236 | 4415 which Vim is currently running. Machine names greater than |
7 | 4416 256 characters long are truncated. |
4417 | |
4418 iconv({expr}, {from}, {to}) *iconv()* | |
4419 The result is a String, which is the text {expr} converted | |
4420 from encoding {from} to encoding {to}. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4421 When the conversion completely fails an empty string is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4422 returned. When some characters could not be converted they |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4423 are replaced with "?". |
7 | 4424 The encoding names are whatever the iconv() library function |
4425 can accept, see ":!man 3 iconv". | |
4426 Most conversions require Vim to be compiled with the |+iconv| | |
4427 feature. Otherwise only UTF-8 to latin1 conversion and back | |
4428 can be done. | |
4429 This can be used to display messages with special characters, | |
4430 no matter what 'encoding' is set to. Write the message in | |
4431 UTF-8 and use: > | |
4432 echo iconv(utf8_str, "utf-8", &enc) | |
4433 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
4434 from/to UCS-2 is automatically changed to use UTF-8. You | |
4435 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
|
4436 {only available when compiled with the |+multi_byte| feature} |
7 | 4437 |
4438 *indent()* | |
4439 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
4440 current buffer. The indent is counted in spaces, the value | |
4441 of 'tabstop' is relevant. {lnum} is used just like in | |
4442 |getline()|. | |
4443 When {lnum} is invalid -1 is returned. | |
4444 | |
79 | 4445 |
95 | 4446 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
685 | 4447 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
|
4448 value equal to {expr}. There is no automatic conversion, so |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4449 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
|
4450 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
|
4451 is not used here, case always matters. |
153 | 4452 If {start} is given then start looking at the item with index |
4453 {start} (may be negative for an item relative to the end). | |
79 | 4454 When {ic} is given and it is non-zero, ignore case. Otherwise |
4455 case must match. | |
4456 -1 is returned when {expr} is not found in {list}. | |
4457 Example: > | |
4458 :let idx = index(words, "the") | |
87 | 4459 :if index(numbers, 123) >= 0 |
79 | 4460 |
4461 | |
531 | 4462 input({prompt} [, {text} [, {completion}]]) *input()* |
7 | 4463 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
|
4464 the command-line. The {prompt} argument is either a prompt |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4465 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
|
4466 in the prompt to start a new line. |
531 | 4467 The highlighting set with |:echohl| is used for the prompt. |
4468 The input is entered just like a command-line, with the same | |
1621 | 4469 editing commands and mappings. There is a separate history |
531 | 4470 for lines typed for input(). |
4471 Example: > | |
4472 :if input("Coffee or beer? ") == "beer" | |
4473 : echo "Cheers!" | |
4474 :endif | |
4475 < | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4476 If the optional {text} argument is present and not empty, this |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4477 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
|
4478 Example: > |
531 | 4479 :let color = input("Color? ", "white") |
4480 | |
4481 < The optional {completion} argument specifies the type of | |
4482 completion supported for the input. Without it completion is | |
1621 | 4483 not performed. The supported completion types are the same as |
531 | 4484 that can be supplied to a user-defined command using the |
1621 | 4485 "-complete=" argument. Refer to |:command-completion| for |
531 | 4486 more information. Example: > |
4487 let fname = input("File: ", "", "file") | |
4488 < | |
4489 NOTE: This function must not be used in a startup file, for | |
4490 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
7 | 4491 Note: When input() is called from within a mapping it will |
4492 consume remaining characters from that mapping, because a | |
4493 mapping is handled like the characters were typed. | |
4494 Use |inputsave()| before input() and |inputrestore()| | |
4495 after input() to avoid that. Another solution is to avoid | |
4496 that further characters follow in the mapping, e.g., by using | |
4497 |:execute| or |:normal|. | |
4498 | |
531 | 4499 Example with a mapping: > |
7 | 4500 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
4501 :function GetFoo() | |
4502 : call inputsave() | |
4503 : let g:Foo = input("enter search pattern: ") | |
4504 : call inputrestore() | |
4505 :endfunction | |
4506 | |
4507 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4508 Like |input()|, but when the GUI is running and text dialogs |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4509 are supported, a dialog window pops up to input the text. |
7 | 4510 Example: > |
3875 | 4511 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
4512 :if n != "" | |
4513 : let &sw = n | |
4514 :endif | |
7 | 4515 < When the dialog is cancelled {cancelreturn} is returned. When |
4516 omitted an empty string is returned. | |
4517 Hitting <Enter> works like pressing the OK button. Hitting | |
4518 <Esc> works like pressing the Cancel button. | |
531 | 4519 NOTE: Command-line completion is not supported. |
7 | 4520 |
519 | 4521 inputlist({textlist}) *inputlist()* |
819 | 4522 {textlist} must be a |List| of strings. This |List| is |
4523 displayed, one string per line. The user will be prompted to | |
4524 enter a number, which is returned. | |
519 | 4525 The user can also select an item by clicking on it with the |
1621 | 4526 mouse. For the first string 0 is returned. When clicking |
519 | 4527 above the first item a negative number is returned. When |
4528 clicking on the prompt one more than the length of {textlist} | |
4529 is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4530 Make sure {textlist} has less than 'lines' entries, otherwise |
1621 | 4531 it won't work. It's a good idea to put the entry number at |
1156 | 4532 the start of the string. And put a prompt in the first item. |
4533 Example: > | |
519 | 4534 let color = inputlist(['Select color:', '1. red', |
4535 \ '2. green', '3. blue']) | |
4536 | |
7 | 4537 inputrestore() *inputrestore()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4538 Restore typeahead that was saved with a previous |inputsave()|. |
7 | 4539 Should be called the same number of times inputsave() is |
4540 called. Calling it more often is harmless though. | |
4541 Returns 1 when there is nothing to restore, 0 otherwise. | |
4542 | |
4543 inputsave() *inputsave()* | |
4544 Preserve typeahead (also from mappings) and clear it, so that | |
4545 a following prompt gets input from the user. Should be | |
4546 followed by a matching inputrestore() after the prompt. Can | |
4547 be used several times, in which case there must be just as | |
4548 many inputrestore() calls. | |
4549 Returns 1 when out of memory, 0 otherwise. | |
4550 | |
4551 inputsecret({prompt} [, {text}]) *inputsecret()* | |
4552 This function acts much like the |input()| function with but | |
4553 two exceptions: | |
4554 a) the user's response will be displayed as a sequence of | |
4555 asterisks ("*") thereby keeping the entry secret, and | |
4556 b) the user's response will not be recorded on the input | |
4557 |history| stack. | |
4558 The result is a String, which is whatever the user actually | |
4559 typed on the command-line in response to the issued prompt. | |
531 | 4560 NOTE: Command-line completion is not supported. |
7 | 4561 |
55 | 4562 insert({list}, {item} [, {idx}]) *insert()* |
685 | 4563 Insert {item} at the start of |List| {list}. |
55 | 4564 If {idx} is specified insert {item} before the item with index |
1621 | 4565 {idx}. If {idx} is zero it goes before the first item, just |
55 | 4566 like omitting {idx}. A negative {idx} is also possible, see |
4567 |list-index|. -1 inserts just before the last item. | |
685 | 4568 Returns the resulting |List|. Examples: > |
55 | 4569 :let mylist = insert([2, 3, 5], 1) |
4570 :call insert(mylist, 4, -1) | |
4571 :call insert(mylist, 6, len(mylist)) | |
82 | 4572 < The last example can be done simpler with |add()|. |
685 | 4573 Note that when {item} is a |List| it is inserted as a single |
692 | 4574 item. Use |extend()| to concatenate |Lists|. |
55 | 4575 |
3214 | 4576 invert({expr}) *invert()* |
4577 Bitwise invert. The argument is converted to a number. A | |
4578 List, Dict or Float argument causes an error. Example: > | |
4579 :let bits = invert(bits) | |
4580 | |
7 | 4581 isdirectory({directory}) *isdirectory()* |
4582 The result is a Number, which is non-zero when a directory | |
4583 with the name {directory} exists. If {directory} doesn't | |
4584 exist, or isn't a directory, the result is FALSE. {directory} | |
4585 is any expression, which is used as a String. | |
4586 | |
819 | 4587 islocked({expr}) *islocked()* *E786* |
148 | 4588 The result is a Number, which is non-zero when {expr} is the |
4589 name of a locked variable. | |
685 | 4590 {expr} must be the name of a variable, |List| item or |
4591 |Dictionary| entry, not the variable itself! Example: > | |
148 | 4592 :let alist = [0, ['a', 'b'], 2, 3] |
4593 :lockvar 1 alist | |
4594 :echo islocked('alist') " 1 | |
4595 :echo islocked('alist[1]') " 0 | |
4596 | |
4597 < When {expr} is a variable that does not exist you get an error | |
843 | 4598 message. Use |exists()| to check for existence. |
148 | 4599 |
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4600 isnan({expr}) *isnan()* |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4601 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
|
4602 echo isnan(0.0 / 0.0) |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4603 < 1 ~ |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4604 |
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
4605 {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
|
4606 |
140 | 4607 items({dict}) *items()* |
685 | 4608 Return a |List| with all the key-value pairs of {dict}. Each |
4609 |List| item is a list with two items: the key of a {dict} | |
4610 entry and the value of this entry. The |List| is in arbitrary | |
4611 order. | |
140 | 4612 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4613 job_getchannel({job}) *job_getchannel()* |
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4614 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
|
4615 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
|
4616 if string(job_getchannel()) == 'channel fail' |
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
4617 < |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4618 {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
|
4619 |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4620 job_info({job}) *job_info()* |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4621 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
|
4622 "status" what |job_status()| returns |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4623 "channel" what |job_getchannel()| returns |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4624 "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
|
4625 "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
|
4626 "stoponexit" |job-stoponexit| |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
4627 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4628 job_setoptions({job}, {options}) *job_setoptions()* |
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4629 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
|
4630 "stoponexit" |job-stoponexit| |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4631 "exit_cb" |job-exit_cb| |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4632 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
4633 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
|
4634 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
|
4635 |:!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
|
4636 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4637 {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
|
4638 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
|
4639 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
|
4640 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4641 {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
|
4642 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
|
4643 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
|
4644 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4645 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
|
4646 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
|
4647 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4648 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
|
4649 '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
|
4650 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
|
4651 < Or: > |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4652 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
|
4653 < 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
|
4654 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
|
4655 shell command. |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4656 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4657 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
|
4658 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
|
4659 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4660 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
|
4661 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
|
4662 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
|
4663 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
|
4664 < |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4665 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
|
4666 |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
|
4667 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4668 {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
|
4669 items, see |job-options|. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4670 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4671 {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
|
4672 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4673 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
|
4674 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
|
4675 "run" job is running |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4676 "fail" job failed to start |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4677 "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
|
4678 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
4679 If an exit callback was set with the "exit_cb" option and the |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
4680 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
|
4681 |
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
4682 For more information see |job_info()|. |
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
4683 |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4684 {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
|
4685 |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4686 job_stop({job} [, {how}]) *job_stop()* |
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4687 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
|
4688 |
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4689 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
|
4690 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
|
4691 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
|
4692 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
|
4693 affected. |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4694 |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4695 Effect for Unix: |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4696 "term" SIGTERM (default) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4697 "hup" SIGHUP |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4698 "quit" SIGQUIT |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4699 "int" SIGINT |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4700 "kill" SIGKILL (strongest way to stop) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4701 number signal with that number |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4702 |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4703 Effect for MS-Windows: |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4704 "term" terminate process forcedly (default) |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4705 "hup" CTRL_BREAK |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4706 "quit" CTRL_BREAK |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4707 "int" CTRL_C |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4708 "kill" terminate process forcedly |
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
4709 Others CTRL_BREAK |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4710 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4711 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
|
4712 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
|
4713 and the command. |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4714 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4715 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
|
4716 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
|
4717 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
|
4718 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
|
4719 job_status(). |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4720 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
|
4721 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
|
4722 |
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4723 {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
|
4724 |
95 | 4725 join({list} [, {sep}]) *join()* |
4726 Join the items in {list} together into one String. | |
4727 When {sep} is specified it is put in between the items. If | |
4728 {sep} is omitted a single space is used. | |
4729 Note that {sep} is not added at the end. You might want to | |
4730 add it there too: > | |
4731 let lines = join(mylist, "\n") . "\n" | |
692 | 4732 < String items are used as-is. |Lists| and |Dictionaries| are |
95 | 4733 converted into a string like with |string()|. |
4734 The opposite function is |split()|. | |
4735 | |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4736 js_decode({string}) *js_decode()* |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4737 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
|
4738 - 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
|
4739 - 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
|
4740 result in v:none items. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4741 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4742 js_encode({expr}) *js_encode()* |
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4743 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
|
4744 - 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
|
4745 - 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
|
4746 commas. |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4747 For example, the Vim object: |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4748 [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
|
4749 Will be encoded as: |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4750 [1,,{one:1},,] ~ |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4751 While json_encode() would produce: |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4752 [1,null,{"one":1},null] ~ |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4753 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
|
4754 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
|
4755 |
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4756 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4757 json_decode({string}) *json_decode()* |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4758 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
|
4759 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
|
4760 JSON and Vim values. |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4761 The decoding is permissive: |
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4762 - 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
|
4763 - 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
|
4764 "1.0". |
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4765 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
|
4766 - 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
|
4767 - 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
|
4768 |
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
4769 json_encode({expr}) *json_encode()* |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4770 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
|
4771 The encoding is specified in: |
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4772 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
|
4773 Vim values are converted as follows: |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4774 Number decimal number |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4775 Float floating point number |
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4776 Float nan "NaN" |
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4777 Float inf "Infinity" |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4778 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
|
4779 Funcref not possible, error |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4780 List as an array (possibly null); when |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
4781 used recursively: [] |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4782 Dict as an object (possibly null); when |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
4783 used recursively: {} |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4784 v:false "false" |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4785 v:true "true" |
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
4786 v:none "null" |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4787 v:null "null" |
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
4788 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
|
4789 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
|
4790 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
|
4791 |
99 | 4792 keys({dict}) *keys()* |
685 | 4793 Return a |List| with all the keys of {dict}. The |List| is in |
99 | 4794 arbitrary order. |
4795 | |
85 | 4796 *len()* *E701* |
55 | 4797 len({expr}) The result is a Number, which is the length of the argument. |
4798 When {expr} is a String or a Number the length in bytes is | |
4799 used, as with |strlen()|. | |
685 | 4800 When {expr} is a |List| the number of items in the |List| is |
55 | 4801 returned. |
685 | 4802 When {expr} is a |Dictionary| the number of entries in the |
4803 |Dictionary| is returned. | |
55 | 4804 Otherwise an error is given. |
4805 | |
7 | 4806 *libcall()* *E364* *E368* |
4807 libcall({libname}, {funcname}, {argument}) | |
4808 Call function {funcname} in the run-time library {libname} | |
4809 with single argument {argument}. | |
4810 This is useful to call functions in a library that you | |
4811 especially made to be used with Vim. Since only one argument | |
4812 is possible, calling standard library functions is rather | |
4813 limited. | |
4814 The result is the String returned by the function. If the | |
4815 function returns NULL, this will appear as an empty string "" | |
4816 to Vim. | |
4817 If the function returns a number, use libcallnr()! | |
4818 If {argument} is a number, it is passed to the function as an | |
4819 int; if {argument} is a string, it is passed as a | |
4820 null-terminated string. | |
4821 This function will fail in |restricted-mode|. | |
4822 | |
4823 libcall() allows you to write your own 'plug-in' extensions to | |
4824 Vim without having to recompile the program. It is NOT a | |
4825 means to call system functions! If you try to do so Vim will | |
4826 very probably crash. | |
4827 | |
4828 For Win32, the functions you write must be placed in a DLL | |
4829 and use the normal C calling convention (NOT Pascal which is | |
4830 used in Windows System DLLs). The function must take exactly | |
4831 one parameter, either a character pointer or a long integer, | |
4832 and must return a character pointer or NULL. The character | |
4833 pointer returned must point to memory that will remain valid | |
4834 after the function has returned (e.g. in static data in the | |
4835 DLL). If it points to allocated memory, that memory will | |
4836 leak away. Using a static buffer in the function should work, | |
4837 it's then freed when the DLL is unloaded. | |
4838 | |
4839 WARNING: If the function returns a non-valid pointer, Vim may | |
1621 | 4840 crash! This also happens if the function returns a number, |
7 | 4841 because Vim thinks it's a pointer. |
4842 For Win32 systems, {libname} should be the filename of the DLL | |
4843 without the ".DLL" suffix. A full path is only required if | |
4844 the DLL is not in the usual places. | |
4845 For Unix: When compiling your own plugins, remember that the | |
4846 object code must be compiled as position-independent ('PIC'). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4847 {only in Win32 and some Unix versions, when the |+libcall| |
7 | 4848 feature is present} |
4849 Examples: > | |
4850 :echo libcall("libc.so", "getenv", "HOME") | |
4851 < | |
4852 *libcallnr()* | |
4853 libcallnr({libname}, {funcname}, {argument}) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4854 Just like |libcall()|, but used for a function that returns an |
7 | 4855 int instead of a string. |
4856 {only in Win32 on some Unix versions, when the |+libcall| | |
4857 feature is present} | |
1621 | 4858 Examples: > |
4859 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
7 | 4860 :call libcallnr("libc.so", "printf", "Hello World!\n") |
4861 :call libcallnr("libc.so", "sleep", 10) | |
4862 < | |
4863 *line()* | |
4864 line({expr}) The result is a Number, which is the line number of the file | |
4865 position given with {expr}. The accepted positions are: | |
4866 . the cursor position | |
4867 $ the last line in the current buffer | |
4868 'x position of mark x (if the mark is not set, 0 is | |
4869 returned) | |
665 | 4870 w0 first line visible in current window |
4871 w$ last line visible in current window | |
1609 | 4872 v In Visual mode: the start of the Visual area (the |
4873 cursor is the end). When not in Visual mode | |
4874 returns the cursor position. Differs from |'<| in | |
4875 that it's updated right away. | |
1156 | 4876 Note that a mark in another file can be used. The line number |
4877 then applies to another buffer. | |
703 | 4878 To get the column number use |col()|. To get both use |
4879 |getpos()|. | |
7 | 4880 Examples: > |
4881 line(".") line number of the cursor | |
4882 line("'t") line number of mark t | |
4883 line("'" . marker) line number of mark marker | |
4884 < *last-position-jump* | |
4885 This autocommand jumps to the last known position in a file | |
4886 just after opening it, if the '" mark is set: > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4887 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
9 | 4888 |
7 | 4889 line2byte({lnum}) *line2byte()* |
4890 Return the byte count from the start of the buffer for line | |
4891 {lnum}. This includes the end-of-line character, depending on | |
4892 the 'fileformat' option for the current buffer. The first | |
3237 | 4893 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
7 | 4894 This can also be used to get the byte count for the line just |
4895 below the last line: > | |
4896 line2byte(line("$") + 1) | |
3237 | 4897 < This is the buffer size plus one. If 'fileencoding' is empty |
4898 it is the file size plus one. | |
7 | 4899 When {lnum} is invalid, or the |+byte_offset| feature has been |
4900 disabled at compile time, -1 is returned. | |
4901 Also see |byte2line()|, |go| and |:goto|. | |
4902 | |
4903 lispindent({lnum}) *lispindent()* | |
4904 Get the amount of indent for line {lnum} according the lisp | |
4905 indenting rules, as with 'lisp'. | |
4906 The indent is counted in spaces, the value of 'tabstop' is | |
4907 relevant. {lnum} is used just like in |getline()|. | |
4908 When {lnum} is invalid or Vim was not compiled the | |
4909 |+lispindent| feature, -1 is returned. | |
4910 | |
4911 localtime() *localtime()* | |
4912 Return the current time, measured as seconds since 1st Jan | |
4913 1970. See also |strftime()| and |getftime()|. | |
4914 | |
95 | 4915 |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4916 log({expr}) *log()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4917 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
|
4918 {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
|
4919 (0, inf]. |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4920 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4921 :echo log(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4922 < 2.302585 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4923 :echo log(exp(5)) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4924 < 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
|
4925 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4926 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4927 |
1621 | 4928 log10({expr}) *log10()* |
4929 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
4930 {expr} must evaluate to a |Float| or a |Number|. | |
4931 Examples: > | |
4932 :echo log10(1000) | |
4933 < 3.0 > | |
4934 :echo log10(0.01) | |
4935 < -2.0 | |
4936 {only available when compiled with the |+float| feature} | |
4937 | |
3492 | 4938 luaeval({expr}[, {expr}]) *luaeval()* |
4939 Evaluate Lua expression {expr} and return its result converted | |
4940 to Vim data structures. Second {expr} may hold additional | |
4941 argument accessible as _A inside first {expr}. | |
4942 Strings are returned as they are. | |
4943 Boolean objects are converted to numbers. | |
4944 Numbers are converted to |Float| values if vim was compiled | |
4945 with |+float| and to numbers otherwise. | |
4946 Dictionaries and lists obtained by vim.eval() are returned | |
4947 as-is. | |
4948 Other objects are returned as zero without any errors. | |
4949 See |lua-luaeval| for more details. | |
4950 {only available when compiled with the |+lua| feature} | |
4951 | |
102 | 4952 map({expr}, {string}) *map()* |
685 | 4953 {expr} must be a |List| or a |Dictionary|. |
102 | 4954 Replace each item in {expr} with the result of evaluating |
4955 {string}. | |
4956 Inside {string} |v:val| has the value of the current item. | |
1998 | 4957 For a |Dictionary| |v:key| has the key of the current item |
4958 and for a |List| |v:key| has the index of the current item. | |
102 | 4959 Example: > |
4960 :call map(mylist, '"> " . v:val . " <"') | |
95 | 4961 < This puts "> " before and " <" after each item in "mylist". |
102 | 4962 |
158 | 4963 Note that {string} is the result of an expression and is then |
102 | 4964 used as an expression again. Often it is good to use a |
158 | 4965 |literal-string| to avoid having to double backslashes. You |
4966 still have to double ' quotes | |
102 | 4967 |
685 | 4968 The operation is done in-place. If you want a |List| or |
4969 |Dictionary| to remain unmodified make a copy first: > | |
3682 | 4970 :let tlist = map(copy(mylist), ' v:val . "\t"') |
102 | 4971 |
685 | 4972 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
648 | 4973 When an error is encountered while evaluating {string} no |
4974 further items in {expr} are processed. | |
95 | 4975 |
4976 | |
2610 | 4977 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
4978 When {dict} is omitted or zero: Return the rhs of mapping | |
4979 {name} in mode {mode}. The returned String has special | |
4980 characters translated like in the output of the ":map" command | |
4981 listing. | |
4982 | |
4983 When there is no mapping for {name}, an empty String is | |
4984 returned. | |
4985 | |
4986 The {name} can have special key names, like in the ":map" | |
4987 command. | |
4988 | |
644 | 4989 {mode} can be one of these strings: |
7 | 4990 "n" Normal |
2610 | 4991 "v" Visual (including Select) |
7 | 4992 "o" Operator-pending |
4993 "i" Insert | |
4994 "c" Cmd-line | |
2610 | 4995 "s" Select |
4996 "x" Visual | |
7 | 4997 "l" langmap |language-mapping| |
4998 "" Normal, Visual and Operator-pending | |
644 | 4999 When {mode} is omitted, the modes for "" are used. |
2610 | 5000 |
782 | 5001 When {abbr} is there and it is non-zero use abbreviations |
5002 instead of mappings. | |
2610 | 5003 |
5004 When {dict} is there and it is non-zero return a dictionary | |
5005 containing all the information of the mapping with the | |
5006 following items: | |
5007 "lhs" The {lhs} of the mapping. | |
5008 "rhs" The {rhs} of the mapping as typed. | |
5009 "silent" 1 for a |:map-silent| mapping, else 0. | |
2625 | 5010 "noremap" 1 if the {rhs} of the mapping is not remappable. |
2610 | 5011 "expr" 1 for an expression mapping (|:map-<expr>|). |
5012 "buffer" 1 for a buffer local mapping (|:map-local|). | |
5013 "mode" Modes for which the mapping is defined. In | |
5014 addition to the modes mentioned above, these | |
5015 characters will be used: | |
5016 " " Normal, Visual and Operator-pending | |
5017 "!" Insert and Commandline mode | |
2642 | 5018 (|mapmode-ic|) |
2625 | 5019 "sid" The script local ID, used for <sid> mappings |
5020 (|<SID>|). | |
5555 | 5021 "nowait" Do not wait for other, longer mappings. |
5022 (|:map-<nowait>|). | |
2610 | 5023 |
7 | 5024 The mappings local to the current buffer are checked first, |
5025 then the global mappings. | |
626 | 5026 This function can be used to map a key even when it's already |
5027 mapped, and have it do the original mapping too. Sketch: > | |
5028 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
5029 | |
7 | 5030 |
782 | 5031 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
7 | 5032 Check if there is a mapping that matches with {name} in mode |
5033 {mode}. See |maparg()| for {mode} and special names in | |
5034 {name}. | |
782 | 5035 When {abbr} is there and it is non-zero use abbreviations |
5036 instead of mappings. | |
7 | 5037 A match happens with a mapping that starts with {name} and |
5038 with a mapping which is equal to the start of {name}. | |
5039 | |
1621 | 5040 matches mapping "a" "ab" "abc" ~ |
7 | 5041 mapcheck("a") yes yes yes |
5042 mapcheck("abc") yes yes yes | |
5043 mapcheck("ax") yes no no | |
5044 mapcheck("b") no no no | |
5045 | |
5046 The difference with maparg() is that mapcheck() finds a | |
5047 mapping that matches with {name}, while maparg() only finds a | |
5048 mapping for {name} exactly. | |
5049 When there is no mapping that starts with {name}, an empty | |
5050 String is returned. If there is one, the rhs of that mapping | |
5051 is returned. If there are several mappings that start with | |
5052 {name}, the rhs of one of them is returned. | |
5053 The mappings local to the current buffer are checked first, | |
5054 then the global mappings. | |
5055 This function can be used to check if a mapping can be added | |
5056 without being ambiguous. Example: > | |
5057 :if mapcheck("_vv") == "" | |
5058 : map _vv :set guifont=7x13<CR> | |
5059 :endif | |
5060 < This avoids adding the "_vv" mapping when there already is a | |
5061 mapping for "_v" or for "_vvv". | |
5062 | |
19 | 5063 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
685 | 5064 When {expr} is a |List| then this returns the index of the |
5065 first item where {pat} matches. Each item is used as a | |
692 | 5066 String, |Lists| and |Dictionaries| are used as echoed. |
1621 | 5067 Otherwise, {expr} is used as a String. The result is a |
95 | 5068 Number, which gives the index (byte offset) in {expr} where |
5069 {pat} matches. | |
685 | 5070 A match at the first character or |List| item returns zero. |
19 | 5071 If there is no match -1 is returned. |
2833 | 5072 For getting submatches see |matchlist()|. |
19 | 5073 Example: > |
95 | 5074 :echo match("testing", "ing") " results in 4 |
714 | 5075 :echo match([1, 'x'], '\a') " results in 1 |
95 | 5076 < See |string-match| for how {pat} is used. |
170 | 5077 *strpbrk()* |
1621 | 5078 Vim doesn't have a strpbrk() function. But you can do: > |
170 | 5079 :let sepidx = match(line, '[.,;: \t]') |
5080 < *strcasestr()* | |
5081 Vim doesn't have a strcasestr() function. But you can add | |
5082 "\c" to the pattern to ignore case: > | |
5083 :let idx = match(haystack, '\cneedle') | |
5084 < | |
95 | 5085 If {start} is given, the search starts from byte index |
685 | 5086 {start} in a String or item {start} in a |List|. |
7 | 5087 The result, however, is still the index counted from the |
236 | 5088 first character/item. Example: > |
7 | 5089 :echo match("testing", "ing", 2) |
5090 < result is again "4". > | |
5091 :echo match("testing", "ing", 4) | |
5092 < result is again "4". > | |
5093 :echo match("testing", "t", 2) | |
5094 < result is "3". | |
694 | 5095 For a String, if {start} > 0 then it is like the string starts |
703 | 5096 {start} bytes later, thus "^" will match at {start}. Except |
5097 when {count} is given, then it's like matches before the | |
5098 {start} byte are ignored (this is a bit complicated to keep it | |
5099 backwards compatible). | |
95 | 5100 For a String, if {start} < 0, it will be set to 0. For a list |
5101 the index is counted from the end. | |
697 | 5102 If {start} is out of range ({start} > strlen({expr}) for a |
5103 String or {start} > len({expr}) for a |List|) -1 is returned. | |
95 | 5104 |
694 | 5105 When {count} is given use the {count}'th match. When a match |
697 | 5106 is found in a String the search for the next one starts one |
694 | 5107 character further. Thus this example results in 1: > |
5108 echo match("testing", "..", 0, 2) | |
5109 < In a |List| the search continues in the next item. | |
703 | 5110 Note that when {count} is added the way {start} works changes, |
5111 see above. | |
694 | 5112 |
7 | 5113 See |pattern| for the patterns that are accepted. |
5114 The 'ignorecase' option is used to set the ignore-caseness of | |
1621 | 5115 the pattern. 'smartcase' is NOT used. The matching is always |
7 | 5116 done like 'magic' is set and 'cpoptions' is empty. |
5117 | |
1326 | 5118 *matchadd()* *E798* *E799* *E801* |
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5119 matchadd({group}, {pattern}[, {priority}[, {id}[, {dict}]]]) |
1326 | 5120 Defines a pattern to be highlighted in the current window (a |
5121 "match"). It will be highlighted with {group}. Returns an | |
5122 identification number (ID), which can be used to delete the | |
5123 match using |matchdelete()|. | |
5466 | 5124 Matching is case sensitive and magic, unless case sensitivity |
5125 or magicness are explicitly overridden in {pattern}. The | |
5126 'magic', 'smartcase' and 'ignorecase' options are not used. | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5127 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
|
5128 concealed. |
1326 | 5129 |
5130 The optional {priority} argument assigns a priority to the | |
1621 | 5131 match. A match with a high priority will have its |
1326 | 5132 highlighting overrule that of a match with a lower priority. |
5133 A priority is specified as an integer (negative numbers are no | |
5134 exception). If the {priority} argument is not specified, the | |
5135 default priority is 10. The priority of 'hlsearch' is zero, | |
5136 hence all matches with a priority greater than zero will | |
5137 overrule it. Syntax highlighting (see 'syntax') is a separate | |
5138 mechanism, and regardless of the chosen priority a match will | |
5139 always overrule syntax highlighting. | |
5140 | |
5141 The optional {id} argument allows the request for a specific | |
5142 match ID. If a specified ID is already taken, an error | |
5143 message will appear and the match will not be added. An ID | |
5144 is specified as a positive integer (zero excluded). IDs 1, 2 | |
5145 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
6947 | 5146 respectively. If the {id} argument is not specified or -1, |
1326 | 5147 |matchadd()| automatically chooses a free ID. |
5148 | |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5149 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
|
5150 values. Currently this is used to specify a match specific |
6947 | 5151 conceal character that will be shown for |hl-Conceal| |
5152 highlighted matches. The dict can have the following members: | |
5153 | |
5154 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
|
5155 match (only for |hl-Conceal| highlighted |
6947 | 5156 matches, see |:syn-cchar|) |
5157 | |
1326 | 5158 The number of matches is not limited, as it is the case with |
5159 the |:match| commands. | |
5160 | |
5161 Example: > | |
5162 :highlight MyGroup ctermbg=green guibg=green | |
5163 :let m = matchadd("MyGroup", "TODO") | |
5164 < Deletion of the pattern: > | |
5165 :call matchdelete(m) | |
5166 | |
5167 < A list of matches defined by |matchadd()| and |:match| are | |
1621 | 5168 available from |getmatches()|. All matches can be deleted in |
1326 | 5169 one operation by |clearmatches()|. |
819 | 5170 |
6947 | 5171 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
5979 | 5172 Same as |matchadd()|, but requires a list of positions {pos} |
5173 instead of a pattern. This command is faster than |matchadd()| | |
5174 because it does not require to handle regular expressions and | |
5175 sets buffer line boundaries to redraw screen. It is supposed | |
5176 to be used when fast match additions and deletions are | |
5177 required, for example to highlight matching parentheses. | |
5178 | |
5179 The list {pos} can contain one of these items: | |
6007 | 5180 - A number. This whole line will be highlighted. The first |
5979 | 5181 line has number 1. |
5182 - A list with one number, e.g., [23]. The whole line with this | |
5183 number will be highlighted. | |
5184 - A list with two numbers, e.g., [23, 11]. The first number is | |
6007 | 5185 the line number, the second one is the column number (first |
5186 column is 1, the value must correspond to the byte index as | |
5187 |col()| would return). The character at this position will | |
5188 be highlighted. | |
5979 | 5189 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
6007 | 5190 the third number gives the length of the highlight in bytes. |
5979 | 5191 |
5192 The maximum number of positions is 8. | |
5193 | |
5194 Example: > | |
5195 :highlight MyGroup ctermbg=green guibg=green | |
5196 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
5197 < Deletion of the pattern: > | |
5198 :call matchdelete(m) | |
5199 | |
5200 < Matches added by |matchaddpos()| are returned by | |
5201 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
5202 value a list like the {pos} item. | |
5203 These matches cannot be set via |setmatches()|, however they | |
5204 can still be deleted by |clearmatches()|. | |
5205 | |
819 | 5206 matcharg({nr}) *matcharg()* |
856 | 5207 Selects the {nr} match item, as set with a |:match|, |
819 | 5208 |:2match| or |:3match| command. |
5209 Return a |List| with two elements: | |
5210 The name of the highlight group used | |
5211 The pattern used. | |
5212 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
5213 When there is no match item set returns ['', '']. | |
1326 | 5214 This is useful to save and restore a |:match|. |
5215 Highlighting matches using the |:match| commands are limited | |
5216 to three matches. |matchadd()| does not have this limitation. | |
5217 | |
5218 matchdelete({id}) *matchdelete()* *E802* *E803* | |
5219 Deletes a match with ID {id} previously defined by |matchadd()| | |
1621 | 5220 or one of the |:match| commands. Returns 0 if successful, |
1326 | 5221 otherwise -1. See example for |matchadd()|. All matches can |
5222 be deleted in one operation by |clearmatches()|. | |
819 | 5223 |
19 | 5224 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5225 Same as |match()|, but return the index of first character |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5226 after the match. Example: > |
7 | 5227 :echo matchend("testing", "ing") |
5228 < results in "7". | |
170 | 5229 *strspn()* *strcspn()* |
5230 Vim doesn't have a strspn() or strcspn() function, but you can | |
5231 do it with matchend(): > | |
5232 :let span = matchend(line, '[a-zA-Z]') | |
5233 :let span = matchend(line, '[^a-zA-Z]') | |
5234 < Except that -1 is returned when there are no matches. | |
5235 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5236 The {start}, if given, has the same meaning as for |match()|. > |
7 | 5237 :echo matchend("testing", "ing", 2) |
5238 < results in "7". > | |
5239 :echo matchend("testing", "ing", 5) | |
5240 < result is "-1". | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5241 When {expr} is a |List| the result is equal to |match()|. |
7 | 5242 |
158 | 5243 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5244 Same as |match()|, but return a |List|. The first item in the |
158 | 5245 list is the matched string, same as what matchstr() would |
5246 return. Following items are submatches, like "\1", "\2", etc. | |
842 | 5247 in |:substitute|. When an optional submatch didn't match an |
5248 empty string is used. Example: > | |
5249 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
5250 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
158 | 5251 When there is no match an empty list is returned. |
5252 | |
19 | 5253 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
1621 | 5254 Same as |match()|, but return the matched string. Example: > |
7 | 5255 :echo matchstr("testing", "ing") |
5256 < results in "ing". | |
5257 When there is no match "" is returned. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5258 The {start}, if given, has the same meaning as for |match()|. > |
7 | 5259 :echo matchstr("testing", "ing", 2) |
5260 < results in "ing". > | |
5261 :echo matchstr("testing", "ing", 5) | |
5262 < result is "". | |
685 | 5263 When {expr} is a |List| then the matching item is returned. |
95 | 5264 The type isn't changed, it's not necessarily a String. |
7 | 5265 |
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5266 matchstrpos({expr}, {pat}[, {start}[, {count}]]) *matchstrpos()* |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5267 Same as |matchstr()|, but return the matched string, the start |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5268 position and the end position of the match. Example: > |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5269 :echo matchstrpos("testing", "ing") |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5270 < results in ["ing", 4, 7]. |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5271 When there is no match ["", -1, -1] is returned. |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5272 The {start}, if given, has the same meaning as for |match()|. > |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5273 :echo matchstrpos("testing", "ing", 2) |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5274 < results in ["ing", 4, 7]. > |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5275 :echo matchstrpos("testing", "ing", 5) |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5276 < result is ["", -1, -1]. |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5277 When {expr} is a |List| then the matching item, the index |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5278 of first item where {pat} matches, the start position and the |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5279 end position of the match are returned. > |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5280 :echo matchstrpos([1, '__x'], '\a') |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5281 < result is ["x", 1, 2, 3]. |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5282 The type isn't changed, it's not necessarily a String. |
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5283 |
87 | 5284 *max()* |
5285 max({list}) Return the maximum value of all items in {list}. | |
5286 If {list} is not a list or one of the items in {list} cannot | |
5287 be used as a Number this results in an error. | |
685 | 5288 An empty |List| results in zero. |
87 | 5289 |
5290 *min()* | |
1215 | 5291 min({list}) Return the minimum value of all items in {list}. |
87 | 5292 If {list} is not a list or one of the items in {list} cannot |
5293 be used as a Number this results in an error. | |
685 | 5294 An empty |List| results in zero. |
87 | 5295 |
843 | 5296 *mkdir()* *E739* |
168 | 5297 mkdir({name} [, {path} [, {prot}]]) |
5298 Create directory {name}. | |
5299 If {path} is "p" then intermediate directories are created as | |
5300 necessary. Otherwise it must be "". | |
5301 If {prot} is given it is used to set the protection bits of | |
5302 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
1621 | 5303 the user readable for others). Use 0700 to make it unreadable |
1702 | 5304 for others. This is only used for the last part of {name}. |
5305 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
5306 with 0755. | |
5307 Example: > | |
5308 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
5309 < This function is not available in the |sandbox|. | |
168 | 5310 Not available on all systems. To check use: > |
5311 :if exists("*mkdir") | |
5312 < | |
7 | 5313 *mode()* |
1621 | 5314 mode([expr]) Return a string that indicates the current mode. |
1661 | 5315 If [expr] is supplied and it evaluates to a non-zero Number or |
5316 a non-empty String (|non-zero-arg|), then the full mode is | |
5317 returned, otherwise only the first letter is returned. Note | |
5318 that " " and "0" are also non-empty strings. | |
1621 | 5319 |
7 | 5320 n Normal |
1621 | 5321 no Operator-pending |
7 | 5322 v Visual by character |
5323 V Visual by line | |
5324 CTRL-V Visual blockwise | |
5325 s Select by character | |
5326 S Select by line | |
5327 CTRL-S Select blockwise | |
5328 i Insert | |
1621 | 5329 R Replace |R| |
5330 Rv Virtual Replace |gR| | |
7 | 5331 c Command-line |
1621 | 5332 cv Vim Ex mode |gQ| |
5333 ce Normal Ex mode |Q| | |
7 | 5334 r Hit-enter prompt |
1621 | 5335 rm The -- more -- prompt |
5336 r? A |:confirm| query of some sort | |
5337 ! Shell or external command is executing | |
5338 This is useful in the 'statusline' option or when used | |
5339 with |remote_expr()| In most other places it always returns | |
5340 "c" or "n". | |
5341 Also see |visualmode()|. | |
7 | 5342 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5343 mzeval({expr}) *mzeval()* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5344 Evaluate MzScheme expression {expr} and return its result |
3492 | 5345 converted to Vim data structures. |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5346 Numbers and strings are returned as they are. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5347 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
|
5348 returned as Vim |Lists|. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5349 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
|
5350 converted to strings. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5351 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
|
5352 Examples: > |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5353 :mz (define l (list 1 2 3)) |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5354 :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
|
5355 :echo mzeval("l") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5356 :echo mzeval("h") |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5357 < |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5358 {only available when compiled with the |+mzscheme| feature} |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5359 |
7 | 5360 nextnonblank({lnum}) *nextnonblank()* |
5361 Return the line number of the first line at or below {lnum} | |
5362 that is not blank. Example: > | |
5363 if getline(nextnonblank(1)) =~ "Java" | |
5364 < When {lnum} is invalid or there is no non-blank line at or | |
5365 below it, zero is returned. | |
5366 See also |prevnonblank()|. | |
5367 | |
4051 | 5368 nr2char({expr}[, {utf8}]) *nr2char()* |
7 | 5369 Return a string with a single character, which has the number |
5370 value {expr}. Examples: > | |
5371 nr2char(64) returns "@" | |
5372 nr2char(32) returns " " | |
4051 | 5373 < When {utf8} is omitted or zero, the current 'encoding' is used. |
5374 Example for "utf-8": > | |
7 | 5375 nr2char(300) returns I with bow character |
4051 | 5376 < With {utf8} set to 1, always return utf-8 characters. |
5377 Note that a NUL character in the file is specified with | |
7 | 5378 nr2char(10), because NULs are represented with newline |
5379 characters. nr2char(0) is a real NUL and terminates the | |
119 | 5380 string, thus results in an empty string. |
7 | 5381 |
3214 | 5382 or({expr}, {expr}) *or()* |
5383 Bitwise OR on the two arguments. The arguments are converted | |
5384 to a number. A List, Dict or Float argument causes an error. | |
5385 Example: > | |
5386 :let bits = or(bits, 0x80) | |
5387 | |
5388 | |
819 | 5389 pathshorten({expr}) *pathshorten()* |
5390 Shorten directory names in the path {expr} and return the | |
5391 result. The tail, the file name, is kept as-is. The other | |
5392 components in the path are reduced to single letters. Leading | |
5393 '~' and '.' characters are kept. Example: > | |
5394 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
5395 < ~/.v/a/myfile.vim ~ | |
5396 It doesn't matter if the path exists or not. | |
5397 | |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5398 perleval({expr}) *perleval()* |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5399 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
|
5400 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
|
5401 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
|
5402 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
|
5403 reference to it. |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5404 Example: > |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5405 :echo perleval('[1 .. 4]') |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5406 < [1, 2, 3, 4] |
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5407 {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
|
5408 |
1621 | 5409 pow({x}, {y}) *pow()* |
5410 Return the power of {x} to the exponent {y} as a |Float|. | |
5411 {x} and {y} must evaluate to a |Float| or a |Number|. | |
5412 Examples: > | |
5413 :echo pow(3, 3) | |
5414 < 27.0 > | |
5415 :echo pow(2, 16) | |
5416 < 65536.0 > | |
5417 :echo pow(32, 0.20) | |
5418 < 2.0 | |
5419 {only available when compiled with the |+float| feature} | |
5420 | |
667 | 5421 prevnonblank({lnum}) *prevnonblank()* |
5422 Return the line number of the first line at or above {lnum} | |
5423 that is not blank. Example: > | |
5424 let ind = indent(prevnonblank(v:lnum - 1)) | |
5425 < When {lnum} is invalid or there is no non-blank line at or | |
5426 above it, zero is returned. | |
5427 Also see |nextnonblank()|. | |
5428 | |
5429 | |
449 | 5430 printf({fmt}, {expr1} ...) *printf()* |
5431 Return a String with {fmt}, where "%" items are replaced by | |
5432 the formatted form of their respective arguments. Example: > | |
452 | 5433 printf("%4d: E%d %.30s", lnum, errno, msg) |
449 | 5434 < May result in: |
452 | 5435 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
449 | 5436 |
5437 Often used items are: | |
856 | 5438 %s string |
3914 | 5439 %6S string right-aligned in 6 display cells |
653 | 5440 %6s string right-aligned in 6 bytes |
1621 | 5441 %.9s string truncated to 9 bytes |
5442 %c single byte | |
5443 %d decimal number | |
5444 %5d decimal number padded with spaces to 5 characters | |
5445 %x hex number | |
5446 %04x hex number padded with zeros to at least 4 characters | |
5447 %X hex number using upper case letters | |
5448 %o octal number | |
5449 %f floating point number in the form 123.456 | |
5450 %e floating point number in the form 1.234e3 | |
5451 %E floating point number in the form 1.234E3 | |
5452 %g floating point number, as %f or %e depending on value | |
5453 %G floating point number, as %f or %E depending on value | |
5454 %% the % character itself | |
449 | 5455 |
5456 Conversion specifications start with '%' and end with the | |
5457 conversion type. All other characters are copied unchanged to | |
5458 the result. | |
5459 | |
5460 The "%" starts a conversion specification. The following | |
452 | 5461 arguments appear in sequence: |
5462 | |
5463 % [flags] [field-width] [.precision] type | |
5464 | |
856 | 5465 flags |
452 | 5466 Zero or more of the following flags: |
5467 | |
449 | 5468 # The value should be converted to an "alternate |
5469 form". For c, d, and s conversions, this option | |
5470 has no effect. For o conversions, the precision | |
5471 of the number is increased to force the first | |
5472 character of the output string to a zero (except | |
5473 if a zero value is printed with an explicit | |
5474 precision of zero). | |
5475 For x and X conversions, a non-zero result has | |
5476 the string "0x" (or "0X" for X conversions) | |
5477 prepended to it. | |
452 | 5478 |
449 | 5479 0 (zero) Zero padding. For all conversions the converted |
5480 value is padded on the left with zeros rather | |
5481 than blanks. If a precision is given with a | |
5482 numeric conversion (d, o, x, and X), the 0 flag | |
5483 is ignored. | |
452 | 5484 |
449 | 5485 - A negative field width flag; the converted value |
5486 is to be left adjusted on the field boundary. | |
5487 The converted value is padded on the right with | |
5488 blanks, rather than on the left with blanks or | |
5489 zeros. A - overrides a 0 if both are given. | |
452 | 5490 |
449 | 5491 ' ' (space) A blank should be left before a positive |
5492 number produced by a signed conversion (d). | |
452 | 5493 |
449 | 5494 + A sign must always be placed before a number |
1621 | 5495 produced by a signed conversion. A + overrides |
449 | 5496 a space if both are used. |
452 | 5497 |
5498 field-width | |
5499 An optional decimal digit string specifying a minimum | |
653 | 5500 field width. If the converted value has fewer bytes |
5501 than the field width, it will be padded with spaces on | |
5502 the left (or right, if the left-adjustment flag has | |
5503 been given) to fill out the field width. | |
452 | 5504 |
5505 .precision | |
5506 An optional precision, in the form of a period '.' | |
5507 followed by an optional digit string. If the digit | |
5508 string is omitted, the precision is taken as zero. | |
5509 This gives the minimum number of digits to appear for | |
5510 d, o, x, and X conversions, or the maximum number of | |
653 | 5511 bytes to be printed from a string for s conversions. |
1621 | 5512 For floating point it is the number of digits after |
5513 the decimal point. | |
452 | 5514 |
5515 type | |
5516 A character that specifies the type of conversion to | |
5517 be applied, see below. | |
5518 | |
449 | 5519 A field width or precision, or both, may be indicated by an |
5520 asterisk '*' instead of a digit string. In this case, a | |
1621 | 5521 Number argument supplies the field width or precision. A |
449 | 5522 negative field width is treated as a left adjustment flag |
5523 followed by a positive field width; a negative precision is | |
5524 treated as though it were missing. Example: > | |
452 | 5525 :echo printf("%d: %.*s", nr, width, line) |
449 | 5526 < This limits the length of the text used from "line" to |
452 | 5527 "width" bytes. |
449 | 5528 |
856 | 5529 The conversion specifiers and their meanings are: |
452 | 5530 |
1621 | 5531 *printf-d* *printf-o* *printf-x* *printf-X* |
5532 doxX The Number argument is converted to signed decimal | |
449 | 5533 (d), unsigned octal (o), or unsigned hexadecimal (x |
5534 and X) notation. The letters "abcdef" are used for | |
5535 x conversions; the letters "ABCDEF" are used for X | |
452 | 5536 conversions. |
5537 The precision, if any, gives the minimum number of | |
5538 digits that must appear; if the converted value | |
5539 requires fewer digits, it is padded on the left with | |
5540 zeros. | |
5541 In no case does a non-existent or small field width | |
5542 cause truncation of a numeric field; if the result of | |
5543 a conversion is wider than the field width, the field | |
5544 is expanded to contain the conversion result. | |
5545 | |
1621 | 5546 *printf-c* |
452 | 5547 c The Number argument is converted to a byte, and the |
5548 resulting character is written. | |
5549 | |
1621 | 5550 *printf-s* |
452 | 5551 s The text of the String argument is used. If a |
5552 precision is specified, no more bytes than the number | |
5553 specified are used. | |
6583 | 5554 *printf-S* |
3914 | 5555 S The text of the String argument is used. If a |
5556 precision is specified, no more display cells than the | |
5557 number specified are used. Without the |+multi_byte| | |
5558 feature works just like 's'. | |
452 | 5559 |
1621 | 5560 *printf-f* *E807* |
5561 f The Float argument is converted into a string of the | |
5562 form 123.456. The precision specifies the number of | |
5563 digits after the decimal point. When the precision is | |
5564 zero the decimal point is omitted. When the precision | |
5565 is not specified 6 is used. A really big number | |
5566 (out of range or dividing by zero) results in "inf". | |
5567 "0.0 / 0.0" results in "nan". | |
5568 Example: > | |
5569 echo printf("%.2f", 12.115) | |
5570 < 12.12 | |
5571 Note that roundoff depends on the system libraries. | |
5572 Use |round()| when in doubt. | |
5573 | |
5574 *printf-e* *printf-E* | |
5575 e E The Float argument is converted into a string of the | |
5576 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
5577 precision specifies the number of digits after the | |
5578 decimal point, like with 'f'. | |
5579 | |
5580 *printf-g* *printf-G* | |
5581 g G The Float argument is converted like with 'f' if the | |
5582 value is between 0.001 (inclusive) and 10000000.0 | |
5583 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
5584 for 'G'. When no precision is specified superfluous | |
5585 zeroes and '+' signs are removed, except for the zero | |
5586 immediately after the decimal point. Thus 10000000.0 | |
5587 results in 1.0e7. | |
5588 | |
5589 *printf-%* | |
449 | 5590 % A '%' is written. No argument is converted. The |
5591 complete conversion specification is "%%". | |
452 | 5592 |
1668 | 5593 When a Number argument is expected a String argument is also |
5594 accepted and automatically converted. | |
5595 When a Float or String argument is expected a Number argument | |
5596 is also accepted and automatically converted. | |
5597 Any other argument type results in an error message. | |
449 | 5598 |
459 | 5599 *E766* *E767* |
449 | 5600 The number of {exprN} arguments must exactly match the number |
5601 of "%" items. If there are not sufficient or too many | |
452 | 5602 arguments an error is given. Up to 18 arguments can be used. |
449 | 5603 |
5604 | |
667 | 5605 pumvisible() *pumvisible()* |
5606 Returns non-zero when the popup menu is visible, zero | |
5607 otherwise. See |ins-completion-menu|. | |
712 | 5608 This can be used to avoid some things that would remove the |
5609 popup menu. | |
7 | 5610 |
3682 | 5611 py3eval({expr}) *py3eval()* |
5612 Evaluate Python expression {expr} and return its result | |
5613 converted to Vim data structures. | |
5614 Numbers and strings are returned as they are (strings are | |
6647 | 5615 copied though, Unicode strings are additionally converted to |
3682 | 5616 'encoding'). |
5617 Lists are represented as Vim |List| type. | |
5618 Dictionaries are represented as Vim |Dictionary| type with | |
5619 keys converted to strings. | |
5620 {only available when compiled with the |+python3| feature} | |
5621 | |
5622 *E858* *E859* | |
5623 pyeval({expr}) *pyeval()* | |
5624 Evaluate Python expression {expr} and return its result | |
5625 converted to Vim data structures. | |
5626 Numbers and strings are returned as they are (strings are | |
5627 copied though). | |
5628 Lists are represented as Vim |List| type. | |
3830 | 5629 Dictionaries are represented as Vim |Dictionary| type, |
5630 non-string keys result in error. | |
3682 | 5631 {only available when compiled with the |+python| feature} |
5632 | |
114 | 5633 *E726* *E727* |
99 | 5634 range({expr} [, {max} [, {stride}]]) *range()* |
685 | 5635 Returns a |List| with Numbers: |
99 | 5636 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
5637 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
5638 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
5639 {max}] (increasing {expr} with {stride} each time, not | |
5640 producing a value past {max}). | |
336 | 5641 When the maximum is one before the start the result is an |
5642 empty list. When the maximum is more than one before the | |
5643 start this is an error. | |
99 | 5644 Examples: > |
856 | 5645 range(4) " [0, 1, 2, 3] |
99 | 5646 range(2, 4) " [2, 3, 4] |
5647 range(2, 9, 3) " [2, 5, 8] | |
856 | 5648 range(2, -2, -1) " [2, 1, 0, -1, -2] |
336 | 5649 range(0) " [] |
5650 range(2, 0) " error! | |
99 | 5651 < |
158 | 5652 *readfile()* |
168 | 5653 readfile({fname} [, {binary} [, {max}]]) |
685 | 5654 Read file {fname} and return a |List|, each line of the file |
5655 as an item. Lines broken at NL characters. Macintosh files | |
158 | 5656 separated with CR will result in a single long line (unless a |
5657 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
|
5658 All NUL characters are replaced with a NL character. |
6918 | 5659 When {binary} contains "b" binary mode is used: |
158 | 5660 - When the last line ends in a NL an extra empty list item is |
5661 added. | |
5662 - No CR characters are removed. | |
5663 Otherwise: | |
5664 - CR characters that appear before a NL are removed. | |
5665 - 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
|
5666 - 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
|
5667 removed from the text. |
168 | 5668 When {max} is given this specifies the maximum number of lines |
5669 to be read. Useful if you only want to check the first ten | |
5670 lines of a file: > | |
5671 :for line in readfile(fname, '', 10) | |
5672 : if line =~ 'Date' | echo line | endif | |
5673 :endfor | |
233 | 5674 < When {max} is negative -{max} lines from the end of the file |
5675 are returned, or as many as there are. | |
5676 When {max} is zero the result is an empty list. | |
168 | 5677 Note that without {max} the whole file is read into memory. |
5678 Also note that there is no recognition of encoding. Read a | |
5679 file into a buffer if you need to. | |
158 | 5680 When the file can't be opened an error message is given and |
5681 the result is an empty list. | |
5682 Also see |writefile()|. | |
5683 | |
794 | 5684 reltime([{start} [, {end}]]) *reltime()* |
5685 Return an item that represents a time value. The format of | |
5686 the item depends on the system. It can be passed to | |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5687 |reltimestr()| to convert it to a string or |reltimefloat()| |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5688 to convert to a Float. |
794 | 5689 Without an argument it returns the current time. |
5690 With one argument is returns the time passed since the time | |
5691 specified in the argument. | |
843 | 5692 With two arguments it returns the time passed between {start} |
794 | 5693 and {end}. |
5694 The {start} and {end} arguments must be values returned by | |
5695 reltime(). | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5696 {only available when compiled with the |+reltime| feature} |
794 | 5697 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5698 reltimefloat({time}) *reltimefloat()* |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5699 Return a Float that represents the time value of {time}. |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5700 Example: > |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5701 let start = reltime() |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5702 call MyFunction() |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5703 let seconds = reltimefloat(reltime(start)) |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5704 < See the note of reltimestr() about overhead. |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5705 Also see |profiling|. |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5706 {only available when compiled with the |+reltime| feature} |
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5707 |
794 | 5708 reltimestr({time}) *reltimestr()* |
5709 Return a String that represents the time value of {time}. | |
5710 This is the number of seconds, a dot and the number of | |
5711 microseconds. Example: > | |
5712 let start = reltime() | |
5713 call MyFunction() | |
5714 echo reltimestr(reltime(start)) | |
5715 < Note that overhead for the commands will be added to the time. | |
5716 The accuracy depends on the system. | |
1156 | 5717 Leading spaces are used to make the string align nicely. You |
5718 can use split() to remove it. > | |
5719 echo split(reltimestr(reltime(start)))[0] | |
5720 < 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
|
5721 {only available when compiled with the |+reltime| feature} |
794 | 5722 |
7 | 5723 *remote_expr()* *E449* |
5724 remote_expr({server}, {string} [, {idvar}]) | |
1621 | 5725 Send the {string} to {server}. The string is sent as an |
7 | 5726 expression and the result is returned after evaluation. |
714 | 5727 The result must be a String or a |List|. A |List| is turned |
5728 into a String by joining the items with a line break in | |
5729 between (not at the end), like with join(expr, "\n"). | |
7 | 5730 If {idvar} is present, it is taken as the name of a |
5731 variable and a {serverid} for later use with | |
5732 remote_read() is stored there. | |
5733 See also |clientserver| |RemoteReply|. | |
5734 This function is not available in the |sandbox|. | |
5735 {only available when compiled with the |+clientserver| feature} | |
5736 Note: Any errors will cause a local error message to be issued | |
5737 and the result will be the empty string. | |
5738 Examples: > | |
5739 :echo remote_expr("gvim", "2+2") | |
5740 :echo remote_expr("gvim1", "b:current_syntax") | |
5741 < | |
5742 | |
5743 remote_foreground({server}) *remote_foreground()* | |
5744 Move the Vim server with the name {server} to the foreground. | |
5745 This works like: > | |
5746 remote_expr({server}, "foreground()") | |
5747 < Except that on Win32 systems the client does the work, to work | |
5748 around the problem that the OS doesn't always allow the server | |
5749 to bring itself to the foreground. | |
574 | 5750 Note: This does not restore the window if it was minimized, |
5751 like foreground() does. | |
7 | 5752 This function is not available in the |sandbox|. |
5753 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
5754 Win32 console version} | |
5755 | |
5756 | |
5757 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
5758 Returns a positive number if there are available strings | |
5759 from {serverid}. Copies any reply string into the variable | |
1621 | 5760 {retvar} if specified. {retvar} must be a string with the |
7 | 5761 name of a variable. |
5762 Returns zero if none are available. | |
5763 Returns -1 if something is wrong. | |
5764 See also |clientserver|. | |
5765 This function is not available in the |sandbox|. | |
5766 {only available when compiled with the |+clientserver| feature} | |
5767 Examples: > | |
5768 :let repl = "" | |
5769 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
5770 | |
5771 remote_read({serverid}) *remote_read()* | |
5772 Return the oldest available reply from {serverid} and consume | |
5773 it. It blocks until a reply is available. | |
5774 See also |clientserver|. | |
5775 This function is not available in the |sandbox|. | |
5776 {only available when compiled with the |+clientserver| feature} | |
5777 Example: > | |
5778 :echo remote_read(id) | |
5779 < | |
5780 *remote_send()* *E241* | |
5781 remote_send({server}, {string} [, {idvar}]) | |
1621 | 5782 Send the {string} to {server}. The string is sent as input |
22 | 5783 keys and the function returns immediately. At the Vim server |
5784 the keys are not mapped |:map|. | |
667 | 5785 If {idvar} is present, it is taken as the name of a variable |
5786 and a {serverid} for later use with remote_read() is stored | |
5787 there. | |
7 | 5788 See also |clientserver| |RemoteReply|. |
5789 This function is not available in the |sandbox|. | |
5790 {only available when compiled with the |+clientserver| feature} | |
5791 Note: Any errors will be reported in the server and may mess | |
5792 up the display. | |
5793 Examples: > | |
5794 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
5795 \ remote_read(serverid) | |
5796 | |
5797 :autocmd NONE RemoteReply * | |
5798 \ echo remote_read(expand("<amatch>")) | |
5799 :echo remote_send("gvim", ":sleep 10 | echo ". | |
5800 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
82 | 5801 < |
79 | 5802 remove({list}, {idx} [, {end}]) *remove()* |
685 | 5803 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
|
5804 return the item. |
79 | 5805 With {end}: Remove items from {idx} to {end} (inclusive) and |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5806 return a List with these items. When {idx} points to the same |
79 | 5807 item as {end} a list with one item is returned. When {end} |
5808 points to an item before {idx} this is an error. | |
5809 See |list-index| for possible values of {idx} and {end}. | |
55 | 5810 Example: > |
5811 :echo "last item: " . remove(mylist, -1) | |
79 | 5812 :call remove(mylist, 0, 9) |
99 | 5813 remove({dict}, {key}) |
5814 Remove the entry from {dict} with key {key}. Example: > | |
5815 :echo "removed " . remove(dict, "one") | |
5816 < If there is no {key} in {dict} this is an error. | |
5817 | |
5818 Use |delete()| to remove a file. | |
55 | 5819 |
7 | 5820 rename({from}, {to}) *rename()* |
5821 Rename the file by the name {from} to the name {to}. This | |
5822 should also work to move files across file systems. The | |
5823 result is a Number, which is 0 if the file was renamed | |
5824 successfully, and non-zero when the renaming failed. | |
1851 | 5825 NOTE: If {to} exists it is overwritten without warning. |
7 | 5826 This function is not available in the |sandbox|. |
5827 | |
18 | 5828 repeat({expr}, {count}) *repeat()* |
5829 Repeat {expr} {count} times and return the concatenated | |
5830 result. Example: > | |
843 | 5831 :let separator = repeat('-', 80) |
18 | 5832 < When {count} is zero or negative the result is empty. |
685 | 5833 When {expr} is a |List| the result is {expr} concatenated |
1621 | 5834 {count} times. Example: > |
79 | 5835 :let longlist = repeat(['a', 'b'], 3) |
5836 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
18 | 5837 |
82 | 5838 |
7 | 5839 resolve({filename}) *resolve()* *E655* |
5840 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
5841 returns the path the shortcut points to in a simplified form. | |
5842 On Unix, repeat resolving symbolic links in all path | |
5843 components of {filename} and return the simplified result. | |
5844 To cope with link cycles, resolving of symbolic links is | |
5845 stopped after 100 iterations. | |
5846 On other systems, return the simplified {filename}. | |
5847 The simplification step is done as by |simplify()|. | |
5848 resolve() keeps a leading path component specifying the | |
5849 current directory (provided the result is still a relative | |
5850 path name) and also keeps a trailing path separator. | |
5851 | |
82 | 5852 *reverse()* |
1621 | 5853 reverse({list}) Reverse the order of items in {list} in-place. Returns |
82 | 5854 {list}. |
5855 If you want a list to remain unmodified make a copy first: > | |
5856 :let revlist = reverse(copy(mylist)) | |
5857 | |
1621 | 5858 round({expr}) *round()* |
1668 | 5859 Round off {expr} to the nearest integral value and return it |
1621 | 5860 as a |Float|. If {expr} lies halfway between two integral |
5861 values, then use the larger one (away from zero). | |
5862 {expr} must evaluate to a |Float| or a |Number|. | |
5863 Examples: > | |
5864 echo round(0.456) | |
5865 < 0.0 > | |
5866 echo round(4.5) | |
5867 < 5.0 > | |
5868 echo round(-4.5) | |
5869 < -5.0 | |
5870 {only available when compiled with the |+float| feature} | |
3996 | 5871 |
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5872 screenattr(row, col) *screenattr()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5873 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
|
5874 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
|
5875 attribute at other positions. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5876 |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5877 screenchar(row, col) *screenchar()* |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5878 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
|
5879 [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
|
5880 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
|
5881 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
|
5882 The character excludes composing characters. For double-byte |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5883 encodings it may only be the first byte. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5884 This is mainly to be used for testing. |
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5885 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
|
5886 |
3996 | 5887 screencol() *screencol()* |
5888 The result is a Number, which is the current screen column of | |
5889 the cursor. The leftmost column has number 1. | |
5890 This function is mainly used for testing. | |
5891 | |
5892 Note: Always returns the current screen column, thus if used | |
5893 in a command (e.g. ":echo screencol()") it will return the | |
5894 column inside the command line, which is 1 when the command is | |
5895 executed. To get the cursor position in the file use one of | |
5896 the following mappings: > | |
5897 nnoremap <expr> GG ":echom ".screencol()."\n" | |
5898 nnoremap <silent> GG :echom screencol()<CR> | |
5899 < | |
5900 screenrow() *screenrow()* | |
5901 The result is a Number, which is the current screen row of the | |
5902 cursor. The top line has number one. | |
5903 This function is mainly used for testing. | |
5904 | |
5905 Note: Same restrictions as with |screencol()|. | |
5906 | |
1496 | 5907 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
7 | 5908 Search for regexp pattern {pattern}. The search starts at the |
119 | 5909 cursor position (you can use |cursor()| to set it). |
707 | 5910 |
3967 | 5911 When a match has been found its line number is returned. |
3312 | 5912 If there is no match a 0 is returned and the cursor doesn't |
5913 move. No error message is given. | |
5914 | |
7 | 5915 {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
|
5916 'b' search Backward instead of forward |
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5917 'c' accept a match at the Cursor position |
712 | 5918 'e' move to the End of the match |
20 | 5919 '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
|
5920 '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
|
5921 '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
|
5922 '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
|
5923 '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
|
5924 'z' start searching at the cursor column instead of zero |
7 | 5925 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
5926 | |
444 | 5927 If the 's' flag is supplied, the ' mark is set, only if the |
5928 cursor is moved. The 's' flag cannot be combined with the 'n' | |
5929 flag. | |
5930 | |
1156 | 5931 '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
|
5932 |
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5933 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
|
5934 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
|
5935 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
|
5936 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
|
5937 one column further. |
1156 | 5938 |
692 | 5939 When the {stopline} argument is given then the search stops |
5940 after searching this line. This is useful to restrict the | |
5941 search to a range of lines. Examples: > | |
5942 let match = search('(', 'b', line("w0")) | |
5943 let end = search('END', '', line("w$")) | |
5944 < When {stopline} is used and it is not zero this also implies | |
5945 that the search does not wrap around the end of the file. | |
1496 | 5946 A zero value is equal to not giving the argument. |
5947 | |
5948 When the {timeout} argument is given the search stops when | |
3513 | 5949 more than this many milliseconds have passed. Thus when |
1496 | 5950 {timeout} is 500 the search stops after half a second. |
5951 The value must not be negative. A zero value is like not | |
5952 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
|
5953 {only available when compiled with the |+reltime| feature} |
692 | 5954 |
714 | 5955 *search()-sub-match* |
5956 With the 'p' flag the returned value is one more than the | |
5957 first sub-match in \(\). One if none of them matched but the | |
5958 whole pattern did match. | |
712 | 5959 To get the column number too use |searchpos()|. |
5960 | |
20 | 5961 The cursor will be positioned at the match, unless the 'n' |
707 | 5962 flag is used. |
7 | 5963 |
5964 Example (goes over all files in the argument list): > | |
5965 :let n = 1 | |
5966 :while n <= argc() " loop over all files in arglist | |
5967 : exe "argument " . n | |
5968 : " start at the last char in the file and wrap for the | |
5969 : " first search to find match at start of file | |
5970 : normal G$ | |
5971 : let flags = "w" | |
5972 : while search("foo", flags) > 0 | |
1621 | 5973 : s/foo/bar/g |
7 | 5974 : let flags = "W" |
5975 : endwhile | |
5976 : update " write the file if modified | |
5977 : let n = n + 1 | |
5978 :endwhile | |
5979 < | |
712 | 5980 Example for using some flags: > |
5981 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
5982 < This will search for the keywords "if", "else", and "endif" | |
5983 under or after the cursor. Because of the 'p' flag, it | |
5984 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
5985 if the search fails. With the cursor on the first word of the | |
5986 line: | |
5987 if (foo == 0) | let foo = foo + 1 | endif ~ | |
5988 the function returns 1. Without the 'c' flag, the function | |
5989 finds the "endif" and returns 3. The same thing happens | |
5990 without the 'e' flag if the cursor is on the "f" of "if". | |
5991 The 'n' flag tells the function not to move the cursor. | |
5992 | |
504 | 5993 |
523 | 5994 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
5995 Search for the declaration of {name}. | |
856 | 5996 |
523 | 5997 With a non-zero {global} argument it works like |gD|, find |
5998 first match in the file. Otherwise it works like |gd|, find | |
5999 first match in the function. | |
6000 | |
6001 With a non-zero {thisblock} argument matches in a {} block | |
6002 that ends before the cursor position are ignored. Avoids | |
6003 finding variable declarations only valid in another scope. | |
6004 | |
504 | 6005 Moves the cursor to the found match. |
6006 Returns zero for success, non-zero for failure. | |
6007 Example: > | |
6008 if searchdecl('myvar') == 0 | |
6009 echo getline('.') | |
6010 endif | |
6011 < | |
7 | 6012 *searchpair()* |
1496 | 6013 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
6014 [, {stopline} [, {timeout}]]]]) | |
7 | 6015 Search for the match of a nested start-end pair. This can be |
6016 used to find the "endif" that matches an "if", while other | |
6017 if/endif pairs in between are ignored. | |
677 | 6018 The search starts at the cursor. The default is to search |
6019 forward, include 'b' in {flags} to search backward. | |
6020 If a match is found, the cursor is positioned at it and the | |
6021 line number is returned. If no match is found 0 or -1 is | |
6022 returned and the cursor doesn't move. No error message is | |
6023 given. | |
7 | 6024 |
6025 {start}, {middle} and {end} are patterns, see |pattern|. They | |
6026 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
6027 {middle} is not empty, it is found when searching from either | |
6028 direction, but only when not in a nested start-end pair. A | |
6029 typical use is: > | |
6030 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
6031 < By leaving {middle} empty the "else" is skipped. | |
6032 | |
712 | 6033 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
6034 |search()|. Additionally: | |
7 | 6035 'r' Repeat until no more matches found; will find the |
1621 | 6036 outer pair. Implies the 'W' flag. |
6037 'm' Return number of matches instead of line number with | |
712 | 6038 the match; will be > 1 when 'r' is used. |
1621 | 6039 Note: it's nearly always a good idea to use the 'W' flag, to |
6040 avoid wrapping around the end of the file. | |
7 | 6041 |
6042 When a match for {start}, {middle} or {end} is found, the | |
6043 {skip} expression is evaluated with the cursor positioned on | |
6044 the start of the match. It should return non-zero if this | |
6045 match is to be skipped. E.g., because it is inside a comment | |
6046 or a string. | |
6047 When {skip} is omitted or empty, every match is accepted. | |
6048 When evaluating {skip} causes an error the search is aborted | |
6049 and -1 returned. | |
6050 | |
1496 | 6051 For {stopline} and {timeout} see |search()|. |
692 | 6052 |
7 | 6053 The value of 'ignorecase' is used. 'magic' is ignored, the |
6054 patterns are used like it's on. | |
6055 | |
6056 The search starts exactly at the cursor. A match with | |
6057 {start}, {middle} or {end} at the next character, in the | |
6058 direction of searching, is the first one found. Example: > | |
6059 if 1 | |
6060 if 2 | |
6061 endif 2 | |
6062 endif 1 | |
6063 < When starting at the "if 2", with the cursor on the "i", and | |
6064 searching forwards, the "endif 2" is found. When starting on | |
6065 the character just before the "if 2", the "endif 1" will be | |
1621 | 6066 found. That's because the "if 2" will be found first, and |
7 | 6067 then this is considered to be a nested if/endif from "if 2" to |
6068 "endif 2". | |
6069 When searching backwards and {end} is more than one character, | |
6070 it may be useful to put "\zs" at the end of the pattern, so | |
6071 that when the cursor is inside a match with the end it finds | |
6072 the matching start. | |
6073 | |
6074 Example, to find the "endif" command in a Vim script: > | |
6075 | |
6076 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
6077 \ 'getline(".") =~ "^\\s*\""') | |
6078 | |
6079 < The cursor must be at or after the "if" for which a match is | |
6080 to be found. Note that single-quote strings are used to avoid | |
6081 having to double the backslashes. The skip expression only | |
6082 catches comments at the start of a line, not after a command. | |
6083 Also, a word "en" or "if" halfway a line is considered a | |
6084 match. | |
6085 Another example, to search for the matching "{" of a "}": > | |
6086 | |
6087 :echo searchpair('{', '', '}', 'bW') | |
6088 | |
6089 < This works when the cursor is at or before the "}" for which a | |
6090 match is to be found. To reject matches that syntax | |
6091 highlighting recognized as strings: > | |
6092 | |
6093 :echo searchpair('{', '', '}', 'bW', | |
6094 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
6095 < | |
667 | 6096 *searchpairpos()* |
1496 | 6097 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
6098 [, {stopline} [, {timeout}]]]]) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6099 Same as |searchpair()|, but returns a |List| with the line and |
685 | 6100 column position of the match. The first element of the |List| |
6101 is the line number and the second element is the byte index of | |
667 | 6102 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
|
6103 returns [0, 0]. > |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6104 |
667 | 6105 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
6106 < | |
6107 See |match-parens| for a bigger and more useful example. | |
6108 | |
1496 | 6109 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
692 | 6110 Same as |search()|, but returns a |List| with the line and |
685 | 6111 column position of the match. The first element of the |List| |
6112 is the line number and the second element is the byte index of | |
6113 the column position of the match. If no match is found, | |
6114 returns [0, 0]. | |
714 | 6115 Example: > |
6116 :let [lnum, col] = searchpos('mypattern', 'n') | |
6117 | |
6118 < When the 'p' flag is given then there is an extra item with | |
6119 the sub-pattern match number |search()-sub-match|. Example: > | |
6120 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
6121 < In this example "submatch" is 2 when a lowercase letter is | |
6122 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
6123 | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
6124 server2client({clientid}, {string}) *server2client()* |
7 | 6125 Send a reply string to {clientid}. The most recent {clientid} |
6126 that sent a string can be retrieved with expand("<client>"). | |
6127 {only available when compiled with the |+clientserver| feature} | |
6128 Note: | |
6129 This id has to be stored before the next command can be | |
236 | 6130 received. I.e. before returning from the received command and |
7 | 6131 before calling any commands that waits for input. |
6132 See also |clientserver|. | |
6133 Example: > | |
6134 :echo server2client(expand("<client>"), "HELLO") | |
6135 < | |
6136 serverlist() *serverlist()* | |
6137 Return a list of available server names, one per line. | |
6138 When there are no servers or the information is not available | |
6139 an empty string is returned. See also |clientserver|. | |
6140 {only available when compiled with the |+clientserver| feature} | |
6141 Example: > | |
6142 :echo serverlist() | |
6143 < | |
6144 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
6145 Set option or local variable {varname} in buffer {expr} to | |
6146 {val}. | |
6147 This also works for a global or local window option, but it | |
6148 doesn't work for a global or local window variable. | |
6149 For a local window option the global value is unchanged. | |
6150 For the use of {expr}, see |bufname()| above. | |
6151 Note that the variable name without "b:" must be used. | |
6152 Examples: > | |
6153 :call setbufvar(1, "&mod", 1) | |
6154 :call setbufvar("todo", "myvar", "foobar") | |
6155 < This function is not available in the |sandbox|. | |
6156 | |
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6157 setcharsearch({dict}) *setcharsearch()* |
6991 | 6158 Set the current character search information to {dict}, |
6159 which contains one or more of the following entries: | |
6160 | |
6161 char character which will be used for a subsequent | |
6162 |,| or |;| command; an empty string clears the | |
6163 character search | |
6164 forward direction of character search; 1 for forward, | |
6165 0 for backward | |
6166 until type of character search; 1 for a |t| or |T| | |
6167 character search, 0 for an |f| or |F| | |
6168 character search | |
6169 | |
6170 This can be useful to save/restore a user's character search | |
6171 from a script: > | |
6172 :let prevsearch = getcharsearch() | |
6173 :" Perform a command which clobbers user's search | |
6174 :call setcharsearch(prevsearch) | |
6175 < Also see |getcharsearch()|. | |
6176 | |
7 | 6177 setcmdpos({pos}) *setcmdpos()* |
6178 Set the cursor position in the command line to byte position | |
1621 | 6179 {pos}. The first position is 1. |
7 | 6180 Use |getcmdpos()| to obtain the current position. |
6181 Only works while editing the command line, thus you must use | |
99 | 6182 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
6183 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
6184 set after the command line is set to the expression. For | |
6185 |c_CTRL-R_=| it is set after evaluating the expression but | |
6186 before inserting the resulting text. | |
7 | 6187 When the number is too big the cursor is put at the end of the |
6188 line. A number smaller than one has undefined results. | |
6189 Returns 0 when successful, 1 when not editing the command | |
6190 line. | |
6191 | |
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6192 setfperm({fname}, {mode}) *setfperm()* *chmod* |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6193 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
|
6194 {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
|
6195 "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
|
6196 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
|
6197 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
|
6198 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
|
6199 characters are not supported. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6200 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6201 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
|
6202 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
|
6203 would do the same thing. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6204 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6205 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
|
6206 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6207 To read permissions see |getfperm()|. |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6208 |
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6209 |
1621 | 6210 setline({lnum}, {text}) *setline()* |
3312 | 6211 Set line {lnum} of the current buffer to {text}. To insert |
6212 lines use |append()|. | |
236 | 6213 {lnum} is used like with |getline()|. |
1621 | 6214 When {lnum} is just below the last line the {text} will be |
282 | 6215 added as a new line. |
236 | 6216 If this succeeds, 0 is returned. If this fails (most likely |
6217 because {lnum} is invalid) 1 is returned. Example: > | |
7 | 6218 :call setline(5, strftime("%c")) |
1621 | 6219 < When {text} is a |List| then line {lnum} and following lines |
282 | 6220 will be set to the items in the list. Example: > |
6221 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
6222 < This is equivalent to: > | |
3465 | 6223 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
282 | 6224 : call setline(n, l) |
6225 :endfor | |
7 | 6226 < Note: The '[ and '] marks are not set. |
6227 | |
647 | 6228 setloclist({nr}, {list} [, {action}]) *setloclist()* |
6229 Create or replace or add to the location list for window {nr}. | |
6230 When {nr} is zero the current window is used. For a location | |
648 | 6231 list window, the displayed location list is modified. For an |
6232 invalid window number {nr}, -1 is returned. | |
1326 | 6233 Otherwise, same as |setqflist()|. |
6234 Also see |location-list|. | |
6235 | |
6236 setmatches({list}) *setmatches()* | |
6237 Restores a list of matches saved by |getmatches()|. Returns 0 | |
1621 | 6238 if successful, otherwise -1. All current matches are cleared |
1326 | 6239 before the list is restored. See example for |getmatches()|. |
230 | 6240 |
707 | 6241 *setpos()* |
6242 setpos({expr}, {list}) | |
6243 Set the position for {expr}. Possible values: | |
6244 . the cursor | |
6245 'x mark x | |
6246 | |
5938 | 6247 {list} must be a |List| with four or five numbers: |
707 | 6248 [bufnum, lnum, col, off] |
5938 | 6249 [bufnum, lnum, col, off, curswant] |
707 | 6250 |
1621 | 6251 "bufnum" is the buffer number. Zero can be used for the |
856 | 6252 current buffer. Setting the cursor is only possible for |
707 | 6253 the current buffer. To set a mark in another buffer you can |
6254 use the |bufnr()| function to turn a file name into a buffer | |
6255 number. | |
798 | 6256 Does not change the jumplist. |
707 | 6257 |
6258 "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
|
6259 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
|
6260 smaller than 1 then 1 is used. |
707 | 6261 |
6262 The "off" number is only used when 'virtualedit' is set. Then | |
6263 it is the offset in screen columns from the start of the | |
1266 | 6264 character. E.g., a position within a <Tab> or after the last |
707 | 6265 character. |
6266 | |
5938 | 6267 The "curswant" number is only used when setting the cursor |
6268 position. It sets the preferred column for when moving the | |
6269 cursor vertically. When the "curswant" number is missing the | |
6270 preferred column is not set. When it is present and setting a | |
6271 mark position it is not used. | |
6272 | |
5555 | 6273 Note that for '< and '> changing the line number may result in |
6274 the marks to be effectively be swapped, so that '< is always | |
6275 before '>. | |
6276 | |
1533 | 6277 Returns 0 when the position could be set, -1 otherwise. |
6278 An error message is given if {expr} is invalid. | |
6279 | |
5944 | 6280 Also see |getpos()| and |getcurpos()|. |
707 | 6281 |
1156 | 6282 This does not restore the preferred column for moving |
5938 | 6283 vertically; if you set the cursor position with this, |j| and |
6284 |k| motions will jump to previous columns! Use |cursor()| to | |
6285 also set the preferred column. Also see the "curswant" key in | |
6286 |winrestview()|. | |
1156 | 6287 |
707 | 6288 |
277 | 6289 setqflist({list} [, {action}]) *setqflist()* |
647 | 6290 Create or replace or add to the quickfix list using the items |
6291 in {list}. Each item in {list} is a dictionary. | |
6292 Non-dictionary items in {list} are ignored. Each dictionary | |
6293 item can contain the following entries: | |
230 | 6294 |
1065 | 6295 bufnr buffer number; must be the number of a valid |
1621 | 6296 buffer |
1065 | 6297 filename name of a file; only used when "bufnr" is not |
1621 | 6298 present or it is invalid. |
230 | 6299 lnum line number in the file |
233 | 6300 pattern search pattern used to locate the error |
230 | 6301 col column number |
233 | 6302 vcol when non-zero: "col" is visual column |
856 | 6303 when zero: "col" is byte index |
233 | 6304 nr error number |
230 | 6305 text description of the error |
233 | 6306 type single-character error type, 'E', 'W', etc. |
6307 | |
6308 The "col", "vcol", "nr", "type" and "text" entries are | |
6309 optional. Either "lnum" or "pattern" entry can be used to | |
6310 locate a matching error line. | |
1065 | 6311 If the "filename" and "bufnr" entries are not present or |
6312 neither the "lnum" or "pattern" entries are present, then the | |
6313 item will not be handled as an error line. | |
230 | 6314 If both "pattern" and "lnum" are present then "pattern" will |
6315 be used. | |
2152 | 6316 If you supply an empty {list}, the quickfix list will be |
6317 cleared. | |
1065 | 6318 Note that the list is not exactly the same as what |
6319 |getqflist()| returns. | |
230 | 6320 |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
6321 *E927* |
277 | 6322 If {action} is set to 'a', then the items from {list} are |
6323 added to the existing quickfix list. If there is no existing | |
6324 list, then a new list is created. If {action} is set to 'r', | |
6325 then the items from the current quickfix list are replaced | |
6326 with the items from {list}. If {action} is not present or is | |
6327 set to ' ', then a new list is created. | |
6328 | |
230 | 6329 Returns zero for success, -1 for failure. |
6330 | |
6331 This function can be used to create a quickfix list | |
6332 independent of the 'errorformat' setting. Use a command like | |
6333 ":cc 1" to jump to the first position. | |
6334 | |
6335 | |
7 | 6336 *setreg()* |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
6337 setreg({regname}, {value} [, {options}]) |
7 | 6338 Set the register {regname} to {value}. |
5798 | 6339 {value} may be any value returned by |getreg()|, including |
6340 a |List|. | |
7 | 6341 If {options} contains "a" or {regname} is upper case, |
6342 then the value is appended. | |
2423 | 6343 {options} can also contain a register type specification: |
7 | 6344 "c" or "v" |characterwise| mode |
6345 "l" or "V" |linewise| mode | |
6346 "b" or "<CTRL-V>" |blockwise-visual| mode | |
6347 If a number immediately follows "b" or "<CTRL-V>" then this is | |
6348 used as the width of the selection - if it is not specified | |
6349 then the width of the block is set to the number of characters | |
1266 | 6350 in the longest line (counting a <Tab> as 1 character). |
7 | 6351 |
6352 If {options} contains no register settings, then the default | |
5798 | 6353 is to use character mode unless {value} ends in a <NL> for |
6354 string {value} and linewise mode for list {value}. Blockwise | |
6355 mode is never selected automatically. | |
6356 Returns zero for success, non-zero for failure. | |
6357 | |
6358 *E883* | |
6180 | 6359 Note: you may not use |List| containing more than one item to |
5798 | 6360 set search and expression registers. Lists containing no |
6361 items act like empty strings. | |
7 | 6362 |
6363 Examples: > | |
6364 :call setreg(v:register, @*) | |
6365 :call setreg('*', @%, 'ac') | |
6366 :call setreg('a', "1\n2\n3", 'b5') | |
6367 | |
6368 < This example shows using the functions to save and restore a | |
5798 | 6369 register (note: you may not reliably restore register value |
6370 without using the third argument to |getreg()| as without it | |
6371 newlines are represented as newlines AND Nul bytes are | |
6372 represented as newlines as well, see |NL-used-for-Nul|). > | |
6373 :let var_a = getreg('a', 1, 1) | |
7 | 6374 :let var_amode = getregtype('a') |
6375 .... | |
6376 :call setreg('a', var_a, var_amode) | |
6377 | |
6378 < You can also change the type of a register by appending | |
6379 nothing: > | |
6380 :call setreg('a', '', 'al') | |
6381 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6382 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6383 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
|
6384 |t:var| |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6385 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
|
6386 Tabs are numbered starting with one. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6387 This function is not available in the |sandbox|. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6388 |
831 | 6389 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
6390 Set option or local variable {varname} in window {winnr} to | |
6391 {val}. | |
6392 Tabs are numbered starting with one. For the current tabpage | |
6393 use |setwinvar()|. | |
6394 When {winnr} is zero the current window is used. | |
7 | 6395 This also works for a global or local buffer option, but it |
6396 doesn't work for a global or local buffer variable. | |
6397 For a local buffer option the global value is unchanged. | |
6398 Note that the variable name without "w:" must be used. | |
831 | 6399 Examples: > |
6400 :call settabwinvar(1, 1, "&list", 0) | |
6401 :call settabwinvar(3, 2, "myvar", "foobar") | |
6402 < This function is not available in the |sandbox|. | |
6403 | |
6404 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
6405 Like |settabwinvar()| for the current tab page. | |
7 | 6406 Examples: > |
6407 :call setwinvar(1, "&list", 0) | |
6408 :call setwinvar(2, "myvar", "foobar") | |
6409 | |
4126 | 6410 sha256({string}) *sha256()* |
6647 | 6411 Returns a String with 64 hex characters, which is the SHA256 |
4126 | 6412 checksum of {string}. |
6413 {only available when compiled with the |+cryptv| feature} | |
6414 | |
1661 | 6415 shellescape({string} [, {special}]) *shellescape()* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6416 Escape {string} for use as a shell command argument. |
985 | 6417 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
1661 | 6418 will enclose {string} in double quotes and double all double |
985 | 6419 quotes within {string}. |
6420 For other systems, it will enclose {string} in single quotes | |
6421 and replace all "'" with "'\''". | |
1661 | 6422 When the {special} argument is present and it's a non-zero |
6423 Number or a non-empty String (|non-zero-arg|), then special | |
1698 | 6424 items such as "!", "%", "#" and "<cword>" will be preceded by |
6425 a backslash. This backslash will be removed again by the |:!| | |
1661 | 6426 command. |
1698 | 6427 The "!" character will be escaped (again with a |non-zero-arg| |
6428 {special}) when 'shell' contains "csh" in the tail. That is | |
6429 because for csh and tcsh "!" is used for history replacement | |
6430 even when inside single quotes. | |
6431 The <NL> character is also escaped. With a |non-zero-arg| | |
6432 {special} and 'shell' containing "csh" in the tail it's | |
6433 escaped a second time. | |
1661 | 6434 Example of use with a |:!| command: > |
6435 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
6436 < This results in a directory listing for the file under the | |
6437 cursor. Example of use with |system()|: > | |
6438 :call system("chmod +w -- " . shellescape(expand("%"))) | |
5690 | 6439 < See also |::S|. |
985 | 6440 |
6441 | |
3875 | 6442 shiftwidth() *shiftwidth()* |
6443 Returns the effective value of 'shiftwidth'. This is the | |
6444 '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
|
6445 '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
|
6446 7.3.694 in 2012, everybody should have it by now. |
3875 | 6447 |
6448 | |
7 | 6449 simplify({filename}) *simplify()* |
6450 Simplify the file name as much as possible without changing | |
6451 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
6452 Unix) are not resolved. If the first path component in | |
6453 {filename} designates the current directory, this will be | |
6454 valid for the result as well. A trailing path separator is | |
6455 not removed either. | |
6456 Example: > | |
6457 simplify("./dir/.././/file/") == "./file/" | |
6458 < Note: The combination "dir/.." is only removed if "dir" is | |
6459 a searchable directory or does not exist. On Unix, it is also | |
6460 removed when "dir" is a symbolic link within the same | |
6461 directory. In order to resolve all the involved symbolic | |
6462 links before simplifying the path name, use |resolve()|. | |
6463 | |
82 | 6464 |
1621 | 6465 sin({expr}) *sin()* |
6466 Return the sine of {expr}, measured in radians, as a |Float|. | |
6467 {expr} must evaluate to a |Float| or a |Number|. | |
6468 Examples: > | |
6469 :echo sin(100) | |
6470 < -0.506366 > | |
6471 :echo sin(-4.01) | |
6472 < 0.763301 | |
6473 {only available when compiled with the |+float| feature} | |
6474 | |
6475 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6476 sinh({expr}) *sinh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6477 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
|
6478 [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6479 {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
|
6480 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6481 :echo sinh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6482 < 0.521095 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6483 :echo sinh(-0.9) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6484 < -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
|
6485 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6486 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6487 |
2902 | 6488 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
5747 | 6489 Sort the items in {list} in-place. Returns {list}. |
6490 | |
6491 If you want a list to remain unmodified make a copy first: > | |
82 | 6492 :let sortedlist = sort(copy(mylist)) |
5968 | 6493 |
6009 | 6494 < When {func} is omitted, is empty or zero, then sort() uses the |
6495 string representation of each item to sort on. Numbers sort | |
6496 after Strings, |Lists| after Numbers. For sorting text in the | |
6497 current buffer use |:sort|. | |
6498 | |
6180 | 6499 When {func} is given and it is '1' or 'i' then case is |
6009 | 6500 ignored. |
6501 | |
6502 When {func} is given and it is 'n' then all items will be | |
6503 sorted numerical (Implementation detail: This uses the | |
6504 strtod() function to parse numbers, Strings, Lists, Dicts and | |
6505 Funcrefs will be considered as being 0). | |
6506 | |
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
6507 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
|
6508 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
|
6509 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
|
6510 |
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6511 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
|
6512 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
|
6513 |
685 | 6514 When {func} is a |Funcref| or a function name, this function |
6515 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
|
6516 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
|
6517 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
|
6518 smaller if the first one sorts before the second one. |
5747 | 6519 |
6520 {dict} is for functions with the "dict" attribute. It will be | |
6521 used to set the local variable "self". |Dictionary-function| | |
6522 | |
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6523 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
|
6524 string) will keep their relative position. E.g., when sorting |
6051 | 6525 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
|
6526 same order as they were originally. |
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6527 |
5747 | 6528 Also see |uniq()|. |
6529 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6530 Example: > |
82 | 6531 func MyCompare(i1, i2) |
6532 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
6533 endfunc | |
6534 let sortedlist = sort(mylist, "MyCompare") | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6535 < A shorter compare version for this specific simple case, which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6536 ignores overflow: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6537 func MyCompare(i1, i2) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6538 return a:i1 - a:i2 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6539 endfunc |
344 | 6540 < |
374 | 6541 *soundfold()* |
6542 soundfold({word}) | |
6543 Return the sound-folded equivalent of {word}. Uses the first | |
1621 | 6544 language in 'spelllang' for the current window that supports |
375 | 6545 soundfolding. 'spell' must be set. When no sound folding is |
6546 possible the {word} is returned unmodified. | |
374 | 6547 This can be used for making spelling suggestions. Note that |
6548 the method can be quite slow. | |
6549 | |
344 | 6550 *spellbadword()* |
532 | 6551 spellbadword([{sentence}]) |
6552 Without argument: The result is the badly spelled word under | |
6553 or after the cursor. The cursor is moved to the start of the | |
6554 bad word. When no bad word is found in the cursor line the | |
6555 result is an empty string and the cursor doesn't move. | |
6556 | |
6557 With argument: The result is the first word in {sentence} that | |
6558 is badly spelled. If there are no spelling mistakes the | |
6559 result is an empty string. | |
6560 | |
6561 The return value is a list with two items: | |
6562 - The badly spelled word or an empty string. | |
6563 - The type of the spelling error: | |
856 | 6564 "bad" spelling mistake |
532 | 6565 "rare" rare word |
6566 "local" word only valid in another region | |
6567 "caps" word should start with Capital | |
6568 Example: > | |
6569 echo spellbadword("the quik brown fox") | |
6570 < ['quik', 'bad'] ~ | |
6571 | |
6572 The spelling information for the current window is used. The | |
6573 'spell' option must be set and the value of 'spelllang' is | |
6574 used. | |
344 | 6575 |
6576 *spellsuggest()* | |
537 | 6577 spellsuggest({word} [, {max} [, {capital}]]) |
685 | 6578 Return a |List| with spelling suggestions to replace {word}. |
344 | 6579 When {max} is given up to this number of suggestions are |
6580 returned. Otherwise up to 25 suggestions are returned. | |
6581 | |
537 | 6582 When the {capital} argument is given and it's non-zero only |
6583 suggestions with a leading capital will be given. Use this | |
6584 after a match with 'spellcapcheck'. | |
6585 | |
344 | 6586 {word} can be a badly spelled word followed by other text. |
6587 This allows for joining two words that were split. The | |
359 | 6588 suggestions also include the following text, thus you can |
6589 replace a line. | |
6590 | |
6591 {word} may also be a good word. Similar words will then be | |
537 | 6592 returned. {word} itself is not included in the suggestions, |
6593 although it may appear capitalized. | |
344 | 6594 |
6595 The spelling information for the current window is used. The | |
375 | 6596 'spell' option must be set and the values of 'spelllang' and |
6597 'spellsuggest' are used. | |
344 | 6598 |
82 | 6599 |
282 | 6600 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
685 | 6601 Make a |List| out of {expr}. When {pattern} is omitted or |
6602 empty each white-separated sequence of characters becomes an | |
6603 item. | |
82 | 6604 Otherwise the string is split where {pattern} matches, |
3920 | 6605 removing the matched characters. 'ignorecase' is not used |
6606 here, add \c to ignore case. |/\c| | |
282 | 6607 When the first or last item is empty it is omitted, unless the |
6608 {keepempty} argument is given and it's non-zero. | |
293 | 6609 Other empty items are kept when {pattern} matches at least one |
6610 character or when {keepempty} is non-zero. | |
82 | 6611 Example: > |
95 | 6612 :let words = split(getline('.'), '\W\+') |
282 | 6613 < To split a string in individual characters: > |
236 | 6614 :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
|
6615 < 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
|
6616 the end of the pattern: > |
258 | 6617 :echo split('abc:def:ghi', ':\zs') |
6618 < ['abc:', 'def:', 'ghi'] ~ | |
282 | 6619 Splitting a table where the first element can be empty: > |
6620 :let items = split(line, ':', 1) | |
6621 < The opposite function is |join()|. | |
82 | 6622 |
6623 | |
1621 | 6624 sqrt({expr}) *sqrt()* |
6625 Return the non-negative square root of Float {expr} as a | |
6626 |Float|. | |
6627 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
6628 is negative the result is NaN (Not a Number). | |
6629 Examples: > | |
6630 :echo sqrt(100) | |
6631 < 10.0 > | |
6632 :echo sqrt(-4.01) | |
6633 < nan | |
1668 | 6634 "nan" may be different, it depends on system libraries. |
1621 | 6635 {only available when compiled with the |+float| feature} |
6636 | |
6637 | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
6638 str2float({expr}) *str2float()* |
1621 | 6639 Convert String {expr} to a Float. This mostly works the same |
6640 as when using a floating point number in an expression, see | |
6641 |floating-point-format|. But it's a bit more permissive. | |
6642 E.g., "1e40" is accepted, while in an expression you need to | |
6643 write "1.0e40". | |
6644 Text after the number is silently ignored. | |
6645 The decimal point is always '.', no matter what the locale is | |
6646 set to. A comma ends the number: "12,345.67" is converted to | |
6647 12.0. You can strip out thousands separators with | |
6648 |substitute()|: > | |
6649 let f = str2float(substitute(text, ',', '', 'g')) | |
6650 < {only available when compiled with the |+float| feature} | |
6651 | |
6652 | |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
6653 str2nr({expr} [, {base}]) *str2nr()* |
782 | 6654 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
|
6655 {base} is the conversion base, it can be 2, 8, 10 or 16. |
782 | 6656 When {base} is omitted base 10 is used. This also means that |
6657 a leading zero doesn't cause octal conversion to be used, as | |
6658 with the default String to Number conversion. | |
6659 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
|
6660 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
|
6661 {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
|
6662 leading "0b" or "0B" is ignored. |
782 | 6663 Text after the number is silently ignored. |
856 | 6664 |
782 | 6665 |
6884 | 6666 strchars({expr} [, {skipcc}]) *strchars()* |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6667 The result is a Number, which is the number of characters |
6884 | 6668 in String {expr}. |
6669 When {skipcc} is omitted or zero, composing characters are | |
6670 counted separately. | |
6671 When {skipcc} set to 1, Composing characters are ignored. | |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6672 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
6918 | 6673 |
6674 {skipcc} is only available after 7.4.755. For backward | |
6675 compatibility, you can define a wrapper function: > | |
6676 if has("patch-7.4.755") | |
6677 function s:strchars(str, skipcc) | |
6678 return strchars(a:str, a:skipcc) | |
6679 endfunction | |
6680 else | |
6681 function s:strchars(str, skipcc) | |
6682 if a:skipcc | |
6683 return strlen(substitute(a:str, ".", "x", "g")) | |
6684 else | |
6685 return strchars(a:str) | |
6686 endif | |
6687 endfunction | |
6688 endif | |
6689 < | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6690 strcharpart({src}, {start}[, {len}]) *strcharpart()* |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6691 Like |strpart()| but using character index and length instead |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6692 of byte index and length. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6693 When a character index is used where a character does not |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6694 exist it is assumed to be one byte. For example: > |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6695 strcharpart('abc', -1, 2) |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6696 < results in 'a'. |
6918 | 6697 |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6698 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6699 The result is a Number, which is the number of display cells |
6884 | 6700 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
|
6701 When {col} is omitted zero is used. Otherwise it is the |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6702 screen column where to start. This matters for Tab |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6703 characters. |
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6704 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
|
6705 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
|
6706 'tabstop' and 'display'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6707 When {expr} contains characters with East Asian Width Class |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6708 Ambiguous, this function's return value depends on 'ambiwidth'. |
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6709 Also see |strlen()|, |strwidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6710 |
7 | 6711 strftime({format} [, {time}]) *strftime()* |
6712 The result is a String, which is a formatted date and time, as | |
6713 specified by the {format} string. The given {time} is used, | |
6714 or the current time if no time is given. The accepted | |
6715 {format} depends on your system, thus this is not portable! | |
6716 See the manual page of the C function strftime() for the | |
6717 format. The maximum length of the result is 80 characters. | |
6718 See also |localtime()| and |getftime()|. | |
6719 The language can be changed with the |:language| command. | |
6720 Examples: > | |
6721 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
6722 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
6723 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
6724 :echo strftime("%H:%M") 11:55 | |
6725 :echo strftime("%c", getftime("file.c")) | |
6726 Show mod time of file.c. | |
82 | 6727 < Not available on all systems. To check use: > |
6728 :if exists("*strftime") | |
6729 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6730 strgetchar({str}, {index}) *strgetchar()* |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6731 Get character {index} from {str}. This uses a character |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6732 index, not a byte index. Composing characters are considered |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6733 separate characters here. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6734 Also see |strcharpart()| and |strchars()|. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6735 |
133 | 6736 stridx({haystack}, {needle} [, {start}]) *stridx()* |
6737 The result is a Number, which gives the byte index in | |
6738 {haystack} of the first occurrence of the String {needle}. | |
140 | 6739 If {start} is specified, the search starts at index {start}. |
6740 This can be used to find a second match: > | |
2662 | 6741 :let colon1 = stridx(line, ":") |
6742 :let colon2 = stridx(line, ":", colon1 + 1) | |
140 | 6743 < The search is done case-sensitive. |
205 | 6744 For pattern searches use |match()|. |
133 | 6745 -1 is returned if the {needle} does not occur in {haystack}. |
140 | 6746 See also |strridx()|. |
6747 Examples: > | |
7 | 6748 :echo stridx("An Example", "Example") 3 |
6749 :echo stridx("Starting point", "Start") 0 | |
6750 :echo stridx("Starting point", "start") -1 | |
856 | 6751 < *strstr()* *strchr()* |
170 | 6752 stridx() works similar to the C function strstr(). When used |
6753 with a single character it works similar to strchr(). | |
6754 | |
55 | 6755 *string()* |
95 | 6756 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
1621 | 6757 Float, String or a composition of them, then the result can be |
6758 parsed back with |eval()|. | |
55 | 6759 {expr} type result ~ |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6760 String 'string' (single quotes are doubled) |
95 | 6761 Number 123 |
1621 | 6762 Float 123.123456 or 1.123456e8 |
99 | 6763 Funcref function('name') |
95 | 6764 List [item, item] |
323 | 6765 Dictionary {key: value, key: value} |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6766 |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6767 When a List or Dictionary has a recursive reference it is |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6768 replaced by "[...]" or "{...}". Using eval() on the result |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6769 will then fail. |
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
6770 |
1156 | 6771 Also see |strtrans()|. |
55 | 6772 |
7 | 6773 *strlen()* |
6774 strlen({expr}) The result is a Number, which is the length of the String | |
502 | 6775 {expr} in bytes. |
55 | 6776 If the argument is a Number it is first converted to a String. |
6777 For other types an error is given. | |
6870 | 6778 If you want to count the number of multi-byte characters use |
6779 |strchars()|. | |
6780 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
7 | 6781 |
6782 strpart({src}, {start}[, {len}]) *strpart()* | |
6783 The result is a String, which is part of {src}, starting from | |
574 | 6784 byte {start}, with the byte length {len}. |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6785 To count characters instead of bytes use |strcharpart()|. |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6786 |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6787 When bytes are selected which do not exist, this doesn't |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6788 result in an error, the bytes are simply omitted. |
7 | 6789 If {len} is missing, the copy continues from {start} till the |
6790 end of the {src}. > | |
6791 strpart("abcdefg", 3, 2) == "de" | |
6792 strpart("abcdefg", -2, 4) == "ab" | |
6793 strpart("abcdefg", 5, 4) == "fg" | |
1621 | 6794 strpart("abcdefg", 3) == "defg" |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
6795 |
7 | 6796 < Note: To get the first character, {start} must be 0. For |
6797 example, to get three bytes under and after the cursor: > | |
823 | 6798 strpart(getline("."), col(".") - 1, 3) |
7 | 6799 < |
140 | 6800 strridx({haystack}, {needle} [, {start}]) *strridx()* |
6801 The result is a Number, which gives the byte index in | |
6802 {haystack} of the last occurrence of the String {needle}. | |
6803 When {start} is specified, matches beyond this index are | |
6804 ignored. This can be used to find a match before a previous | |
6805 match: > | |
6806 :let lastcomma = strridx(line, ",") | |
6807 :let comma2 = strridx(line, ",", lastcomma - 1) | |
6808 < The search is done case-sensitive. | |
133 | 6809 For pattern searches use |match()|. |
6810 -1 is returned if the {needle} does not occur in {haystack}. | |
22 | 6811 If the {needle} is empty the length of {haystack} is returned. |
236 | 6812 See also |stridx()|. Examples: > |
7 | 6813 :echo strridx("an angry armadillo", "an") 3 |
856 | 6814 < *strrchr()* |
170 | 6815 When used with a single character it works similar to the C |
6816 function strrchr(). | |
6817 | |
7 | 6818 strtrans({expr}) *strtrans()* |
6819 The result is a String, which is {expr} with all unprintable | |
6820 characters translated into printable characters |'isprint'|. | |
6821 Like they are shown in a window. Example: > | |
6822 echo strtrans(@a) | |
6823 < This displays a newline in register a as "^@" instead of | |
6824 starting a new line. | |
6825 | |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6826 strwidth({expr}) *strwidth()* |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6827 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
|
6828 String {expr} occupies. A Tab character is counted as one |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6829 cell, alternatively use |strdisplaywidth()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6830 When {expr} contains characters with East Asian Width Class |
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6831 Ambiguous, this function's return value depends on 'ambiwidth'. |
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6832 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6833 |
5794 | 6834 submatch({nr}[, {list}]) *submatch()* |
2908 | 6835 Only for an expression in a |:substitute| command or |
6836 substitute() function. | |
6837 Returns the {nr}'th submatch of the matched text. When {nr} | |
6838 is 0 the whole matched text is returned. | |
5794 | 6839 Note that a NL in the string can stand for a line break of a |
6840 multi-line match or a NUL character in the text. | |
2908 | 6841 Also see |sub-replace-expression|. |
5794 | 6842 |
6843 If {list} is present and non-zero then submatch() returns | |
6844 a list of strings, similar to |getline()| with two arguments. | |
6845 NL characters in the text represent NUL characters in the | |
6846 text. | |
6847 Only returns more than one item for |:substitute|, inside | |
6848 |substitute()| this list will always contain one or zero | |
6849 items, since there are no real line breaks. | |
6850 | |
7 | 6851 Example: > |
6852 :s/\d\+/\=submatch(0) + 1/ | |
6853 < This finds the first number in the line and adds one to it. | |
6854 A line break is included as a newline character. | |
6855 | |
6856 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
6857 The result is a String, which is a copy of {expr}, in which | |
2908 | 6858 the first match of {pat} is replaced with {sub}. |
6859 When {flags} is "g", all matches of {pat} in {expr} are | |
6860 replaced. Otherwise {flags} should be "". | |
6861 | |
6862 This works like the ":substitute" command (without any flags). | |
6863 But the matching with {pat} is always done like the 'magic' | |
6864 option is set and 'cpoptions' is empty (to make scripts | |
3967 | 6865 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
6866 if you want to ignore or match case and ignore 'ignorecase'. | |
6867 'smartcase' is not used. See |string-match| for how {pat} is | |
6868 used. | |
2908 | 6869 |
6870 A "~" in {sub} is not replaced with the previous {sub}. | |
7 | 6871 Note that some codes in {sub} have a special meaning |
1621 | 6872 |sub-replace-special|. For example, to replace something with |
7 | 6873 "\n" (two characters), use "\\\\n" or '\\n'. |
2908 | 6874 |
7 | 6875 When {pat} does not match in {expr}, {expr} is returned |
6876 unmodified. | |
2908 | 6877 |
7 | 6878 Example: > |
6879 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
6880 < This removes the last component of the 'path' option. > | |
6881 :echo substitute("testing", ".*", "\\U\\0", "") | |
6882 < results in "TESTING". | |
2908 | 6883 |
6884 When {sub} starts with "\=", the remainder is interpreted as | |
6885 an expression. See |sub-replace-expression|. Example: > | |
2833 | 6886 :echo substitute(s, '%\(\x\x\)', |
6887 \ '\=nr2char("0x" . submatch(1))', 'g') | |
7 | 6888 |
32 | 6889 synID({lnum}, {col}, {trans}) *synID()* |
7 | 6890 The result is a Number, which is the syntax ID at the position |
32 | 6891 {lnum} and {col} in the current window. |
7 | 6892 The syntax ID can be used with |synIDattr()| and |
6893 |synIDtrans()| to obtain syntax information about text. | |
419 | 6894 |
32 | 6895 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
419 | 6896 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
|
6897 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
|
6898 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
|
6899 zero. |
419 | 6900 |
7 | 6901 When {trans} is non-zero, transparent items are reduced to the |
1621 | 6902 item that they reveal. This is useful when wanting to know |
7 | 6903 the effective color. When {trans} is zero, the transparent |
6904 item is returned. This is useful when wanting to know which | |
6905 syntax item is effective (e.g. inside parens). | |
6906 Warning: This function can be very slow. Best speed is | |
6907 obtained by going through the file in forward direction. | |
6908 | |
6909 Example (echoes the name of the syntax item under the cursor): > | |
6910 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
6911 < | |
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6912 |
7 | 6913 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
6914 The result is a String, which is the {what} attribute of | |
6915 syntax ID {synID}. This can be used to obtain information | |
6916 about a syntax item. | |
6917 {mode} can be "gui", "cterm" or "term", to get the attributes | |
1621 | 6918 for that mode. When {mode} is omitted, or an invalid value is |
7 | 6919 used, the attributes for the currently active highlighting are |
6920 used (GUI, cterm or term). | |
6921 Use synIDtrans() to follow linked highlight groups. | |
6922 {what} result | |
6923 "name" the name of the syntax item | |
6924 "fg" foreground color (GUI: color name used to set | |
6925 the color, cterm: color number as a string, | |
6926 term: empty string) | |
1755 | 6927 "bg" background color (as with "fg") |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6928 "font" font name (only available in the GUI) |
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6929 |highlight-font| |
1755 | 6930 "sp" special color (as with "fg") |highlight-guisp| |
7 | 6931 "fg#" like "fg", but for the GUI and the GUI is |
6932 running the name in "#RRGGBB" form | |
6933 "bg#" like "fg#" for "bg" | |
1755 | 6934 "sp#" like "fg#" for "sp" |
7 | 6935 "bold" "1" if bold |
6936 "italic" "1" if italic | |
6937 "reverse" "1" if reverse | |
6938 "inverse" "1" if inverse (= reverse) | |
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6939 "standout" "1" if standout |
7 | 6940 "underline" "1" if underlined |
205 | 6941 "undercurl" "1" if undercurled |
7 | 6942 |
6943 Example (echoes the color of the syntax item under the | |
6944 cursor): > | |
6945 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
6946 < | |
6947 synIDtrans({synID}) *synIDtrans()* | |
6948 The result is a Number, which is the translated syntax ID of | |
6949 {synID}. This is the syntax group ID of what is being used to | |
6950 highlight the character. Highlight links given with | |
6951 ":highlight link" are followed. | |
6952 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6953 synconcealed({lnum}, {col}) *synconcealed()* |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6954 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
|
6955 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
|
6956 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
|
6957 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
|
6958 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
|
6959 depending on the current setting of 'conceallevel'. The third |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6960 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
|
6961 specific syntax region matched. This allows detection of the |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6962 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
|
6963 consecutive regions with the same replacement character. |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6964 For an example use see $VIMRUNTIME/syntax/2html.vim . |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6965 |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6966 |
1500 | 6967 synstack({lnum}, {col}) *synstack()* |
6968 Return a |List|, which is the stack of syntax items at the | |
6969 position {lnum} and {col} in the current window. Each item in | |
6970 the List is an ID like what |synID()| returns. | |
6971 The first item in the List is the outer region, following are | |
6972 items contained in that one. The last one is what |synID()| | |
6973 returns, unless not the whole item is highlighted or it is a | |
6974 transparent item. | |
6975 This function is useful for debugging a syntax file. | |
6976 Example that shows the syntax stack under the cursor: > | |
6977 for id in synstack(line("."), col(".")) | |
6978 echo synIDattr(id, "name") | |
6979 endfor | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6980 < 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
|
6981 nothing is returned. The position just after the last |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6982 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
|
6983 valid positions. |
1500 | 6984 |
24 | 6985 system({expr} [, {input}]) *system()* *E677* |
5808 | 6986 Get the output of the shell command {expr} as a string. See |
6987 |systemlist()| to get the output as a List. | |
5806 | 6988 |
6989 When {input} is given and is a string this string is written | |
6990 to a file and passed as stdin to the command. The string is | |
6991 written as-is, you need to take care of using the correct line | |
6992 separators yourself. | |
6993 If {input} is given and is a |List| it is written to the file | |
6994 in a way |writefile()| does with {binary} set to "b" (i.e. | |
6995 with a newline between each list item with newlines inside | |
6996 list items converted to NULs). | |
6997 Pipes are not used. | |
6998 | |
6183 | 6999 When prepended by |:silent| the shell will not be set to |
7000 cooked mode. This is meant to be used for commands that do | |
7001 not need the user to type. It avoids stray characters showing | |
7002 up on the screen which require |CTRL-L| to remove. > | |
7003 :silent let f = system('ls *.vim') | |
7004 < | |
5690 | 7005 Note: Use |shellescape()| or |::S| with |expand()| or |
7006 |fnamemodify()| to escape special characters in a command | |
7007 argument. Newlines in {expr} may cause the command to fail. | |
7008 The characters in 'shellquote' and 'shellxquote' may also | |
7009 cause trouble. | |
7 | 7010 This is not to be used for interactive commands. |
1661 | 7011 |
7 | 7012 The result is a String. Example: > |
1661 | 7013 :let files = system("ls " . shellescape(expand('%:h'))) |
5690 | 7014 :let files = system('ls ' . expand('%:h:S')) |
7 | 7015 |
7016 < To make the result more system-independent, the shell output | |
7017 is filtered to replace <CR> with <NL> for Macintosh, and | |
7018 <CR><NL> with <NL> for DOS-like systems. | |
5277 | 7019 To avoid the string being truncated at a NUL, all NUL |
7020 characters are replaced with SOH (0x01). | |
7021 | |
7 | 7022 The command executed is constructed using several options: |
7023 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
7024 ({tmp} is an automatically generated file name). | |
7025 For Unix and OS/2 braces are put around {expr} to allow for | |
7026 concatenated commands. | |
7027 | |
794 | 7028 The command will be executed in "cooked" mode, so that a |
7029 CTRL-C will interrupt the command (on Unix at least). | |
7030 | |
7 | 7031 The resulting error code can be found in |v:shell_error|. |
7032 This function will fail in |restricted-mode|. | |
625 | 7033 |
7034 Note that any wrong value in the options mentioned above may | |
7035 make the function fail. It has also been reported to fail | |
7036 when using a security agent application. | |
7 | 7037 Unlike ":!cmd" there is no automatic check for changed files. |
7038 Use |:checktime| to force a check. | |
7039 | |
205 | 7040 |
5808 | 7041 systemlist({expr} [, {input}]) *systemlist()* |
7042 Same as |system()|, but returns a |List| with lines (parts of | |
7043 output separated by NL) with NULs transformed into NLs. Output | |
7044 is the same as |readfile()| will output with {binary} argument | |
7045 set to "b". | |
7046 | |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7047 Returns an empty string on error. |
5808 | 7048 |
7049 | |
677 | 7050 tabpagebuflist([{arg}]) *tabpagebuflist()* |
685 | 7051 The result is a |List|, where each item is the number of the |
677 | 7052 buffer associated with each window in the current tab page. |
7053 {arg} specifies the number of tab page to be used. When | |
7054 omitted the current tab page is used. | |
7055 When {arg} is invalid the number zero is returned. | |
7056 To get a list of all buffers in all tabs use this: > | |
3445 | 7057 let buflist = [] |
677 | 7058 for i in range(tabpagenr('$')) |
3445 | 7059 call extend(buflist, tabpagebuflist(i + 1)) |
677 | 7060 endfor |
7061 < Note that a buffer may appear in more than one window. | |
7062 | |
7063 | |
7064 tabpagenr([{arg}]) *tabpagenr()* | |
674 | 7065 The result is a Number, which is the number of the current |
7066 tab page. The first tab page has number 1. | |
7067 When the optional argument is "$", the number of the last tab | |
7068 page is returned (the tab page count). | |
7069 The number can be used with the |:tab| command. | |
7070 | |
7071 | |
5763 | 7072 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7073 Like |winnr()| but for tab page {tabarg}. |
677 | 7074 {tabarg} specifies the number of tab page to be used. |
7075 {arg} is used like with |winnr()|: | |
7076 - When omitted the current window number is returned. This is | |
7077 the window which will be used when going to this tab page. | |
7078 - When "$" the number of windows is returned. | |
7079 - When "#" the previous window nr is returned. | |
7080 Useful examples: > | |
7081 tabpagewinnr(1) " current window of tab page 1 | |
7082 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
7083 < When {tabarg} is invalid zero is returned. | |
7084 | |
805 | 7085 *tagfiles()* |
7086 tagfiles() Returns a |List| with the file names used to search for tags | |
7087 for the current buffer. This is the 'tags' option expanded. | |
7088 | |
7089 | |
205 | 7090 taglist({expr}) *taglist()* |
7091 Returns a list of tags matching the regular expression {expr}. | |
438 | 7092 Each list item is a dictionary with at least the following |
7093 entries: | |
648 | 7094 name Name of the tag. |
7095 filename Name of the file where the tag is | |
1156 | 7096 defined. It is either relative to the |
7097 current directory or a full path. | |
205 | 7098 cmd Ex command used to locate the tag in |
7099 the file. | |
648 | 7100 kind Type of the tag. The value for this |
205 | 7101 entry depends on the language specific |
1156 | 7102 kind values. Only available when |
7103 using a tags file generated by | |
7104 Exuberant ctags or hdrtag. | |
648 | 7105 static A file specific tag. Refer to |
205 | 7106 |static-tag| for more information. |
1156 | 7107 More entries may be present, depending on the content of the |
7108 tags file: access, implementation, inherits and signature. | |
7109 Refer to the ctags documentation for information about these | |
7110 fields. For C code the fields "struct", "class" and "enum" | |
7111 may appear, they give the name of the entity the tag is | |
7112 contained in. | |
452 | 7113 |
216 | 7114 The ex-command 'cmd' can be either an ex search pattern, a |
7115 line number or a line number followed by a byte number. | |
205 | 7116 |
7117 If there are no matching tags, then an empty list is returned. | |
7118 | |
7119 To get an exact tag match, the anchors '^' and '$' should be | |
4073 | 7120 used in {expr}. This also make the function work faster. |
7121 Refer to |tag-regexp| for more information about the tag | |
7122 search regular expression pattern. | |
205 | 7123 |
7124 Refer to |'tags'| for information about how the tags file is | |
7125 located by Vim. Refer to |tags-file-format| for the format of | |
7126 the tags file generated by the different ctags tools. | |
7127 | |
7 | 7128 tempname() *tempname()* *temp-file-name* |
7129 The result is a String, which is the name of a file that | |
1621 | 7130 doesn't exist. It can be used for a temporary file. The name |
7 | 7131 is different for at least 26 consecutive calls. Example: > |
7132 :let tmpfile = tempname() | |
7133 :exe "redir > " . tmpfile | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7134 < For Unix, the file will be in a private directory |tempfile|. |
7 | 7135 For MS-Windows forward slashes are used when the 'shellslash' |
7136 option is set or when 'shellcmdflag' starts with '-'. | |
7137 | |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7138 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7139 tan({expr}) *tan()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7140 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
|
7141 in the range [-inf, inf]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7142 {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
|
7143 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7144 :echo tan(10) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7145 < 0.648361 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7146 :echo tan(-4.01) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7147 < -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
|
7148 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7149 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7150 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7151 tanh({expr}) *tanh()* |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7152 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
|
7153 range [-1, 1]. |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7154 {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
|
7155 Examples: > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7156 :echo tanh(0.5) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7157 < 0.462117 > |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7158 :echo tanh(-1) |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7159 < -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
|
7160 {only available when compiled with the |+float| feature} |
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7161 |
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7162 |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7163 *timer_start()* |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7164 timer_start({time}, {callback} [, {options}]) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7165 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
|
7166 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7167 {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
|
7168 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
|
7169 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
|
7170 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7171 {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
|
7172 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
|
7173 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
|
7174 waiting for input. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7175 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7176 {options} is a dictionary. Supported entries: |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7177 "repeat" Number of times to repeat calling the |
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7178 callback. -1 means forever. |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7179 |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7180 Example: > |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7181 func MyHandler(timer) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7182 echo 'Handler called' |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7183 endfunc |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7184 let timer = timer_start(500, 'MyHandler', |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7185 \ {'repeat': 3}) |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7186 < 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
|
7187 intervals. |
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7188 {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
|
7189 |
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7190 timer_stop({timer}) *timer_stop()* |
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7191 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
|
7192 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
|
7193 |
7 | 7194 tolower({expr}) *tolower()* |
7195 The result is a copy of the String given, with all uppercase | |
7196 characters turned into lowercase (just like applying |gu| to | |
7197 the string). | |
7198 | |
7199 toupper({expr}) *toupper()* | |
7200 The result is a copy of the String given, with all lowercase | |
7201 characters turned into uppercase (just like applying |gU| to | |
7202 the string). | |
7203 | |
15 | 7204 tr({src}, {fromstr}, {tostr}) *tr()* |
7205 The result is a copy of the {src} string with all characters | |
7206 which appear in {fromstr} replaced by the character in that | |
7207 position in the {tostr} string. Thus the first character in | |
7208 {fromstr} is translated into the first character in {tostr} | |
7209 and so on. Exactly like the unix "tr" command. | |
7210 This code also deals with multibyte characters properly. | |
7211 | |
7212 Examples: > | |
7213 echo tr("hello there", "ht", "HT") | |
7214 < returns "Hello THere" > | |
7215 echo tr("<blob>", "<>", "{}") | |
7216 < returns "{blob}" | |
7217 | |
1621 | 7218 trunc({expr}) *trunc()* |
1668 | 7219 Return the largest integral value with magnitude less than or |
1621 | 7220 equal to {expr} as a |Float| (truncate towards zero). |
7221 {expr} must evaluate to a |Float| or a |Number|. | |
7222 Examples: > | |
7223 echo trunc(1.456) | |
7224 < 1.0 > | |
7225 echo trunc(-5.456) | |
7226 < -5.0 > | |
7227 echo trunc(4.0) | |
7228 < 4.0 | |
7229 {only available when compiled with the |+float| feature} | |
7230 | |
87 | 7231 *type()* |
7232 type({expr}) The result is a Number, depending on the type of {expr}: | |
153 | 7233 Number: 0 |
7234 String: 1 | |
7235 Funcref: 2 | |
7236 List: 3 | |
7237 Dictionary: 4 | |
1621 | 7238 Float: 5 |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
7239 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
|
7240 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
|
7241 Job 8 |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
7242 Channel 9 |
153 | 7243 To avoid the magic numbers it should be used this way: > |
87 | 7244 :if type(myvar) == type(0) |
7245 :if type(myvar) == type("") | |
7246 :if type(myvar) == type(function("tr")) | |
7247 :if type(myvar) == type([]) | |
153 | 7248 :if type(myvar) == type({}) |
1621 | 7249 :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
|
7250 :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
|
7251 :if type(myvar) == type(v:none) |
7 | 7252 |
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7253 undofile({name}) *undofile()* |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7254 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
|
7255 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
|
7256 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
|
7257 the undo file exists. |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
7258 {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
|
7259 is used internally. |
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
7260 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
|
7261 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
|
7262 Useful in combination with |:wundo| and |:rundo|. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7263 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
|
7264 returns an empty string. |
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7265 |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7266 undotree() *undotree()* |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7267 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
|
7268 the following items: |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7269 "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
|
7270 "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
|
7271 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
|
7272 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
|
7273 "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
|
7274 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
|
7275 something readable. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7276 "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
|
7277 write yet. |
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
7278 "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
|
7279 tree. |
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7280 "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
|
7281 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
|
7282 user. See |undo-blocks|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7283 "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
|
7284 undo blocks. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7285 |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7286 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
|
7287 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
|
7288 "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
|
7289 |:undolist|. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7290 "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
|
7291 |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
|
7292 "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
|
7293 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
|
7294 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
|
7295 "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
|
7296 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
|
7297 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
|
7298 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
|
7299 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
|
7300 not appear anywhere. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7301 "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
|
7302 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
|
7303 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
|
7304 "save_last" mentioned above. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7305 "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
|
7306 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
|
7307 item. |
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7308 |
5747 | 7309 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
7310 Remove second and succeeding copies of repeated adjacent | |
7311 {list} items in-place. Returns {list}. If you want a list | |
7312 to remain unmodified make a copy first: > | |
7313 :let newlist = uniq(copy(mylist)) | |
7314 < The default compare function uses the string representation of | |
7315 each item. For the use of {func} and {dict} see |sort()|. | |
7316 | |
140 | 7317 values({dict}) *values()* |
1621 | 7318 Return a |List| with all the values of {dict}. The |List| is |
685 | 7319 in arbitrary order. |
140 | 7320 |
7321 | |
7 | 7322 virtcol({expr}) *virtcol()* |
7323 The result is a Number, which is the screen column of the file | |
7324 position given with {expr}. That is, the last screen position | |
7325 occupied by the character at that position, when the screen | |
7326 would be of unlimited width. When there is a <Tab> at the | |
7327 position, the returned Number will be the column at the end of | |
7328 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
3445 | 7329 set to 8, it returns 8. |conceal| is ignored. |
1317 | 7330 For the byte position use |col()|. |
7331 For the use of {expr} see |col()|. | |
7332 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
703 | 7333 "off" is the offset in screen columns from the start of the |
1266 | 7334 character. E.g., a position within a <Tab> or after the last |
2965 | 7335 character. When "off" is omitted zero is used. |
7 | 7336 When Virtual editing is active in the current mode, a position |
7337 beyond the end of the line can be returned. |'virtualedit'| | |
7338 The accepted positions are: | |
7339 . the cursor position | |
7340 $ the end of the cursor line (the result is the | |
7341 number of displayed characters in the cursor line | |
7342 plus one) | |
7343 'x position of mark x (if the mark is not set, 0 is | |
7344 returned) | |
6447 | 7345 v In Visual mode: the start of the Visual area (the |
7346 cursor is the end). When not in Visual mode | |
7347 returns the cursor position. Differs from |'<| in | |
7348 that it's updated right away. | |
7 | 7349 Note that only marks in the current file can be used. |
7350 Examples: > | |
7351 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
7352 virtcol("$") with text "foo^Lbar", returns 9 | |
1621 | 7353 virtcol("'t") with text " there", with 't at 'h', returns 6 |
7354 < The first column is 1. 0 is returned for an error. | |
1156 | 7355 A more advanced example that echoes the maximum length of |
7356 all lines: > | |
7357 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
7358 | |
7 | 7359 |
7360 visualmode([expr]) *visualmode()* | |
7361 The result is a String, which describes the last Visual mode | |
856 | 7362 used in the current buffer. Initially it returns an empty |
7363 string, but once Visual mode has been used, it returns "v", | |
7364 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
7365 character-wise, line-wise, or block-wise Visual mode | |
7366 respectively. | |
7 | 7367 Example: > |
7368 :exe "normal " . visualmode() | |
7369 < This enters the same Visual mode as before. It is also useful | |
7370 in scripts if you wish to act differently depending on the | |
7371 Visual mode that was used. | |
1621 | 7372 If Visual mode is active, use |mode()| to get the Visual mode |
7373 (e.g., in a |:vmap|). | |
1661 | 7374 *non-zero-arg* |
7375 If [expr] is supplied and it evaluates to a non-zero Number or | |
7376 a non-empty String, then the Visual mode will be cleared and | |
1621 | 7377 the old value is returned. Note that " " and "0" are also |
1661 | 7378 non-empty strings, thus cause the mode to be cleared. A List, |
7379 Dictionary or Float is not a Number or String, thus does not | |
7380 cause the mode to be cleared. | |
7 | 7381 |
4151 | 7382 wildmenumode() *wildmenumode()* |
7383 Returns non-zero when the wildmenu is active and zero | |
7384 otherwise. See 'wildmenu' and 'wildmode'. | |
7385 This can be used in mappings to handle the 'wildcharm' option | |
7386 gracefully. (Makes only sense with |mapmode-c| mappings). | |
7387 | |
7388 For example to make <c-j> work like <down> in wildmode, use: > | |
7389 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
7390 < | |
7391 (Note, this needs the 'wildcharm' option set appropriately). | |
7392 | |
7393 | |
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7394 win_findbuf({bufnr}) *win_findbuf()* |
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
7395 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
|
7396 {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
|
7397 |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7398 win_getid([{win} [, {tab}]]) *win_getid()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7399 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
|
7400 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
|
7401 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
|
7402 number 1. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7403 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
|
7404 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
|
7405 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
|
7406 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7407 win_gotoid({expr}) *win_gotoid()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7408 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
|
7409 tabpage. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7410 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
|
7411 |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7412 win_id2tabwin({expr}) *win_id2tabwin()* |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7413 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
|
7414 with ID {expr}: [tabnr, winnr]. |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7415 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
|
7416 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7417 win_id2win({expr}) *win_id2win()* |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
7418 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
|
7419 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
|
7420 |
7 | 7421 *winbufnr()* |
7422 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
236 | 7423 associated with window {nr}. When {nr} is zero, the number of |
7 | 7424 the buffer in the current window is returned. When window |
7425 {nr} doesn't exist, -1 is returned. | |
7426 Example: > | |
7427 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
7428 < | |
7429 *wincol()* | |
7430 wincol() The result is a Number, which is the virtual column of the | |
7431 cursor in the window. This is counting screen cells from the | |
7432 left side of the window. The leftmost column is one. | |
7433 | |
7434 winheight({nr}) *winheight()* | |
7435 The result is a Number, which is the height of window {nr}. | |
7436 When {nr} is zero, the height of the current window is | |
7437 returned. When window {nr} doesn't exist, -1 is returned. | |
7438 An existing window always has a height of zero or more. | |
7439 Examples: > | |
7440 :echo "The current window has " . winheight(0) . " lines." | |
7441 < | |
7442 *winline()* | |
7443 winline() The result is a Number, which is the screen line of the cursor | |
1621 | 7444 in the window. This is counting screen lines from the top of |
7 | 7445 the window. The first line is one. |
531 | 7446 If the cursor was moved the view on the file will be updated |
7447 first, this may cause a scroll. | |
7 | 7448 |
7449 *winnr()* | |
20 | 7450 winnr([{arg}]) The result is a Number, which is the number of the current |
7451 window. The top window has number 1. | |
7452 When the optional argument is "$", the number of the | |
3967 | 7453 last window is returned (the window count). > |
7454 let window_count = winnr('$') | |
7455 < When the optional argument is "#", the number of the last | |
20 | 7456 accessed window is returned (where |CTRL-W_p| goes to). |
1156 | 7457 If there is no previous window or it is in another tab page 0 |
7458 is returned. | |
20 | 7459 The number can be used with |CTRL-W_w| and ":wincmd w" |
7460 |:wincmd|. | |
1156 | 7461 Also see |tabpagewinnr()|. |
7 | 7462 |
7463 *winrestcmd()* | |
7464 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
7465 the current window sizes. Only works properly when no windows | |
712 | 7466 are opened or closed and the current window and tab page is |
7467 unchanged. | |
7 | 7468 Example: > |
7469 :let cmd = winrestcmd() | |
7470 :call MessWithWindowSizes() | |
7471 :exe cmd | |
712 | 7472 < |
7473 *winrestview()* | |
7474 winrestview({dict}) | |
7475 Uses the |Dictionary| returned by |winsaveview()| to restore | |
7476 the view of the current window. | |
5940 | 7477 Note: The {dict} does not have to contain all values, that are |
7478 returned by |winsaveview()|. If values are missing, those | |
7479 settings won't be restored. So you can use: > | |
7480 :call winrestview({'curswant': 4}) | |
7481 < | |
7482 This will only set the curswant value (the column the cursor | |
7483 wants to move on vertical movements) of the cursor to column 5 | |
7484 (yes, that is 5), while all other settings will remain the | |
7485 same. This is useful, if you set the cursor position manually. | |
7486 | |
712 | 7487 If you have changed the values the result is unpredictable. |
7488 If the window size changed the result won't be the same. | |
7489 | |
7490 *winsaveview()* | |
7491 winsaveview() Returns a |Dictionary| that contains information to restore | |
7492 the view of the current window. Use |winrestview()| to | |
7493 restore the view. | |
7494 This is useful if you have a mapping that jumps around in the | |
7495 buffer and you want to go back to the original view. | |
7496 This does not save fold information. Use the 'foldenable' | |
798 | 7497 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
|
7498 not opened when moving around. This may have side effects. |
712 | 7499 The return value includes: |
7500 lnum cursor line number | |
5940 | 7501 col cursor column (Note: the first column |
7502 zero, as opposed to what getpos() | |
7503 returns) | |
712 | 7504 coladd cursor column offset for 'virtualedit' |
7505 curswant column for vertical movement | |
7506 topline first line in the window | |
7507 topfill filler lines, only in diff mode | |
7508 leftcol first column displayed | |
7509 skipcol columns skipped | |
7510 Note that no option values are saved. | |
7511 | |
7 | 7512 |
7513 winwidth({nr}) *winwidth()* | |
7514 The result is a Number, which is the width of window {nr}. | |
7515 When {nr} is zero, the width of the current window is | |
7516 returned. When window {nr} doesn't exist, -1 is returned. | |
7517 An existing window always has a width of zero or more. | |
7518 Examples: > | |
7519 :echo "The current window has " . winwidth(0) . " columns." | |
7520 :if winwidth(0) <= 50 | |
7521 : exe "normal 50\<C-W>|" | |
7522 :endif | |
7523 < | |
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7524 wordcount() *wordcount()* |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7525 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
|
7526 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
|
7527 |g_CTRL-G| |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7528 The return value includes: |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7529 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
|
7530 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
|
7531 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
|
7532 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
|
7533 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7534 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
|
7535 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7536 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
|
7537 (not in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7538 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
|
7539 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7540 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
|
7541 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7542 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
|
7543 (only in Visual mode) |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7544 |
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
7545 |
158 | 7546 *writefile()* |
6341 | 7547 writefile({list}, {fname} [, {flags}]) |
685 | 7548 Write |List| {list} to file {fname}. Each list item is |
158 | 7549 separated with a NL. Each list item must be a String or |
7550 Number. | |
6341 | 7551 When {flags} contains "b" then binary mode is used: There will |
158 | 7552 not be a NL after the last list item. An empty item at the |
7553 end does cause the last line in the file to end in a NL. | |
6341 | 7554 |
7555 When {flags} contains "a" then append mode is used, lines are | |
7556 append to the file: > | |
7557 :call writefile(["foo"], "event.log", "a") | |
7558 :call writefile(["bar"], "event.log", "a") | |
7559 > | |
7560 < All NL characters are replaced with a NUL character. | |
158 | 7561 Inserting CR characters needs to be done before passing {list} |
7562 to writefile(). | |
7563 An existing file is overwritten, if possible. | |
7564 When the write fails -1 is returned, otherwise 0. There is an | |
7565 error message if the file can't be created or when writing | |
7566 fails. | |
7567 Also see |readfile()|. | |
7568 To copy a file byte for byte: > | |
7569 :let fl = readfile("foo", "b") | |
7570 :call writefile(fl, "foocopy", "b") | |
3214 | 7571 |
7572 | |
7573 xor({expr}, {expr}) *xor()* | |
7574 Bitwise XOR on the two arguments. The arguments are converted | |
7575 to a number. A List, Dict or Float argument causes an error. | |
7576 Example: > | |
7577 :let bits = xor(bits, 0x80) | |
3256 | 7578 < |
3214 | 7579 |
7 | 7580 |
7581 *feature-list* | |
6009 | 7582 There are four types of features: |
7 | 7583 1. Features that are only supported when they have been enabled when Vim |
7584 was compiled |+feature-list|. Example: > | |
7585 :if has("cindent") | |
7586 2. Features that are only supported when certain conditions have been met. | |
7587 Example: > | |
7588 :if has("gui_running") | |
7589 < *has-patch* | |
5814 | 7590 3. Included patches. The "patch123" feature means that patch 123 has been |
7591 included. Note that this form does not check the version of Vim, you need | |
7592 to inspect |v:version| for that. | |
7593 Example (checking version 6.2.148 or later): > | |
7 | 7594 :if v:version > 602 || v:version == 602 && has("patch148") |
5814 | 7595 < Note that it's possible for patch 147 to be omitted even though 148 is |
7596 included. | |
7597 | |
7598 4. Beyond a certain version or at a certain version and including a specific | |
5862 | 7599 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
7600 later, or it is version 7.4 and patch 237 was included. | |
7601 Note that this only works for patch 7.4.237 and later, before that you | |
7602 need to use the example above that checks v:version. Example: > | |
7603 :if has("patch-7.4.248") | |
5814 | 7604 < Note that it's possible for patch 147 to be omitted even though 148 is |
1156 | 7605 included. |
7 | 7606 |
5340 | 7607 acl Compiled with |ACL| support. |
7 | 7608 all_builtin_terms Compiled with all builtin terminals enabled. |
7609 amiga Amiga version of Vim. | |
7610 arabic Compiled with Arabic support |Arabic|. | |
7611 arp Compiled with ARP support (Amiga). | |
613 | 7612 autocmd Compiled with autocommand support. |autocommand| |
7 | 7613 balloon_eval Compiled with |balloon-eval| support. |
435 | 7614 balloon_multiline GUI supports multiline balloons. |
7 | 7615 beos BeOS version of Vim. |
7616 browse Compiled with |:browse| support, and browse() will | |
7617 work. | |
3682 | 7618 browsefilter Compiled with support for |browsefilter|. |
7 | 7619 builtin_terms Compiled with some builtin terminals. |
7620 byte_offset Compiled with support for 'o' in 'statusline' | |
7621 cindent Compiled with 'cindent' support. | |
7622 clientserver Compiled with remote invocation support |clientserver|. | |
7623 clipboard Compiled with 'clipboard' support. | |
7624 cmdline_compl Compiled with |cmdline-completion| support. | |
7625 cmdline_hist Compiled with |cmdline-history| support. | |
7626 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
7627 comments Compiled with |'comments'| support. | |
2681 | 7628 compatible Compiled to be very Vi compatible. |
7 | 7629 cryptv Compiled with encryption support |encryption|. |
7630 cscope Compiled with |cscope| support. | |
7631 debug Compiled with "DEBUG" defined. | |
7632 dialog_con Compiled with console dialog support. | |
7633 dialog_gui Compiled with GUI dialog support. | |
7634 diff Compiled with |vimdiff| and 'diff' support. | |
7635 digraphs Compiled with support for digraphs. | |
6110 | 7636 directx Compiled with support for Direct-X and 'renderoptions'. |
7 | 7637 dnd Compiled with support for the "~ register |quote_~|. |
2681 | 7638 dos16 16 bits DOS version of Vim. |
7 | 7639 dos32 32 bits DOS (DJGPP) version of Vim. |
7640 ebcdic Compiled on a machine with ebcdic character set. | |
7641 emacs_tags Compiled with support for Emacs tags. | |
7642 eval Compiled with expression evaluation support. Always | |
7643 true, of course! | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7788
diff
changeset
|
7644 ex_extra |+ex_extra|, always true now |
7 | 7645 extra_search Compiled with support for |'incsearch'| and |
7646 |'hlsearch'| | |
7647 farsi Compiled with Farsi support |farsi|. | |
7648 file_in_path Compiled with support for |gf| and |<cfile>| | |
168 | 7649 filterpipe When 'shelltemp' is off pipes are used for shell |
7650 read/write/filter commands | |
7 | 7651 find_in_path Compiled with support for include file searches |
7652 |+find_in_path|. | |
1621 | 7653 float Compiled with support for |Float|. |
7 | 7654 fname_case Case in file names matters (for Amiga, MS-DOS, and |
7655 Windows this is not present). | |
7656 folding Compiled with |folding| support. | |
7657 footer Compiled with GUI footer support. |gui-footer| | |
7658 fork Compiled to use fork()/exec() instead of system(). | |
7659 gettext Compiled with message translation |multi-lang| | |
7660 gui Compiled with GUI enabled. | |
7661 gui_athena Compiled with Athena GUI. | |
2681 | 7662 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
7 | 7663 gui_gtk Compiled with GTK+ GUI (any version). |
7664 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
|
7665 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
7 | 7666 gui_mac Compiled with Macintosh GUI. |
7667 gui_motif Compiled with Motif GUI. | |
7668 gui_photon Compiled with Photon GUI. | |
2681 | 7669 gui_running Vim is running in the GUI, or it will start soon. |
7 | 7670 gui_win32 Compiled with MS Windows Win32 GUI. |
7671 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
7672 hangul_input Compiled with Hangul input support. |hangul| | |
7673 iconv Can use iconv() for conversion. | |
7674 insert_expand Compiled with support for CTRL-X expansion commands in | |
7675 Insert mode. | |
7676 jumplist Compiled with |jumplist| support. | |
7677 keymap Compiled with 'keymap' support. | |
7678 langmap Compiled with 'langmap' support. | |
7679 libcall Compiled with |libcall()| support. | |
5995 | 7680 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
7681 'breakindent' support. | |
7 | 7682 lispindent Compiled with support for lisp indenting. |
7683 listcmds Compiled with commands for the buffer list |:files| | |
7684 and the argument list |arglist|. | |
7685 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
|
7686 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
|
7687 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
|
7688 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
|
7689 osx Compiled for OS X, with or without darwin |
7 | 7690 menu Compiled with support for |:menu|. |
7691 mksession Compiled with support for |:mksession|. | |
7692 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
7693 mouse Compiled with support mouse. | |
7694 mouse_dec Compiled with support for Dec terminal mouse. | |
7695 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
7696 mouse_netterm Compiled with support for netterm mouse. | |
7697 mouse_pterm Compiled with support for qnx pterm mouse. | |
1621 | 7698 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
3750 | 7699 mouse_sgr Compiled with support for sgr mouse. |
3224 | 7700 mouse_urxvt Compiled with support for urxvt mouse. |
7 | 7701 mouse_xterm Compiled with support for xterm mouse. |
2681 | 7702 mouseshape Compiled with support for 'mouseshape'. |
1768 | 7703 multi_byte Compiled with support for 'encoding' |
7704 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
7 | 7705 multi_byte_ime Compiled with support for IME input method. |
7706 multi_lang Compiled with support for multiple languages. | |
14 | 7707 mzscheme Compiled with MzScheme interface |mzscheme|. |
2681 | 7708 netbeans_enabled Compiled with support for |netbeans| and connected. |
7 | 7709 netbeans_intg Compiled with support for |netbeans|. |
7710 ole Compiled with OLE automation support for Win32. | |
7711 os2 OS/2 version of Vim. | |
7712 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
7713 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
|
7714 persistent_undo Compiled with support for persistent undo history. |
7 | 7715 postscript Compiled with PostScript file printing. |
7716 printer Compiled with |:hardcopy| support. | |
170 | 7717 profile Compiled with |:profile| support. |
2826 | 7718 python Compiled with Python 2.x interface. |has-python| |
7719 python3 Compiled with Python 3.x interface. |has-python| | |
7 | 7720 qnx QNX version of Vim. |
7721 quickfix Compiled with |quickfix| support. | |
857 | 7722 reltime Compiled with |reltime()| support. |
7 | 7723 rightleft Compiled with 'rightleft' support. |
7724 ruby Compiled with Ruby interface |ruby|. | |
7725 scrollbind Compiled with 'scrollbind' support. | |
7726 showcmd Compiled with 'showcmd' support. | |
7727 signs Compiled with |:sign| support. | |
7728 smartindent Compiled with 'smartindent' support. | |
2681 | 7729 spell Compiled with spell checking support |spell|. |
1989 | 7730 startuptime Compiled with |--startuptime| support. |
7 | 7731 statusline Compiled with support for 'statusline', 'rulerformat' |
7732 and special formats of 'titlestring' and 'iconstring'. | |
7733 sun_workshop Compiled with support for Sun |workshop|. | |
314 | 7734 syntax Compiled with syntax highlighting support |syntax|. |
7 | 7735 syntax_items There are active syntax highlighting items for the |
7736 current buffer. | |
7737 system Compiled to use system() instead of fork()/exec(). | |
7738 tag_binary Compiled with binary searching in tags files | |
7739 |tag-binary-search|. | |
7740 tag_old_static Compiled with support for old static tags | |
7741 |tag-old-static|. | |
7742 tag_any_white Compiled with support for any white characters in tags | |
7743 files |tag-any-white|. | |
7744 tcl Compiled with Tcl interface. | |
7745 terminfo Compiled with terminfo instead of termcap. | |
7746 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
7747 termtruecolor Compiled with true color in terminal support. |
7 | 7748 textobjects Compiled with support for |text-objects|. |
7749 tgetent Compiled with tgetent support, able to use a termcap | |
7750 or terminfo file. | |
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7751 timers Compiled with |timer_start()| support. |
7 | 7752 title Compiled with window title support |'title'|. |
7753 toolbar Compiled with support for |gui-toolbar|. | |
7754 unix Unix version of Vim. | |
7755 user_commands User-defined commands. | |
2681 | 7756 vertsplit Compiled with vertically split windows |:vsplit|. |
2581 | 7757 vim_starting True while initial source'ing takes place. |startup| |
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7758 *vim_starting* |
2681 | 7759 viminfo Compiled with viminfo support. |
7 | 7760 virtualedit Compiled with 'virtualedit' option. |
7761 visual Compiled with Visual mode. | |
7762 visualextra Compiled with extra Visual mode commands. | |
7763 |blockwise-operators|. | |
7764 vms VMS version of Vim. | |
7765 vreplace Compiled with |gR| and |gr| commands. | |
7766 wildignore Compiled with 'wildignore' option. | |
7767 wildmenu Compiled with 'wildmenu' option. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
7768 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
|
7769 64 bits) |
2681 | 7770 win32unix Win32 version of Vim, using Unix files (Cygwin) |
7 | 7771 win64 Win64 version of Vim (MS-Windows 64 bit). |
7772 win95 Win32 version for MS-Windows 95/98/ME. | |
2681 | 7773 winaltkeys Compiled with 'winaltkeys' option. |
7774 windows Compiled with support for more than one window. | |
7 | 7775 writebackup Compiled with 'writebackup' default on. |
7776 xfontset Compiled with X fontset support |xfontset|. | |
7777 xim Compiled with X input method support |xim|. | |
5340 | 7778 xpm Compiled with pixmap support. |
7779 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
7780 backward compatibility. Use "xpm" instead.) | |
7 | 7781 xsmp Compiled with X session management support. |
7782 xsmp_interact Compiled with interactive X session management support. | |
7783 xterm_clipboard Compiled with support for xterm clipboard. | |
7784 xterm_save Compiled with support for saving and restoring the | |
7785 xterm screen. | |
7786 x11 Compiled with X11 support. | |
7787 | |
7788 *string-match* | |
7789 Matching a pattern in a String | |
7790 | |
7791 A regexp pattern as explained at |pattern| is normally used to find a match in | |
7792 the buffer lines. When a pattern is used to find a match in a String, almost | |
7793 everything works in the same way. The difference is that a String is handled | |
7794 like it is one line. When it contains a "\n" character, this is not seen as a | |
7795 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
7796 with ".". Example: > | |
7797 :let a = "aaaa\nxxxx" | |
7798 :echo matchstr(a, "..\n..") | |
7799 aa | |
7800 xx | |
7801 :echo matchstr(a, "a.x") | |
7802 a | |
7803 x | |
7804 | |
7805 Don't forget that "^" will only match at the first character of the String and | |
7806 "$" at the last character of the string. They don't match after or before a | |
7807 "\n". | |
7808 | |
7809 ============================================================================== | |
7810 5. Defining functions *user-functions* | |
7811 | |
7812 New functions can be defined. These can be called just like builtin | |
7813 functions. The function executes a sequence of Ex commands. Normal mode | |
7814 commands can be executed with the |:normal| command. | |
7815 | |
7816 The function name must start with an uppercase letter, to avoid confusion with | |
7817 builtin functions. To prevent from using the same name in different scripts | |
7818 avoid obvious, short names. A good habit is to start the function name with | |
7819 the name of the script, e.g., "HTMLcolor()". | |
7820 | |
504 | 7821 It's also possible to use curly braces, see |curly-braces-names|. And the |
7822 |autoload| facility is useful to define a function only when it's called. | |
7 | 7823 |
7824 *local-function* | |
7825 A function local to a script must start with "s:". A local script function | |
7826 can only be called from within the script and from functions, user commands | |
7827 and autocommands defined in the script. It is also possible to call the | |
1698 | 7828 function from a mapping defined in the script, but then |<SID>| must be used |
7 | 7829 instead of "s:" when the mapping is expanded outside of the script. |
5862 | 7830 There are only script-local functions, no buffer-local or window-local |
7831 functions. | |
7 | 7832 |
7833 *:fu* *:function* *E128* *E129* *E123* | |
7834 :fu[nction] List all functions and their arguments. | |
7835 | |
7836 :fu[nction] {name} List function {name}. | |
685 | 7837 {name} can also be a |Dictionary| entry that is a |
7838 |Funcref|: > | |
114 | 7839 :function dict.init |
504 | 7840 |
7841 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
7842 Example that lists all functions ending with "File": > | |
7843 :function /File$ | |
482 | 7844 < |
7845 *:function-verbose* | |
7846 When 'verbose' is non-zero, listing a function will also display where it was | |
7847 last defined. Example: > | |
7848 | |
7849 :verbose function SetFileTypeSH | |
7850 function SetFileTypeSH(name) | |
7851 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
7852 < | |
484 | 7853 See |:verbose-cmd| for more information. |
482 | 7854 |
5862 | 7855 *E124* *E125* *E853* *E884* |
102 | 7856 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
7 | 7857 Define a new function by the name {name}. The name |
7858 must be made of alphanumeric characters and '_', and | |
5862 | 7859 must start with a capital or "s:" (see above). Note |
7860 that using "b:" or "g:" is not allowed. (since patch | |
7861 7.4.260 E884 is given if the function name has a colon | |
7862 in the name, e.g. for "foo:bar()". Before that patch | |
7863 no error was given). | |
114 | 7864 |
685 | 7865 {name} can also be a |Dictionary| entry that is a |
7866 |Funcref|: > | |
114 | 7867 :function dict.init(arg) |
1621 | 7868 < "dict" must be an existing dictionary. The entry |
114 | 7869 "init" is added if it didn't exist yet. Otherwise [!] |
1621 | 7870 is required to overwrite an existing function. The |
114 | 7871 result is a |Funcref| to a numbered function. The |
7872 function can only be used with a |Funcref| and will be | |
7873 deleted if there are no more references to it. | |
7 | 7874 *E127* *E122* |
7875 When a function by this name already exists and [!] is | |
7876 not used an error message is given. When [!] is used, | |
7877 an existing function is silently replaced. Unless it | |
7878 is currently being executed, that is an error. | |
133 | 7879 |
7880 For the {arguments} see |function-argument|. | |
7881 | |
5618 | 7882 *:func-range* *a:firstline* *a:lastline* |
7 | 7883 When the [range] argument is added, the function is |
7884 expected to take care of a range itself. The range is | |
7885 passed as "a:firstline" and "a:lastline". If [range] | |
7886 is excluded, ":{range}call" will call the function for | |
7887 each line in the range, with the cursor on the start | |
7888 of each line. See |function-range-example|. | |
3967 | 7889 The cursor is still moved to the first line of the |
7890 range, as is the case with all Ex commands. | |
5618 | 7891 *:func-abort* |
7 | 7892 When the [abort] argument is added, the function will |
7893 abort as soon as an error is detected. | |
5618 | 7894 *:func-dict* |
102 | 7895 When the [dict] argument is added, the function must |
1621 | 7896 be invoked through an entry in a |Dictionary|. The |
102 | 7897 local variable "self" will then be set to the |
7898 dictionary. See |Dictionary-function|. | |
7 | 7899 |
1621 | 7900 *function-search-undo* |
653 | 7901 The last used search pattern and the redo command "." |
1621 | 7902 will not be changed by the function. This also |
7903 implies that the effect of |:nohlsearch| is undone | |
7904 when the function returns. | |
653 | 7905 |
7 | 7906 *:endf* *:endfunction* *E126* *E193* |
7907 :endf[unction] The end of a function definition. Must be on a line | |
7908 by its own, without other commands. | |
7909 | |
7910 *:delf* *:delfunction* *E130* *E131* | |
7911 :delf[unction] {name} Delete function {name}. | |
685 | 7912 {name} can also be a |Dictionary| entry that is a |
7913 |Funcref|: > | |
114 | 7914 :delfunc dict.init |
1621 | 7915 < This will remove the "init" entry from "dict". The |
114 | 7916 function is deleted if there are no more references to |
7917 it. | |
7 | 7918 *:retu* *:return* *E133* |
7919 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
7920 evaluated and returned as the result of the function. | |
7921 If "[expr]" is not given, the number 0 is returned. | |
7922 When a function ends without an explicit ":return", | |
7923 the number 0 is returned. | |
7924 Note that there is no check for unreachable lines, | |
7925 thus there is no warning if commands follow ":return". | |
7926 | |
7927 If the ":return" is used after a |:try| but before the | |
7928 matching |:finally| (if present), the commands | |
7929 following the ":finally" up to the matching |:endtry| | |
7930 are executed first. This process applies to all | |
7931 nested ":try"s inside the function. The function | |
7932 returns at the outermost ":endtry". | |
7933 | |
133 | 7934 *function-argument* *a:var* |
1621 | 7935 An argument can be defined by giving its name. In the function this can then |
133 | 7936 be used as "a:name" ("a:" for argument). |
1156 | 7937 *a:0* *a:1* *a:000* *E740* *...* |
133 | 7938 Up to 20 arguments can be given, separated by commas. After the named |
7939 arguments an argument "..." can be specified, which means that more arguments | |
7940 may optionally be following. In the function the extra arguments can be used | |
7941 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 7942 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
7943 that "a:1" is the same as "a:000[0]". | |
148 | 7944 *E742* |
7945 The a: scope and the variables in it cannot be changed, they are fixed. | |
1698 | 7946 However, if a |List| or |Dictionary| is used, you can change their contents. |
685 | 7947 Thus you can pass a |List| to a function and have the function add an item to |
7948 it. If you want to make sure the function cannot change a |List| or | |
7949 |Dictionary| use |:lockvar|. | |
133 | 7950 |
7951 When not using "...", the number of arguments in a function call must be equal | |
7952 to the number of named arguments. When using "...", the number of arguments | |
7953 may be larger. | |
7954 | |
7955 It is also possible to define a function without any arguments. You must | |
7956 still supply the () then. The body of the function follows in the next lines, | |
7957 until the matching |:endfunction|. It is allowed to define another function | |
7958 inside a function body. | |
7959 | |
7960 *local-variables* | |
7 | 7961 Inside a function variables can be used. These are local variables, which |
7962 will disappear when the function returns. Global variables need to be | |
7963 accessed with "g:". | |
7964 | |
7965 Example: > | |
7966 :function Table(title, ...) | |
7967 : echohl Title | |
7968 : echo a:title | |
7969 : echohl None | |
140 | 7970 : echo a:0 . " items:" |
7971 : for s in a:000 | |
7972 : echon ' ' . s | |
7973 : endfor | |
7 | 7974 :endfunction |
7975 | |
7976 This function can then be called with: > | |
140 | 7977 call Table("Table", "line1", "line2") |
7978 call Table("Empty Table") | |
7 | 7979 |
1156 | 7980 To return more than one value, return a |List|: > |
7981 :function Compute(n1, n2) | |
7 | 7982 : if a:n2 == 0 |
1156 | 7983 : return ["fail", 0] |
7 | 7984 : endif |
1156 | 7985 : return ["ok", a:n1 / a:n2] |
7 | 7986 :endfunction |
7987 | |
7988 This function can then be called with: > | |
1156 | 7989 :let [success, div] = Compute(102, 6) |
7 | 7990 :if success == "ok" |
7991 : echo div | |
7992 :endif | |
1156 | 7993 < |
786 | 7994 *:cal* *:call* *E107* *E117* |
7 | 7995 :[range]cal[l] {name}([arguments]) |
7996 Call a function. The name of the function and its arguments | |
7997 are as specified with |:function|. Up to 20 arguments can be | |
1156 | 7998 used. The returned value is discarded. |
7 | 7999 Without a range and for functions that accept a range, the |
8000 function is called once. When a range is given the cursor is | |
8001 positioned at the start of the first line before executing the | |
8002 function. | |
8003 When a range is given and the function doesn't handle it | |
8004 itself, the function is executed for each line in the range, | |
8005 with the cursor in the first column of that line. The cursor | |
8006 is left at the last line (possibly moved by the last function | |
1621 | 8007 call). The arguments are re-evaluated for each line. Thus |
7 | 8008 this works: |
8009 *function-range-example* > | |
8010 :function Mynumber(arg) | |
8011 : echo line(".") . " " . a:arg | |
8012 :endfunction | |
8013 :1,5call Mynumber(getline(".")) | |
8014 < | |
8015 The "a:firstline" and "a:lastline" are defined anyway, they | |
8016 can be used to do something different at the start or end of | |
8017 the range. | |
8018 | |
8019 Example of a function that handles the range itself: > | |
8020 | |
8021 :function Cont() range | |
8022 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
8023 :endfunction | |
8024 :4,8call Cont() | |
8025 < | |
8026 This function inserts the continuation character "\" in front | |
8027 of all the lines in the range, except the first one. | |
8028 | |
1156 | 8029 When the function returns a composite value it can be further |
8030 dereferenced, but the range will not be used then. Example: > | |
8031 :4,8call GetDict().method() | |
8032 < Here GetDict() gets the range but method() does not. | |
8033 | |
7 | 8034 *E132* |
8035 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
8036 option. | |
8037 | |
161 | 8038 |
8039 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 8040 *autoload-functions* |
8041 When using many or large functions, it's possible to automatically define them | |
161 | 8042 only when they are used. There are two methods: with an autocommand and with |
8043 the "autoload" directory in 'runtimepath'. | |
8044 | |
8045 | |
8046 Using an autocommand ~ | |
8047 | |
170 | 8048 This is introduced in the user manual, section |41.14|. |
8049 | |
161 | 8050 The autocommand is useful if you have a plugin that is a long Vim script file. |
8051 You can define the autocommand and quickly quit the script with |:finish|. | |
1621 | 8052 That makes Vim startup faster. The autocommand should then load the same file |
161 | 8053 again, setting a variable to skip the |:finish| command. |
8054 | |
8055 Use the FuncUndefined autocommand event with a pattern that matches the | |
8056 function(s) to be defined. Example: > | |
7 | 8057 |
8058 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
8059 | |
8060 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
8061 "BufNet". Also see |FuncUndefined|. | |
8062 | |
161 | 8063 |
8064 Using an autoload script ~ | |
168 | 8065 *autoload* *E746* |
170 | 8066 This is introduced in the user manual, section |41.15|. |
8067 | |
161 | 8068 Using a script in the "autoload" directory is simpler, but requires using |
8069 exactly the right file name. A function that can be autoloaded has a name | |
8070 like this: > | |
8071 | |
270 | 8072 :call filename#funcname() |
161 | 8073 |
8074 When such a function is called, and it is not defined yet, Vim will search the | |
8075 "autoload" directories in 'runtimepath' for a script file called | |
8076 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
8077 then define the function like this: > | |
8078 | |
270 | 8079 function filename#funcname() |
161 | 8080 echo "Done!" |
8081 endfunction | |
8082 | |
530 | 8083 The file name and the name used before the # in the function must match |
161 | 8084 exactly, and the defined function must have the name exactly as it will be |
8085 called. | |
8086 | |
270 | 8087 It is possible to use subdirectories. Every # in the function name works like |
8088 a path separator. Thus when calling a function: > | |
8089 | |
8090 :call foo#bar#func() | |
161 | 8091 |
8092 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
8093 | |
168 | 8094 This also works when reading a variable that has not been set yet: > |
8095 | |
270 | 8096 :let l = foo#bar#lvar |
168 | 8097 |
557 | 8098 However, when the autoload script was already loaded it won't be loaded again |
8099 for an unknown variable. | |
8100 | |
168 | 8101 When assigning a value to such a variable nothing special happens. This can |
8102 be used to pass settings to the autoload script before it's loaded: > | |
8103 | |
270 | 8104 :let foo#bar#toggle = 1 |
8105 :call foo#bar#func() | |
168 | 8106 |
164 | 8107 Note that when you make a mistake and call a function that is supposed to be |
8108 defined in an autoload script, but the script doesn't actually define the | |
8109 function, the script will be sourced every time you try to call the function. | |
168 | 8110 And you will get an error message every time. |
8111 | |
8112 Also note that if you have two script files, and one calls a function in the | |
1621 | 8113 other and vice versa, before the used function is defined, it won't work. |
168 | 8114 Avoid using the autoload functionality at the toplevel. |
161 | 8115 |
794 | 8116 Hint: If you distribute a bunch of scripts you can pack them together with the |
8117 |vimball| utility. Also read the user manual |distribute-script|. | |
8118 | |
7 | 8119 ============================================================================== |
8120 6. Curly braces names *curly-braces-names* | |
8121 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8122 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
|
8123 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
|
8124 wrapped in braces {} like this: > |
7 | 8125 my_{adjective}_variable |
8126 | |
8127 When Vim encounters this, it evaluates the expression inside the braces, puts | |
8128 that in place of the expression, and re-interprets the whole as a variable | |
8129 name. So in the above example, if the variable "adjective" was set to | |
8130 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
8131 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
8132 | |
8133 One application for this is to create a set of variables governed by an option | |
1621 | 8134 value. For example, the statement > |
7 | 8135 echo my_{&background}_message |
8136 | |
8137 would output the contents of "my_dark_message" or "my_light_message" depending | |
8138 on the current value of 'background'. | |
8139 | |
8140 You can use multiple brace pairs: > | |
8141 echo my_{adverb}_{adjective}_message | |
8142 ..or even nest them: > | |
8143 echo my_{ad{end_of_word}}_message | |
8144 where "end_of_word" is either "verb" or "jective". | |
8145 | |
8146 However, the expression inside the braces must evaluate to a valid single | |
236 | 8147 variable name, e.g. this is invalid: > |
7 | 8148 :let foo='a + b' |
8149 :echo c{foo}d | |
8150 .. since the result of expansion is "ca + bd", which is not a variable name. | |
8151 | |
8152 *curly-braces-function-names* | |
8153 You can call and define functions by an evaluated name in a similar way. | |
8154 Example: > | |
8155 :let func_end='whizz' | |
8156 :call my_func_{func_end}(parameter) | |
8157 | |
8158 This would call the function "my_func_whizz(parameter)". | |
8159 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8160 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8161 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8162 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8163 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8164 |
7 | 8165 ============================================================================== |
8166 7. Commands *expression-commands* | |
8167 | |
8168 :let {var-name} = {expr1} *:let* *E18* | |
8169 Set internal variable {var-name} to the result of the | |
8170 expression {expr1}. The variable will get the type | |
8171 from the {expr}. If {var-name} didn't exist yet, it | |
8172 is created. | |
8173 | |
85 | 8174 :let {var-name}[{idx}] = {expr1} *E689* |
8175 Set a list item to the result of the expression | |
8176 {expr1}. {var-name} must refer to a list and {idx} | |
8177 must be a valid index in that list. For nested list | |
8178 the index can be repeated. | |
1621 | 8179 This cannot be used to add an item to a |List|. |
8180 This cannot be used to set a byte in a String. You | |
8181 can do that like this: > | |
8182 :let var = var[0:2] . 'X' . var[4:] | |
8183 < | |
114 | 8184 *E711* *E719* |
8185 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
685 | 8186 Set a sequence of items in a |List| to the result of |
8187 the expression {expr1}, which must be a list with the | |
87 | 8188 correct number of items. |
8189 {idx1} can be omitted, zero is used instead. | |
8190 {idx2} can be omitted, meaning the end of the list. | |
8191 When the selected range of items is partly past the | |
8192 end of the list, items will be added. | |
8193 | |
153 | 8194 *:let+=* *:let-=* *:let.=* *E734* |
114 | 8195 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
8196 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
8197 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
8198 These fail if {var} was not set yet and when the type | |
8199 of {var} and {expr1} don't fit the operator. | |
8200 | |
8201 | |
7 | 8202 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
8203 Set environment variable {env-name} to the result of | |
8204 the expression {expr1}. The type is always String. | |
114 | 8205 :let ${env-name} .= {expr1} |
8206 Append {expr1} to the environment variable {env-name}. | |
8207 If the environment variable didn't exist yet this | |
8208 works like "=". | |
7 | 8209 |
8210 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
8211 Write the result of the expression {expr1} in register | |
8212 {reg-name}. {reg-name} must be a single letter, and | |
8213 must be the name of a writable register (see | |
8214 |registers|). "@@" can be used for the unnamed | |
8215 register, "@/" for the search pattern. | |
8216 If the result of {expr1} ends in a <CR> or <NL>, the | |
8217 register will be linewise, otherwise it will be set to | |
8218 characterwise. | |
8219 This can be used to clear the last search pattern: > | |
8220 :let @/ = "" | |
8221 < This is different from searching for an empty string, | |
8222 that would match everywhere. | |
8223 | |
114 | 8224 :let @{reg-name} .= {expr1} |
1621 | 8225 Append {expr1} to register {reg-name}. If the |
114 | 8226 register was empty it's like setting it to {expr1}. |
8227 | |
1156 | 8228 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 8229 Set option {option-name} to the result of the |
68 | 8230 expression {expr1}. A String or Number value is |
8231 always converted to the type of the option. | |
7 | 8232 For an option local to a window or buffer the effect |
8233 is just like using the |:set| command: both the local | |
555 | 8234 value and the global value are changed. |
68 | 8235 Example: > |
8236 :let &path = &path . ',/usr/local/include' | |
7 | 8237 |
114 | 8238 :let &{option-name} .= {expr1} |
8239 For a string option: Append {expr1} to the value. | |
8240 Does not insert a comma like |:set+=|. | |
8241 | |
8242 :let &{option-name} += {expr1} | |
8243 :let &{option-name} -= {expr1} | |
8244 For a number or boolean option: Add or subtract | |
8245 {expr1}. | |
8246 | |
7 | 8247 :let &l:{option-name} = {expr1} |
114 | 8248 :let &l:{option-name} .= {expr1} |
8249 :let &l:{option-name} += {expr1} | |
8250 :let &l:{option-name} -= {expr1} | |
7 | 8251 Like above, but only set the local value of an option |
8252 (if there is one). Works like |:setlocal|. | |
8253 | |
8254 :let &g:{option-name} = {expr1} | |
114 | 8255 :let &g:{option-name} .= {expr1} |
8256 :let &g:{option-name} += {expr1} | |
8257 :let &g:{option-name} -= {expr1} | |
7 | 8258 Like above, but only set the global value of an option |
8259 (if there is one). Works like |:setglobal|. | |
8260 | |
85 | 8261 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 8262 {expr1} must evaluate to a |List|. The first item in |
68 | 8263 the list is assigned to {name1}, the second item to |
8264 {name2}, etc. | |
8265 The number of names must match the number of items in | |
685 | 8266 the |List|. |
68 | 8267 Each name can be one of the items of the ":let" |
8268 command as mentioned above. | |
8269 Example: > | |
8270 :let [s, item] = GetItem(s) | |
114 | 8271 < Detail: {expr1} is evaluated first, then the |
8272 assignments are done in sequence. This matters if | |
8273 {name2} depends on {name1}. Example: > | |
8274 :let x = [0, 1] | |
8275 :let i = 0 | |
8276 :let [i, x[i]] = [1, 2] | |
8277 :echo x | |
8278 < The result is [0, 2]. | |
8279 | |
8280 :let [{name1}, {name2}, ...] .= {expr1} | |
8281 :let [{name1}, {name2}, ...] += {expr1} | |
8282 :let [{name1}, {name2}, ...] -= {expr1} | |
8283 Like above, but append/add/subtract the value for each | |
685 | 8284 |List| item. |
68 | 8285 |
8286 :let [{name}, ..., ; {lastname}] = {expr1} | |
685 | 8287 Like |:let-unpack| above, but the |List| may have more |
114 | 8288 items than there are names. A list of the remaining |
8289 items is assigned to {lastname}. If there are no | |
8290 remaining items {lastname} is set to an empty list. | |
68 | 8291 Example: > |
8292 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
8293 < | |
114 | 8294 :let [{name}, ..., ; {lastname}] .= {expr1} |
8295 :let [{name}, ..., ; {lastname}] += {expr1} | |
8296 :let [{name}, ..., ; {lastname}] -= {expr1} | |
8297 Like above, but append/add/subtract the value for each | |
685 | 8298 |List| item. |
2596 | 8299 |
8300 *E121* | |
1621 | 8301 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 8302 variable names may be given. Special names recognized |
8303 here: *E738* | |
777 | 8304 g: global variables |
8305 b: local buffer variables | |
8306 w: local window variables | |
819 | 8307 t: local tab page variables |
777 | 8308 s: script-local variables |
8309 l: local function variables | |
123 | 8310 v: Vim variables. |
7 | 8311 |
55 | 8312 :let List the values of all variables. The type of the |
8313 variable is indicated before the value: | |
8314 <nothing> String | |
8315 # Number | |
856 | 8316 * Funcref |
7 | 8317 |
148 | 8318 |
1156 | 8319 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
148 | 8320 Remove the internal variable {name}. Several variable |
8321 names can be given, they are all removed. The name | |
685 | 8322 may also be a |List| or |Dictionary| item. |
7 | 8323 With [!] no error message is given for non-existing |
8324 variables. | |
685 | 8325 One or more items from a |List| can be removed: > |
108 | 8326 :unlet list[3] " remove fourth item |
8327 :unlet list[3:] " remove fourth item to last | |
685 | 8328 < One item from a |Dictionary| can be removed at a time: > |
108 | 8329 :unlet dict['two'] |
8330 :unlet dict.two | |
1668 | 8331 < This is especially useful to clean up used global |
8332 variables and script-local variables (these are not | |
8333 deleted when the script ends). Function-local | |
8334 variables are automatically deleted when the function | |
8335 ends. | |
7 | 8336 |
148 | 8337 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
8338 Lock the internal variable {name}. Locking means that | |
8339 it can no longer be changed (until it is unlocked). | |
8340 A locked variable can be deleted: > | |
8341 :lockvar v | |
8342 :let v = 'asdf' " fails! | |
8343 :unlet v | |
8344 < *E741* | |
8345 If you try to change a locked variable you get an | |
6530 | 8346 error message: "E741: Value is locked: {name}" |
148 | 8347 |
685 | 8348 [depth] is relevant when locking a |List| or |
8349 |Dictionary|. It specifies how deep the locking goes: | |
8350 1 Lock the |List| or |Dictionary| itself, | |
148 | 8351 cannot add or remove items, but can |
8352 still change their values. | |
8353 2 Also lock the values, cannot change | |
685 | 8354 the items. If an item is a |List| or |
8355 |Dictionary|, cannot add or remove | |
148 | 8356 items, but can still change the |
8357 values. | |
685 | 8358 3 Like 2 but for the |List| / |
8359 |Dictionary| in the |List| / | |
8360 |Dictionary|, one level deeper. | |
8361 The default [depth] is 2, thus when {name} is a |List| | |
8362 or |Dictionary| the values cannot be changed. | |
148 | 8363 *E743* |
8364 For unlimited depth use [!] and omit [depth]. | |
8365 However, there is a maximum depth of 100 to catch | |
8366 loops. | |
8367 | |
685 | 8368 Note that when two variables refer to the same |List| |
8369 and you lock one of them, the |List| will also be | |
819 | 8370 locked when used through the other variable. |
8371 Example: > | |
148 | 8372 :let l = [0, 1, 2, 3] |
8373 :let cl = l | |
8374 :lockvar l | |
8375 :let cl[1] = 99 " won't work! | |
8376 < You may want to make a copy of a list to avoid this. | |
8377 See |deepcopy()|. | |
8378 | |
8379 | |
8380 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
8381 Unlock the internal variable {name}. Does the | |
8382 opposite of |:lockvar|. | |
8383 | |
8384 | |
7 | 8385 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
8386 :en[dif] Execute the commands until the next matching ":else" | |
8387 or ":endif" if {expr1} evaluates to non-zero. | |
8388 | |
8389 From Vim version 4.5 until 5.0, every Ex command in | |
8390 between the ":if" and ":endif" is ignored. These two | |
8391 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
|
8392 backward compatible way. Nesting was allowed. Note |
7 | 8393 that any ":else" or ":elseif" was ignored, the "else" |
8394 part was not executed either. | |
8395 | |
8396 You can use this to remain compatible with older | |
8397 versions: > | |
8398 :if version >= 500 | |
8399 : version-5-specific-commands | |
8400 :endif | |
8401 < The commands still need to be parsed to find the | |
8402 "endif". Sometimes an older Vim has a problem with a | |
8403 new command. For example, ":silent" is recognized as | |
8404 a ":substitute" command. In that case ":execute" can | |
8405 avoid problems: > | |
8406 :if version >= 600 | |
8407 : execute "silent 1,$delete" | |
8408 :endif | |
8409 < | |
8410 NOTE: The ":append" and ":insert" commands don't work | |
8411 properly in between ":if" and ":endif". | |
8412 | |
8413 *:else* *:el* *E581* *E583* | |
8414 :el[se] Execute the commands until the next matching ":else" | |
8415 or ":endif" if they previously were not being | |
8416 executed. | |
8417 | |
8418 *:elseif* *:elsei* *E582* *E584* | |
8419 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
8420 is no extra ":endif". | |
8421 | |
8422 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 8423 *E170* *E585* *E588* *E733* |
7 | 8424 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
8425 as long as {expr1} evaluates to non-zero. | |
8426 When an error is detected from a command inside the | |
8427 loop, execution continues after the "endwhile". | |
75 | 8428 Example: > |
8429 :let lnum = 1 | |
8430 :while lnum <= line("$") | |
8431 :call FixLine(lnum) | |
8432 :let lnum = lnum + 1 | |
8433 :endwhile | |
8434 < | |
7 | 8435 NOTE: The ":append" and ":insert" commands don't work |
99 | 8436 properly inside a ":while" and ":for" loop. |
75 | 8437 |
114 | 8438 :for {var} in {list} *:for* *E690* *E732* |
75 | 8439 :endfo[r] *:endfo* *:endfor* |
8440 Repeat the commands between ":for" and ":endfor" for | |
158 | 8441 each item in {list}. Variable {var} is set to the |
79 | 8442 value of each item. |
8443 When an error is detected for a command inside the | |
75 | 8444 loop, execution continues after the "endfor". |
464 | 8445 Changing {list} inside the loop affects what items are |
8446 used. Make a copy if this is unwanted: > | |
79 | 8447 :for item in copy(mylist) |
8448 < When not making a copy, Vim stores a reference to the | |
8449 next item in the list, before executing the commands | |
1621 | 8450 with the current item. Thus the current item can be |
79 | 8451 removed without effect. Removing any later item means |
8452 it will not be found. Thus the following example | |
8453 works (an inefficient way to make a list empty): > | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8454 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8455 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8456 endfor |
87 | 8457 < Note that reordering the list (e.g., with sort() or |
8458 reverse()) may have unexpected effects. | |
75 | 8459 |
8460 :for [{var1}, {var2}, ...] in {listlist} | |
8461 :endfo[r] | |
8462 Like ":for" above, but each item in {listlist} must be | |
8463 a list, of which each item is assigned to {var1}, | |
8464 {var2}, etc. Example: > | |
8465 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
8466 :echo getline(lnum)[col] | |
8467 :endfor | |
8468 < | |
7 | 8469 *:continue* *:con* *E586* |
75 | 8470 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
8471 to the start of the loop. | |
8472 If it is used after a |:try| inside the loop but | |
8473 before the matching |:finally| (if present), the | |
8474 commands following the ":finally" up to the matching | |
8475 |:endtry| are executed first. This process applies to | |
8476 all nested ":try"s inside the loop. The outermost | |
8477 ":endtry" then jumps back to the start of the loop. | |
7 | 8478 |
8479 *:break* *:brea* *E587* | |
75 | 8480 :brea[k] When used inside a ":while" or ":for" loop, skips to |
8481 the command after the matching ":endwhile" or | |
8482 ":endfor". | |
8483 If it is used after a |:try| inside the loop but | |
8484 before the matching |:finally| (if present), the | |
8485 commands following the ":finally" up to the matching | |
8486 |:endtry| are executed first. This process applies to | |
8487 all nested ":try"s inside the loop. The outermost | |
8488 ":endtry" then jumps to the command after the loop. | |
7 | 8489 |
8490 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
8491 :endt[ry] Change the error handling for the commands between | |
8492 ":try" and ":endtry" including everything being | |
8493 executed across ":source" commands, function calls, | |
8494 or autocommand invocations. | |
8495 | |
8496 When an error or interrupt is detected and there is | |
8497 a |:finally| command following, execution continues | |
8498 after the ":finally". Otherwise, or when the | |
8499 ":endtry" is reached thereafter, the next | |
8500 (dynamically) surrounding ":try" is checked for | |
8501 a corresponding ":finally" etc. Then the script | |
8502 processing is terminated. (Whether a function | |
8503 definition has an "abort" argument does not matter.) | |
8504 Example: > | |
8505 :try | edit too much | finally | echo "cleanup" | endtry | |
8506 :echo "impossible" " not reached, script terminated above | |
8507 < | |
8508 Moreover, an error or interrupt (dynamically) inside | |
8509 ":try" and ":endtry" is converted to an exception. It | |
8510 can be caught as if it were thrown by a |:throw| | |
8511 command (see |:catch|). In this case, the script | |
8512 processing is not terminated. | |
8513 | |
8514 The value "Vim:Interrupt" is used for an interrupt | |
8515 exception. An error in a Vim command is converted | |
8516 to a value of the form "Vim({command}):{errmsg}", | |
8517 other errors are converted to a value of the form | |
8518 "Vim:{errmsg}". {command} is the full command name, | |
8519 and {errmsg} is the message that is displayed if the | |
8520 error exception is not caught, always beginning with | |
8521 the error number. | |
8522 Examples: > | |
8523 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
8524 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
8525 < | |
8526 *:cat* *:catch* *E603* *E604* *E605* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8527 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
7 | 8528 |:finally|, or |:endtry| that belongs to the same |
8529 |:try| as the ":catch" are executed when an exception | |
8530 matching {pattern} is being thrown and has not yet | |
8531 been caught by a previous ":catch". Otherwise, these | |
8532 commands are skipped. | |
8533 When {pattern} is omitted all errors are caught. | |
8534 Examples: > | |
8535 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
8536 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
8537 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
8538 :catch /^Vim(write):/ " catch all errors in :write | |
8539 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
8540 :catch /my-exception/ " catch user exception | |
8541 :catch /.*/ " catch everything | |
8542 :catch " same as /.*/ | |
8543 < | |
8544 Another character can be used instead of / around the | |
8545 {pattern}, so long as it does not have a special | |
8546 meaning (e.g., '|' or '"') and doesn't occur inside | |
8547 {pattern}. | |
5814 | 8548 Information about the exception is available in |
8549 |v:exception|. Also see |throw-variables|. | |
7 | 8550 NOTE: It is not reliable to ":catch" the TEXT of |
8551 an error message because it may vary in different | |
8552 locales. | |
8553 | |
8554 *:fina* *:finally* *E606* *E607* | |
8555 :fina[lly] The following commands until the matching |:endtry| | |
8556 are executed whenever the part between the matching | |
8557 |:try| and the ":finally" is left: either by falling | |
8558 through to the ":finally" or by a |:continue|, | |
8559 |:break|, |:finish|, or |:return|, or by an error or | |
8560 interrupt or exception (see |:throw|). | |
8561 | |
8562 *:th* *:throw* *E608* | |
8563 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
8564 If the ":throw" is used after a |:try| but before the | |
8565 first corresponding |:catch|, commands are skipped | |
8566 until the first ":catch" matching {expr1} is reached. | |
8567 If there is no such ":catch" or if the ":throw" is | |
8568 used after a ":catch" but before the |:finally|, the | |
8569 commands following the ":finally" (if present) up to | |
8570 the matching |:endtry| are executed. If the ":throw" | |
8571 is after the ":finally", commands up to the ":endtry" | |
8572 are skipped. At the ":endtry", this process applies | |
8573 again for the next dynamically surrounding ":try" | |
8574 (which may be found in a calling function or sourcing | |
8575 script), until a matching ":catch" has been found. | |
8576 If the exception is not caught, the command processing | |
8577 is terminated. | |
8578 Example: > | |
8579 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 8580 < Note that "catch" may need to be on a separate line |
8581 for when an error causes the parsing to skip the whole | |
8582 line and not see the "|" that separates the commands. | |
7 | 8583 |
8584 *:ec* *:echo* | |
8585 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
8586 first {expr1} starts on a new line. | |
8587 Also see |:comment|. | |
8588 Use "\n" to start a new line. Use "\r" to move the | |
8589 cursor to the first column. | |
8590 Uses the highlighting set by the |:echohl| command. | |
8591 Cannot be followed by a comment. | |
8592 Example: > | |
8593 :echo "the value of 'shell' is" &shell | |
1156 | 8594 < *:echo-redraw* |
8595 A later redraw may make the message disappear again. | |
8596 And since Vim mostly postpones redrawing until it's | |
8597 finished with a sequence of commands this happens | |
8598 quite often. To avoid that a command from before the | |
8599 ":echo" causes a redraw afterwards (redraws are often | |
8600 postponed until you type something), force a redraw | |
8601 with the |:redraw| command. Example: > | |
7 | 8602 :new | redraw | echo "there is a new window" |
8603 < | |
8604 *:echon* | |
8605 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
8606 |:comment|. | |
8607 Uses the highlighting set by the |:echohl| command. | |
8608 Cannot be followed by a comment. | |
8609 Example: > | |
8610 :echon "the value of 'shell' is " &shell | |
8611 < | |
8612 Note the difference between using ":echo", which is a | |
8613 Vim command, and ":!echo", which is an external shell | |
8614 command: > | |
8615 :!echo % --> filename | |
8616 < The arguments of ":!" are expanded, see |:_%|. > | |
8617 :!echo "%" --> filename or "filename" | |
8618 < Like the previous example. Whether you see the double | |
8619 quotes or not depends on your 'shell'. > | |
8620 :echo % --> nothing | |
8621 < The '%' is an illegal character in an expression. > | |
8622 :echo "%" --> % | |
8623 < This just echoes the '%' character. > | |
8624 :echo expand("%") --> filename | |
8625 < This calls the expand() function to expand the '%'. | |
8626 | |
8627 *:echoh* *:echohl* | |
8628 :echoh[l] {name} Use the highlight group {name} for the following | |
8629 |:echo|, |:echon| and |:echomsg| commands. Also used | |
8630 for the |input()| prompt. Example: > | |
8631 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
8632 < Don't forget to set the group back to "None", | |
8633 otherwise all following echo's will be highlighted. | |
8634 | |
8635 *:echom* *:echomsg* | |
8636 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
8637 message in the |message-history|. | |
8638 Spaces are placed between the arguments as with the | |
8639 |:echo| command. But unprintable characters are | |
8640 displayed, not interpreted. | |
1156 | 8641 The parsing works slightly different from |:echo|, |
8642 more like |:execute|. All the expressions are first | |
8643 evaluated and concatenated before echoing anything. | |
8644 The expressions must evaluate to a Number or String, a | |
8645 Dictionary or List causes an error. | |
7 | 8646 Uses the highlighting set by the |:echohl| command. |
8647 Example: > | |
8648 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 8649 < See |:echo-redraw| to avoid the message disappearing |
8650 when the screen is redrawn. | |
7 | 8651 *:echoe* *:echoerr* |
8652 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
8653 message in the |message-history|. When used in a | |
8654 script or function the line number will be added. | |
8655 Spaces are placed between the arguments as with the | |
1621 | 8656 :echo command. When used inside a try conditional, |
7 | 8657 the message is raised as an error exception instead |
8658 (see |try-echoerr|). | |
8659 Example: > | |
8660 :echoerr "This script just failed!" | |
8661 < If you just want a highlighted message use |:echohl|. | |
8662 And to get a beep: > | |
8663 :exe "normal \<Esc>" | |
8664 < | |
8665 *:exe* *:execute* | |
8666 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 8667 of {expr1} as an Ex command. |
8668 Multiple arguments are concatenated, with a space in | |
8669 between. To avoid the extra space use the "." | |
8670 operator to concatenate strings into one argument. | |
8671 {expr1} is used as the processed command, command line | |
8672 editing keys are not recognized. | |
7 | 8673 Cannot be followed by a comment. |
8674 Examples: > | |
2152 | 8675 :execute "buffer" nextbuf |
8676 :execute "normal" count . "w" | |
7 | 8677 < |
8678 ":execute" can be used to append a command to commands | |
8679 that don't accept a '|'. Example: > | |
8680 :execute '!ls' | echo "theend" | |
8681 | |
8682 < ":execute" is also a nice way to avoid having to type | |
8683 control characters in a Vim script for a ":normal" | |
8684 command: > | |
8685 :execute "normal ixxx\<Esc>" | |
8686 < This has an <Esc> character, see |expr-string|. | |
8687 | |
1621 | 8688 Be careful to correctly escape special characters in |
8689 file names. The |fnameescape()| function can be used | |
1661 | 8690 for Vim commands, |shellescape()| for |:!| commands. |
8691 Examples: > | |
1621 | 8692 :execute "e " . fnameescape(filename) |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
8693 :execute "!ls " . shellescape(filename, 1) |
1621 | 8694 < |
7 | 8695 Note: The executed string may be any command-line, but |
5763 | 8696 starting or ending "if", "while" and "for" does not |
8697 always work, because when commands are skipped the | |
8698 ":execute" is not evaluated and Vim loses track of | |
8699 where blocks start and end. Also "break" and | |
8700 "continue" should not be inside ":execute". | |
8701 This example does not work, because the ":execute" is | |
8702 not evaluated and Vim does not see the "while", and | |
8703 gives an error for finding an ":endwhile": > | |
8704 :if 0 | |
8705 : execute 'while i > 5' | |
8706 : echo "test" | |
8707 : endwhile | |
8708 :endif | |
7 | 8709 < |
8710 It is allowed to have a "while" or "if" command | |
8711 completely in the executed string: > | |
8712 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
8713 < | |
8714 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8715 *:exe-comment* |
7 | 8716 ":execute", ":echo" and ":echon" cannot be followed by |
8717 a comment directly, because they see the '"' as the | |
8718 start of a string. But, you can use '|' followed by a | |
8719 comment. Example: > | |
8720 :echo "foo" | "this is a comment | |
8721 | |
8722 ============================================================================== | |
8723 8. Exception handling *exception-handling* | |
8724 | |
8725 The Vim script language comprises an exception handling feature. This section | |
8726 explains how it can be used in a Vim script. | |
8727 | |
8728 Exceptions may be raised by Vim on an error or on interrupt, see | |
8729 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
8730 exception by using the ":throw" command, see |throw-catch|. | |
8731 | |
8732 | |
8733 TRY CONDITIONALS *try-conditionals* | |
8734 | |
8735 Exceptions can be caught or can cause cleanup code to be executed. You can | |
8736 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
8737 a finally clause (to be executed for cleanup). | |
8738 A try conditional begins with a |:try| command and ends at the matching | |
8739 |:endtry| command. In between, you can use a |:catch| command to start | |
8740 a catch clause, or a |:finally| command to start a finally clause. There may | |
8741 be none or multiple catch clauses, but there is at most one finally clause, | |
8742 which must not be followed by any catch clauses. The lines before the catch | |
8743 clauses and the finally clause is called a try block. > | |
8744 | |
8745 :try | |
1621 | 8746 : ... |
8747 : ... TRY BLOCK | |
8748 : ... | |
7 | 8749 :catch /{pattern}/ |
1621 | 8750 : ... |
8751 : ... CATCH CLAUSE | |
8752 : ... | |
7 | 8753 :catch /{pattern}/ |
1621 | 8754 : ... |
8755 : ... CATCH CLAUSE | |
8756 : ... | |
7 | 8757 :finally |
1621 | 8758 : ... |
8759 : ... FINALLY CLAUSE | |
8760 : ... | |
7 | 8761 :endtry |
8762 | |
8763 The try conditional allows to watch code for exceptions and to take the | |
8764 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
8765 from the try block and also the catch clauses may cause cleanup actions. | |
8766 When no exception is thrown during execution of the try block, the control | |
8767 is transferred to the finally clause, if present. After its execution, the | |
8768 script continues with the line following the ":endtry". | |
8769 When an exception occurs during execution of the try block, the remaining | |
8770 lines in the try block are skipped. The exception is matched against the | |
8771 patterns specified as arguments to the ":catch" commands. The catch clause | |
8772 after the first matching ":catch" is taken, other catch clauses are not | |
8773 executed. The catch clause ends when the next ":catch", ":finally", or | |
8774 ":endtry" command is reached - whatever is first. Then, the finally clause | |
8775 (if present) is executed. When the ":endtry" is reached, the script execution | |
8776 continues in the following line as usual. | |
8777 When an exception that does not match any of the patterns specified by the | |
8778 ":catch" commands is thrown in the try block, the exception is not caught by | |
8779 that try conditional and none of the catch clauses is executed. Only the | |
8780 finally clause, if present, is taken. The exception pends during execution of | |
8781 the finally clause. It is resumed at the ":endtry", so that commands after | |
8782 the ":endtry" are not executed and the exception might be caught elsewhere, | |
8783 see |try-nesting|. | |
8784 When during execution of a catch clause another exception is thrown, the | |
1621 | 8785 remaining lines in that catch clause are not executed. The new exception is |
7 | 8786 not matched against the patterns in any of the ":catch" commands of the same |
8787 try conditional and none of its catch clauses is taken. If there is, however, | |
8788 a finally clause, it is executed, and the exception pends during its | |
8789 execution. The commands following the ":endtry" are not executed. The new | |
8790 exception might, however, be caught elsewhere, see |try-nesting|. | |
8791 When during execution of the finally clause (if present) an exception is | |
1621 | 8792 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 8793 clause has been taken because of an exception from the try block or one of the |
8794 catch clauses, the original (pending) exception is discarded. The commands | |
8795 following the ":endtry" are not executed, and the exception from the finally | |
8796 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
8797 | |
8798 The finally clause is also executed, when a ":break" or ":continue" for | |
8799 a ":while" loop enclosing the complete try conditional is executed from the | |
8800 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
8801 from the try block or a catch clause of a try conditional in a function or | |
8802 sourced script, respectively. The ":break", ":continue", ":return", or | |
8803 ":finish" pends during execution of the finally clause and is resumed when the | |
8804 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
8805 from the finally clause. | |
8806 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
8807 try conditional or when a ":return" or ":finish" is encountered in the finally | |
8808 clause, the rest of the finally clause is skipped, and the ":break", | |
8809 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
8810 clause has been taken because of an exception or an earlier ":break", | |
8811 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
8812 this pending exception or command is discarded. | |
8813 | |
8814 For examples see |throw-catch| and |try-finally|. | |
8815 | |
8816 | |
8817 NESTING OF TRY CONDITIONALS *try-nesting* | |
8818 | |
8819 Try conditionals can be nested arbitrarily. That is, a complete try | |
8820 conditional can be put into the try block, a catch clause, or the finally | |
8821 clause of another try conditional. If the inner try conditional does not | |
8822 catch an exception thrown in its try block or throws a new exception from one | |
8823 of its catch clauses or its finally clause, the outer try conditional is | |
8824 checked according to the rules above. If the inner try conditional is in the | |
8825 try block of the outer try conditional, its catch clauses are checked, but | |
1621 | 8826 otherwise only the finally clause is executed. It does not matter for |
7 | 8827 nesting, whether the inner try conditional is directly contained in the outer |
8828 one, or whether the outer one sources a script or calls a function containing | |
8829 the inner try conditional. | |
8830 | |
8831 When none of the active try conditionals catches an exception, just their | |
8832 finally clauses are executed. Thereafter, the script processing terminates. | |
8833 An error message is displayed in case of an uncaught exception explicitly | |
8834 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
8835 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
8836 as usual. | |
8837 | |
8838 For examples see |throw-catch|. | |
8839 | |
8840 | |
8841 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
8842 | |
8843 Exception handling code can get tricky. If you are in doubt what happens, set | |
8844 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
8845 script file. Then you see when an exception is thrown, discarded, caught, or | |
8846 finished. When using a verbosity level of at least 14, things pending in | |
8847 a finally clause are also shown. This information is also given in debug mode | |
8848 (see |debug-scripts|). | |
8849 | |
8850 | |
8851 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
8852 | |
8853 You can throw any number or string as an exception. Use the |:throw| command | |
8854 and pass the value to be thrown as argument: > | |
8855 :throw 4711 | |
8856 :throw "string" | |
8857 < *throw-expression* | |
8858 You can also specify an expression argument. The expression is then evaluated | |
8859 first, and the result is thrown: > | |
8860 :throw 4705 + strlen("string") | |
8861 :throw strpart("strings", 0, 6) | |
8862 | |
8863 An exception might be thrown during evaluation of the argument of the ":throw" | |
8864 command. Unless it is caught there, the expression evaluation is abandoned. | |
8865 The ":throw" command then does not throw a new exception. | |
8866 Example: > | |
8867 | |
8868 :function! Foo(arg) | |
8869 : try | |
8870 : throw a:arg | |
8871 : catch /foo/ | |
8872 : endtry | |
8873 : return 1 | |
8874 :endfunction | |
8875 : | |
8876 :function! Bar() | |
8877 : echo "in Bar" | |
8878 : return 4710 | |
8879 :endfunction | |
8880 : | |
8881 :throw Foo("arrgh") + Bar() | |
8882 | |
8883 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
8884 executed. > | |
8885 :throw Foo("foo") + Bar() | |
8886 however displays "in Bar" and throws 4711. | |
8887 | |
8888 Any other command that takes an expression as argument might also be | |
1621 | 8889 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 8890 exception is then propagated to the caller of the command. |
8891 Example: > | |
8892 | |
8893 :if Foo("arrgh") | |
8894 : echo "then" | |
8895 :else | |
8896 : echo "else" | |
8897 :endif | |
8898 | |
8899 Here neither of "then" or "else" is displayed. | |
8900 | |
8901 *catch-order* | |
8902 Exceptions can be caught by a try conditional with one or more |:catch| | |
8903 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
8904 command can be specified as a pattern argument. The subsequent catch clause | |
8905 gets executed when a matching exception is caught. | |
8906 Example: > | |
8907 | |
8908 :function! Foo(value) | |
8909 : try | |
8910 : throw a:value | |
8911 : catch /^\d\+$/ | |
8912 : echo "Number thrown" | |
8913 : catch /.*/ | |
8914 : echo "String thrown" | |
8915 : endtry | |
8916 :endfunction | |
8917 : | |
8918 :call Foo(0x1267) | |
8919 :call Foo('string') | |
8920 | |
8921 The first call to Foo() displays "Number thrown", the second "String thrown". | |
8922 An exception is matched against the ":catch" commands in the order they are | |
8923 specified. Only the first match counts. So you should place the more | |
8924 specific ":catch" first. The following order does not make sense: > | |
8925 | |
8926 : catch /.*/ | |
8927 : echo "String thrown" | |
8928 : catch /^\d\+$/ | |
8929 : echo "Number thrown" | |
8930 | |
8931 The first ":catch" here matches always, so that the second catch clause is | |
8932 never taken. | |
8933 | |
8934 *throw-variables* | |
8935 If you catch an exception by a general pattern, you may access the exact value | |
8936 in the variable |v:exception|: > | |
8937 | |
8938 : catch /^\d\+$/ | |
8939 : echo "Number thrown. Value is" v:exception | |
8940 | |
8941 You may also be interested where an exception was thrown. This is stored in | |
8942 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
8943 exception most recently caught as long it is not finished. | |
8944 Example: > | |
8945 | |
8946 :function! Caught() | |
8947 : if v:exception != "" | |
8948 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
8949 : else | |
8950 : echo 'Nothing caught' | |
8951 : endif | |
8952 :endfunction | |
8953 : | |
8954 :function! Foo() | |
8955 : try | |
8956 : try | |
8957 : try | |
8958 : throw 4711 | |
8959 : finally | |
8960 : call Caught() | |
8961 : endtry | |
8962 : catch /.*/ | |
8963 : call Caught() | |
8964 : throw "oops" | |
8965 : endtry | |
8966 : catch /.*/ | |
8967 : call Caught() | |
8968 : finally | |
8969 : call Caught() | |
8970 : endtry | |
8971 :endfunction | |
8972 : | |
8973 :call Foo() | |
8974 | |
8975 This displays > | |
8976 | |
8977 Nothing caught | |
8978 Caught "4711" in function Foo, line 4 | |
8979 Caught "oops" in function Foo, line 10 | |
8980 Nothing caught | |
8981 | |
8982 A practical example: The following command ":LineNumber" displays the line | |
8983 number in the script or function where it has been used: > | |
8984 | |
8985 :function! LineNumber() | |
8986 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
8987 :endfunction | |
8988 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
8989 < | |
8990 *try-nested* | |
8991 An exception that is not caught by a try conditional can be caught by | |
8992 a surrounding try conditional: > | |
8993 | |
8994 :try | |
8995 : try | |
8996 : throw "foo" | |
8997 : catch /foobar/ | |
8998 : echo "foobar" | |
8999 : finally | |
9000 : echo "inner finally" | |
9001 : endtry | |
9002 :catch /foo/ | |
9003 : echo "foo" | |
9004 :endtry | |
9005 | |
9006 The inner try conditional does not catch the exception, just its finally | |
9007 clause is executed. The exception is then caught by the outer try | |
9008 conditional. The example displays "inner finally" and then "foo". | |
9009 | |
9010 *throw-from-catch* | |
9011 You can catch an exception and throw a new one to be caught elsewhere from the | |
9012 catch clause: > | |
9013 | |
9014 :function! Foo() | |
9015 : throw "foo" | |
9016 :endfunction | |
9017 : | |
9018 :function! Bar() | |
9019 : try | |
9020 : call Foo() | |
9021 : catch /foo/ | |
9022 : echo "Caught foo, throw bar" | |
9023 : throw "bar" | |
9024 : endtry | |
9025 :endfunction | |
9026 : | |
9027 :try | |
9028 : call Bar() | |
9029 :catch /.*/ | |
9030 : echo "Caught" v:exception | |
9031 :endtry | |
9032 | |
9033 This displays "Caught foo, throw bar" and then "Caught bar". | |
9034 | |
9035 *rethrow* | |
9036 There is no real rethrow in the Vim script language, but you may throw | |
9037 "v:exception" instead: > | |
9038 | |
9039 :function! Bar() | |
9040 : try | |
9041 : call Foo() | |
9042 : catch /.*/ | |
9043 : echo "Rethrow" v:exception | |
9044 : throw v:exception | |
9045 : endtry | |
9046 :endfunction | |
9047 < *try-echoerr* | |
9048 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
9049 exceptions, because it is not possible to fake Vim internal exceptions. | |
9050 Trying so causes an error exception. You should throw your own exception | |
9051 denoting the situation. If you want to cause a Vim error exception containing | |
9052 the original error exception value, you can use the |:echoerr| command: > | |
9053 | |
9054 :try | |
9055 : try | |
9056 : asdf | |
9057 : catch /.*/ | |
9058 : echoerr v:exception | |
9059 : endtry | |
9060 :catch /.*/ | |
9061 : echo v:exception | |
9062 :endtry | |
9063 | |
9064 This code displays | |
9065 | |
1621 | 9066 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 9067 |
9068 | |
9069 CLEANUP CODE *try-finally* | |
9070 | |
9071 Scripts often change global settings and restore them at their end. If the | |
9072 user however interrupts the script by pressing CTRL-C, the settings remain in | |
1621 | 9073 an inconsistent state. The same may happen to you in the development phase of |
7 | 9074 a script when an error occurs or you explicitly throw an exception without |
9075 catching it. You can solve these problems by using a try conditional with | |
9076 a finally clause for restoring the settings. Its execution is guaranteed on | |
9077 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
9078 (Note that errors and interrupts from inside the try conditional are converted | |
1621 | 9079 to exceptions. When not caught, they terminate the script after the finally |
7 | 9080 clause has been executed.) |
9081 Example: > | |
9082 | |
9083 :try | |
9084 : let s:saved_ts = &ts | |
9085 : set ts=17 | |
9086 : | |
9087 : " Do the hard work here. | |
9088 : | |
9089 :finally | |
9090 : let &ts = s:saved_ts | |
9091 : unlet s:saved_ts | |
9092 :endtry | |
9093 | |
9094 This method should be used locally whenever a function or part of a script | |
9095 changes global settings which need to be restored on failure or normal exit of | |
9096 that function or script part. | |
9097 | |
9098 *break-finally* | |
9099 Cleanup code works also when the try block or a catch clause is left by | |
9100 a ":continue", ":break", ":return", or ":finish". | |
9101 Example: > | |
9102 | |
9103 :let first = 1 | |
9104 :while 1 | |
9105 : try | |
9106 : if first | |
9107 : echo "first" | |
9108 : let first = 0 | |
9109 : continue | |
9110 : else | |
9111 : throw "second" | |
9112 : endif | |
9113 : catch /.*/ | |
9114 : echo v:exception | |
9115 : break | |
9116 : finally | |
9117 : echo "cleanup" | |
9118 : endtry | |
9119 : echo "still in while" | |
9120 :endwhile | |
9121 :echo "end" | |
9122 | |
9123 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
9124 | |
9125 :function! Foo() | |
9126 : try | |
9127 : return 4711 | |
9128 : finally | |
9129 : echo "cleanup\n" | |
9130 : endtry | |
9131 : echo "Foo still active" | |
9132 :endfunction | |
9133 : | |
9134 :echo Foo() "returned by Foo" | |
9135 | |
9136 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
1621 | 9137 extra ":return" in the finally clause. (Above all, this would override the |
7 | 9138 return value.) |
9139 | |
9140 *except-from-finally* | |
9141 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
9142 a finally clause is possible, but not recommended since it abandons the | |
9143 cleanup actions for the try conditional. But, of course, interrupt and error | |
9144 exceptions might get raised from a finally clause. | |
9145 Example where an error in the finally clause stops an interrupt from | |
9146 working correctly: > | |
9147 | |
9148 :try | |
9149 : try | |
9150 : echo "Press CTRL-C for interrupt" | |
9151 : while 1 | |
9152 : endwhile | |
9153 : finally | |
9154 : unlet novar | |
9155 : endtry | |
9156 :catch /novar/ | |
9157 :endtry | |
9158 :echo "Script still running" | |
9159 :sleep 1 | |
9160 | |
9161 If you need to put commands that could fail into a finally clause, you should | |
9162 think about catching or ignoring the errors in these commands, see | |
9163 |catch-errors| and |ignore-errors|. | |
9164 | |
9165 | |
9166 CATCHING ERRORS *catch-errors* | |
9167 | |
9168 If you want to catch specific errors, you just have to put the code to be | |
9169 watched in a try block and add a catch clause for the error message. The | |
9170 presence of the try conditional causes all errors to be converted to an | |
9171 exception. No message is displayed and |v:errmsg| is not set then. To find | |
9172 the right pattern for the ":catch" command, you have to know how the format of | |
9173 the error exception is. | |
9174 Error exceptions have the following format: > | |
9175 | |
9176 Vim({cmdname}):{errmsg} | |
9177 or > | |
9178 Vim:{errmsg} | |
9179 | |
9180 {cmdname} is the name of the command that failed; the second form is used when | |
1621 | 9181 the command name is not known. {errmsg} is the error message usually produced |
7 | 9182 when the error occurs outside try conditionals. It always begins with |
9183 a capital "E", followed by a two or three-digit error number, a colon, and | |
9184 a space. | |
9185 | |
9186 Examples: | |
9187 | |
9188 The command > | |
9189 :unlet novar | |
9190 normally produces the error message > | |
9191 E108: No such variable: "novar" | |
9192 which is converted inside try conditionals to an exception > | |
9193 Vim(unlet):E108: No such variable: "novar" | |
9194 | |
9195 The command > | |
9196 :dwim | |
9197 normally produces the error message > | |
9198 E492: Not an editor command: dwim | |
9199 which is converted inside try conditionals to an exception > | |
9200 Vim:E492: Not an editor command: dwim | |
9201 | |
9202 You can catch all ":unlet" errors by a > | |
9203 :catch /^Vim(unlet):/ | |
9204 or all errors for misspelled command names by a > | |
9205 :catch /^Vim:E492:/ | |
9206 | |
9207 Some error messages may be produced by different commands: > | |
9208 :function nofunc | |
9209 and > | |
9210 :delfunction nofunc | |
9211 both produce the error message > | |
9212 E128: Function name must start with a capital: nofunc | |
9213 which is converted inside try conditionals to an exception > | |
9214 Vim(function):E128: Function name must start with a capital: nofunc | |
9215 or > | |
9216 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
9217 respectively. You can catch the error by its number independently on the | |
9218 command that caused it if you use the following pattern: > | |
9219 :catch /^Vim(\a\+):E128:/ | |
9220 | |
9221 Some commands like > | |
9222 :let x = novar | |
9223 produce multiple error messages, here: > | |
9224 E121: Undefined variable: novar | |
9225 E15: Invalid expression: novar | |
9226 Only the first is used for the exception value, since it is the most specific | |
9227 one (see |except-several-errors|). So you can catch it by > | |
9228 :catch /^Vim(\a\+):E121:/ | |
9229 | |
9230 You can catch all errors related to the name "nofunc" by > | |
9231 :catch /\<nofunc\>/ | |
9232 | |
9233 You can catch all Vim errors in the ":write" and ":read" commands by > | |
9234 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
9235 | |
9236 You can catch all Vim errors by the pattern > | |
9237 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
9238 < | |
9239 *catch-text* | |
9240 NOTE: You should never catch the error message text itself: > | |
9241 :catch /No such variable/ | |
6647 | 9242 only works in the English locale, but not when the user has selected |
7 | 9243 a different language by the |:language| command. It is however helpful to |
9244 cite the message text in a comment: > | |
9245 :catch /^Vim(\a\+):E108:/ " No such variable | |
9246 | |
9247 | |
9248 IGNORING ERRORS *ignore-errors* | |
9249 | |
9250 You can ignore errors in a specific Vim command by catching them locally: > | |
9251 | |
9252 :try | |
9253 : write | |
9254 :catch | |
9255 :endtry | |
9256 | |
9257 But you are strongly recommended NOT to use this simple form, since it could | |
9258 catch more than you want. With the ":write" command, some autocommands could | |
9259 be executed and cause errors not related to writing, for instance: > | |
9260 | |
9261 :au BufWritePre * unlet novar | |
9262 | |
9263 There could even be such errors you are not responsible for as a script | |
9264 writer: a user of your script might have defined such autocommands. You would | |
9265 then hide the error from the user. | |
9266 It is much better to use > | |
9267 | |
9268 :try | |
9269 : write | |
9270 :catch /^Vim(write):/ | |
9271 :endtry | |
9272 | |
9273 which only catches real write errors. So catch only what you'd like to ignore | |
9274 intentionally. | |
9275 | |
9276 For a single command that does not cause execution of autocommands, you could | |
9277 even suppress the conversion of errors to exceptions by the ":silent!" | |
9278 command: > | |
9279 :silent! nunmap k | |
9280 This works also when a try conditional is active. | |
9281 | |
9282 | |
9283 CATCHING INTERRUPTS *catch-interrupt* | |
9284 | |
9285 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
1621 | 9286 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 9287 script is not terminated, then. |
9288 Example: > | |
9289 | |
9290 :function! TASK1() | |
9291 : sleep 10 | |
9292 :endfunction | |
9293 | |
9294 :function! TASK2() | |
9295 : sleep 20 | |
9296 :endfunction | |
9297 | |
9298 :while 1 | |
9299 : let command = input("Type a command: ") | |
9300 : try | |
9301 : if command == "" | |
9302 : continue | |
9303 : elseif command == "END" | |
9304 : break | |
9305 : elseif command == "TASK1" | |
9306 : call TASK1() | |
9307 : elseif command == "TASK2" | |
9308 : call TASK2() | |
9309 : else | |
9310 : echo "\nIllegal command:" command | |
9311 : continue | |
9312 : endif | |
9313 : catch /^Vim:Interrupt$/ | |
9314 : echo "\nCommand interrupted" | |
9315 : " Caught the interrupt. Continue with next prompt. | |
9316 : endtry | |
9317 :endwhile | |
9318 | |
9319 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
1621 | 9320 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 9321 |
9322 For testing what happens when CTRL-C would be pressed on a specific line in | |
9323 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
9324 command on that line. See |debug-scripts|. | |
9325 | |
9326 | |
9327 CATCHING ALL *catch-all* | |
9328 | |
9329 The commands > | |
9330 | |
9331 :catch /.*/ | |
9332 :catch // | |
9333 :catch | |
9334 | |
9335 catch everything, error exceptions, interrupt exceptions and exceptions | |
9336 explicitly thrown by the |:throw| command. This is useful at the top level of | |
9337 a script in order to catch unexpected things. | |
9338 Example: > | |
9339 | |
9340 :try | |
9341 : | |
9342 : " do the hard work here | |
9343 : | |
9344 :catch /MyException/ | |
9345 : | |
9346 : " handle known problem | |
9347 : | |
9348 :catch /^Vim:Interrupt$/ | |
9349 : echo "Script interrupted" | |
9350 :catch /.*/ | |
9351 : echo "Internal error (" . v:exception . ")" | |
9352 : echo " - occurred at " . v:throwpoint | |
9353 :endtry | |
9354 :" end of script | |
9355 | |
9356 Note: Catching all might catch more things than you want. Thus, you are | |
9357 strongly encouraged to catch only for problems that you can really handle by | |
9358 specifying a pattern argument to the ":catch". | |
9359 Example: Catching all could make it nearly impossible to interrupt a script | |
9360 by pressing CTRL-C: > | |
9361 | |
9362 :while 1 | |
9363 : try | |
9364 : sleep 1 | |
9365 : catch | |
9366 : endtry | |
9367 :endwhile | |
9368 | |
9369 | |
9370 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
9371 | |
9372 Exceptions may be used during execution of autocommands. Example: > | |
9373 | |
9374 :autocmd User x try | |
9375 :autocmd User x throw "Oops!" | |
9376 :autocmd User x catch | |
9377 :autocmd User x echo v:exception | |
9378 :autocmd User x endtry | |
9379 :autocmd User x throw "Arrgh!" | |
9380 :autocmd User x echo "Should not be displayed" | |
9381 : | |
9382 :try | |
9383 : doautocmd User x | |
9384 :catch | |
9385 : echo v:exception | |
9386 :endtry | |
9387 | |
9388 This displays "Oops!" and "Arrgh!". | |
9389 | |
9390 *except-autocmd-Pre* | |
9391 For some commands, autocommands get executed before the main action of the | |
9392 command takes place. If an exception is thrown and not caught in the sequence | |
9393 of autocommands, the sequence and the command that caused its execution are | |
9394 abandoned and the exception is propagated to the caller of the command. | |
9395 Example: > | |
9396 | |
9397 :autocmd BufWritePre * throw "FAIL" | |
9398 :autocmd BufWritePre * echo "Should not be displayed" | |
9399 : | |
9400 :try | |
9401 : write | |
9402 :catch | |
9403 : echo "Caught:" v:exception "from" v:throwpoint | |
9404 :endtry | |
9405 | |
9406 Here, the ":write" command does not write the file currently being edited (as | |
9407 you can see by checking 'modified'), since the exception from the BufWritePre | |
9408 autocommand abandons the ":write". The exception is then caught and the | |
9409 script displays: > | |
9410 | |
9411 Caught: FAIL from BufWrite Auto commands for "*" | |
9412 < | |
9413 *except-autocmd-Post* | |
9414 For some commands, autocommands get executed after the main action of the | |
9415 command has taken place. If this main action fails and the command is inside | |
9416 an active try conditional, the autocommands are skipped and an error exception | |
9417 is thrown that can be caught by the caller of the command. | |
9418 Example: > | |
9419 | |
9420 :autocmd BufWritePost * echo "File successfully written!" | |
9421 : | |
9422 :try | |
9423 : write /i/m/p/o/s/s/i/b/l/e | |
9424 :catch | |
9425 : echo v:exception | |
9426 :endtry | |
9427 | |
9428 This just displays: > | |
9429 | |
9430 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
9431 | |
9432 If you really need to execute the autocommands even when the main action | |
9433 fails, trigger the event from the catch clause. | |
9434 Example: > | |
9435 | |
9436 :autocmd BufWritePre * set noreadonly | |
9437 :autocmd BufWritePost * set readonly | |
9438 : | |
9439 :try | |
9440 : write /i/m/p/o/s/s/i/b/l/e | |
9441 :catch | |
9442 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
9443 :endtry | |
9444 < | |
9445 You can also use ":silent!": > | |
9446 | |
9447 :let x = "ok" | |
9448 :let v:errmsg = "" | |
9449 :autocmd BufWritePost * if v:errmsg != "" | |
9450 :autocmd BufWritePost * let x = "after fail" | |
9451 :autocmd BufWritePost * endif | |
9452 :try | |
9453 : silent! write /i/m/p/o/s/s/i/b/l/e | |
9454 :catch | |
9455 :endtry | |
9456 :echo x | |
9457 | |
9458 This displays "after fail". | |
9459 | |
9460 If the main action of the command does not fail, exceptions from the | |
9461 autocommands will be catchable by the caller of the command: > | |
9462 | |
9463 :autocmd BufWritePost * throw ":-(" | |
9464 :autocmd BufWritePost * echo "Should not be displayed" | |
9465 : | |
9466 :try | |
9467 : write | |
9468 :catch | |
9469 : echo v:exception | |
9470 :endtry | |
9471 < | |
9472 *except-autocmd-Cmd* | |
9473 For some commands, the normal action can be replaced by a sequence of | |
9474 autocommands. Exceptions from that sequence will be catchable by the caller | |
9475 of the command. | |
9476 Example: For the ":write" command, the caller cannot know whether the file | |
1621 | 9477 had actually been written when the exception occurred. You need to tell it in |
7 | 9478 some way. > |
9479 | |
9480 :if !exists("cnt") | |
9481 : let cnt = 0 | |
9482 : | |
9483 : autocmd BufWriteCmd * if &modified | |
9484 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
9485 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
9486 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
9487 : autocmd BufWriteCmd * endif | |
9488 : autocmd BufWriteCmd * write | set nomodified | |
9489 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
9490 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
9491 : autocmd BufWriteCmd * endif | |
9492 : autocmd BufWriteCmd * echo "File successfully written!" | |
9493 : autocmd BufWriteCmd * endif | |
9494 :endif | |
9495 : | |
9496 :try | |
9497 : write | |
9498 :catch /^BufWriteCmdError$/ | |
9499 : if &modified | |
9500 : echo "Error on writing (file contents not changed)" | |
9501 : else | |
9502 : echo "Error after writing" | |
9503 : endif | |
9504 :catch /^Vim(write):/ | |
9505 : echo "Error on writing" | |
9506 :endtry | |
9507 | |
9508 When this script is sourced several times after making changes, it displays | |
9509 first > | |
9510 File successfully written! | |
9511 then > | |
9512 Error on writing (file contents not changed) | |
9513 then > | |
9514 Error after writing | |
9515 etc. | |
9516 | |
9517 *except-autocmd-ill* | |
9518 You cannot spread a try conditional over autocommands for different events. | |
9519 The following code is ill-formed: > | |
9520 | |
9521 :autocmd BufWritePre * try | |
9522 : | |
9523 :autocmd BufWritePost * catch | |
9524 :autocmd BufWritePost * echo v:exception | |
9525 :autocmd BufWritePost * endtry | |
9526 : | |
9527 :write | |
9528 | |
9529 | |
9530 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
9531 | |
9532 Some programming languages allow to use hierarchies of exception classes or to | |
9533 pass additional information with the object of an exception class. You can do | |
9534 similar things in Vim. | |
9535 In order to throw an exception from a hierarchy, just throw the complete | |
9536 class name with the components separated by a colon, for instance throw the | |
9537 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
9538 When you want to pass additional information with your exception class, add | |
9539 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
9540 for an error when writing "myfile". | |
9541 With the appropriate patterns in the ":catch" command, you can catch for | |
9542 base classes or derived classes of your hierarchy. Additional information in | |
9543 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
9544 Example: > | |
9545 | |
9546 :function! CheckRange(a, func) | |
9547 : if a:a < 0 | |
9548 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
9549 : endif | |
9550 :endfunction | |
9551 : | |
9552 :function! Add(a, b) | |
9553 : call CheckRange(a:a, "Add") | |
9554 : call CheckRange(a:b, "Add") | |
9555 : let c = a:a + a:b | |
9556 : if c < 0 | |
9557 : throw "EXCEPT:MATHERR:OVERFLOW" | |
9558 : endif | |
9559 : return c | |
9560 :endfunction | |
9561 : | |
9562 :function! Div(a, b) | |
9563 : call CheckRange(a:a, "Div") | |
9564 : call CheckRange(a:b, "Div") | |
9565 : if (a:b == 0) | |
9566 : throw "EXCEPT:MATHERR:ZERODIV" | |
9567 : endif | |
9568 : return a:a / a:b | |
9569 :endfunction | |
9570 : | |
9571 :function! Write(file) | |
9572 : try | |
1621 | 9573 : execute "write" fnameescape(a:file) |
7 | 9574 : catch /^Vim(write):/ |
9575 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
9576 : endtry | |
9577 :endfunction | |
9578 : | |
9579 :try | |
9580 : | |
9581 : " something with arithmetics and I/O | |
9582 : | |
9583 :catch /^EXCEPT:MATHERR:RANGE/ | |
9584 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
9585 : echo "Range error in" function | |
9586 : | |
9587 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
9588 : echo "Math error" | |
9589 : | |
9590 :catch /^EXCEPT:IO/ | |
9591 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
9592 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
9593 : if file !~ '^/' | |
9594 : let file = dir . "/" . file | |
9595 : endif | |
9596 : echo 'I/O error for "' . file . '"' | |
9597 : | |
9598 :catch /^EXCEPT/ | |
9599 : echo "Unspecified error" | |
9600 : | |
9601 :endtry | |
9602 | |
9603 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
9604 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
9605 exceptions with the "Vim" prefix; they are reserved for Vim. | |
9606 Vim error exceptions are parameterized with the name of the command that | |
9607 failed, if known. See |catch-errors|. | |
9608 | |
9609 | |
9610 PECULIARITIES | |
9611 *except-compat* | |
9612 The exception handling concept requires that the command sequence causing the | |
9613 exception is aborted immediately and control is transferred to finally clauses | |
9614 and/or a catch clause. | |
9615 | |
9616 In the Vim script language there are cases where scripts and functions | |
9617 continue after an error: in functions without the "abort" flag or in a command | |
9618 after ":silent!", control flow goes to the following line, and outside | |
9619 functions, control flow goes to the line following the outermost ":endwhile" | |
9620 or ":endif". On the other hand, errors should be catchable as exceptions | |
9621 (thus, requiring the immediate abortion). | |
9622 | |
9623 This problem has been solved by converting errors to exceptions and using | |
9624 immediate abortion (if not suppressed by ":silent!") only when a try | |
1621 | 9625 conditional is active. This is no restriction since an (error) exception can |
9626 be caught only from an active try conditional. If you want an immediate | |
7 | 9627 termination without catching the error, just use a try conditional without |
9628 catch clause. (You can cause cleanup code being executed before termination | |
9629 by specifying a finally clause.) | |
9630 | |
9631 When no try conditional is active, the usual abortion and continuation | |
9632 behavior is used instead of immediate abortion. This ensures compatibility of | |
9633 scripts written for Vim 6.1 and earlier. | |
9634 | |
9635 However, when sourcing an existing script that does not use exception handling | |
9636 commands (or when calling one of its functions) from inside an active try | |
9637 conditional of a new script, you might change the control flow of the existing | |
9638 script on error. You get the immediate abortion on error and can catch the | |
9639 error in the new script. If however the sourced script suppresses error | |
9640 messages by using the ":silent!" command (checking for errors by testing | |
1621 | 9641 |v:errmsg| if appropriate), its execution path is not changed. The error is |
9642 not converted to an exception. (See |:silent|.) So the only remaining cause | |
7 | 9643 where this happens is for scripts that don't care about errors and produce |
9644 error messages. You probably won't want to use such code from your new | |
9645 scripts. | |
9646 | |
9647 *except-syntax-err* | |
9648 Syntax errors in the exception handling commands are never caught by any of | |
9649 the ":catch" commands of the try conditional they belong to. Its finally | |
9650 clauses, however, is executed. | |
9651 Example: > | |
9652 | |
9653 :try | |
9654 : try | |
9655 : throw 4711 | |
9656 : catch /\(/ | |
9657 : echo "in catch with syntax error" | |
9658 : catch | |
9659 : echo "inner catch-all" | |
9660 : finally | |
9661 : echo "inner finally" | |
9662 : endtry | |
9663 :catch | |
9664 : echo 'outer catch-all caught "' . v:exception . '"' | |
9665 : finally | |
9666 : echo "outer finally" | |
9667 :endtry | |
9668 | |
9669 This displays: > | |
9670 inner finally | |
9671 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
9672 outer finally | |
9673 The original exception is discarded and an error exception is raised, instead. | |
9674 | |
9675 *except-single-line* | |
9676 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
9677 a single line, but then syntax errors may make it difficult to recognize the | |
9678 "catch" line, thus you better avoid this. | |
9679 Example: > | |
9680 :try | unlet! foo # | catch | endtry | |
9681 raises an error exception for the trailing characters after the ":unlet!" | |
9682 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
9683 error exception is discarded and the "E488: Trailing characters" message gets | |
9684 displayed. | |
9685 | |
9686 *except-several-errors* | |
9687 When several errors appear in a single command, the first error message is | |
9688 usually the most specific one and therefor converted to the error exception. | |
9689 Example: > | |
9690 echo novar | |
9691 causes > | |
9692 E121: Undefined variable: novar | |
9693 E15: Invalid expression: novar | |
9694 The value of the error exception inside try conditionals is: > | |
9695 Vim(echo):E121: Undefined variable: novar | |
9696 < *except-syntax-error* | |
9697 But when a syntax error is detected after a normal error in the same command, | |
9698 the syntax error is used for the exception being thrown. | |
9699 Example: > | |
9700 unlet novar # | |
9701 causes > | |
9702 E108: No such variable: "novar" | |
9703 E488: Trailing characters | |
9704 The value of the error exception inside try conditionals is: > | |
9705 Vim(unlet):E488: Trailing characters | |
9706 This is done because the syntax error might change the execution path in a way | |
9707 not intended by the user. Example: > | |
9708 try | |
9709 try | unlet novar # | catch | echo v:exception | endtry | |
9710 catch /.*/ | |
9711 echo "outer catch:" v:exception | |
9712 endtry | |
9713 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
9714 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
9715 | |
9716 ============================================================================== | |
9717 9. Examples *eval-examples* | |
9718 | |
1156 | 9719 Printing in Binary ~ |
7 | 9720 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9721 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 9722 :func Nr2Bin(nr) |
7 | 9723 : let n = a:nr |
9724 : let r = "" | |
9725 : while n | |
1156 | 9726 : let r = '01'[n % 2] . r |
9727 : let n = n / 2 | |
7 | 9728 : endwhile |
9729 : return r | |
9730 :endfunc | |
9731 | |
1156 | 9732 :" The function String2Bin() converts each character in a string to a |
9733 :" binary string, separated with dashes. | |
9734 :func String2Bin(str) | |
7 | 9735 : let out = '' |
1156 | 9736 : for ix in range(strlen(a:str)) |
9737 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
9738 : endfor | |
9739 : return out[1:] | |
7 | 9740 :endfunc |
9741 | |
9742 Example of its use: > | |
1156 | 9743 :echo Nr2Bin(32) |
9744 result: "100000" > | |
9745 :echo String2Bin("32") | |
9746 result: "110011-110010" | |
9747 | |
9748 | |
9749 Sorting lines ~ | |
9750 | |
9751 This example sorts lines with a specific compare function. > | |
9752 | |
9753 :func SortBuffer() | |
9754 : let lines = getline(1, '$') | |
9755 : call sort(lines, function("Strcmp")) | |
9756 : call setline(1, lines) | |
7 | 9757 :endfunction |
9758 | |
1156 | 9759 As a one-liner: > |
9760 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
9761 | |
9762 | |
9763 scanf() replacement ~ | |
7 | 9764 *sscanf* |
9765 There is no sscanf() function in Vim. If you need to extract parts from a | |
9766 line, you can use matchstr() and substitute() to do it. This example shows | |
9767 how to get the file name, line number and column number out of a line like | |
9768 "foobar.txt, 123, 45". > | |
9769 :" Set up the match bit | |
9770 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
9771 :"get the part matching the whole expression | |
9772 :let l = matchstr(line, mx) | |
9773 :"get each item out of the match | |
9774 :let file = substitute(l, mx, '\1', '') | |
9775 :let lnum = substitute(l, mx, '\2', '') | |
9776 :let col = substitute(l, mx, '\3', '') | |
9777 | |
9778 The input is in the variable "line", the results in the variables "file", | |
9779 "lnum" and "col". (idea from Michael Geddes) | |
9780 | |
1156 | 9781 |
9782 getting the scriptnames in a Dictionary ~ | |
9783 *scriptnames-dictionary* | |
9784 The |:scriptnames| command can be used to get a list of all script files that | |
9785 have been sourced. There is no equivalent function or variable for this | |
9786 (because it's rarely needed). In case you need to manipulate the list this | |
9787 code can be used: > | |
9788 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
9789 let scriptnames_output = '' | |
9790 redir => scriptnames_output | |
9791 silent scriptnames | |
9792 redir END | |
9793 | |
1621 | 9794 " Split the output into lines and parse each line. Add an entry to the |
1156 | 9795 " "scripts" dictionary. |
9796 let scripts = {} | |
9797 for line in split(scriptnames_output, "\n") | |
9798 " Only do non-blank lines. | |
9799 if line =~ '\S' | |
9800 " Get the first number in the line. | |
1621 | 9801 let nr = matchstr(line, '\d\+') |
1156 | 9802 " Get the file name, remove the script number " 123: ". |
1621 | 9803 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 9804 " Add an item to the Dictionary |
1621 | 9805 let scripts[nr] = name |
1156 | 9806 endif |
9807 endfor | |
9808 unlet scriptnames_output | |
9809 | |
7 | 9810 ============================================================================== |
9811 10. No +eval feature *no-eval-feature* | |
9812 | |
9813 When the |+eval| feature was disabled at compile time, none of the expression | |
9814 evaluation commands are available. To prevent this from causing Vim scripts | |
9815 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
9816 recognized, though the argument of the ":if" and everything between the ":if" | |
9817 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
9818 only if the commands are at the start of the line. The ":else" command is not | |
9819 recognized. | |
9820 | |
9821 Example of how to avoid executing commands when the |+eval| feature is | |
9822 missing: > | |
9823 | |
9824 :if 1 | |
9825 : echo "Expression evaluation is compiled in" | |
9826 :else | |
9827 : echo "You will _never_ see this message" | |
9828 :endif | |
9829 | |
9830 ============================================================================== | |
9831 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
9832 | |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9833 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
|
9834 '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
|
9835 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
|
9836 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
|
9837 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 9838 The sandbox is also used for the |:sandbox| command. |
7 | 9839 |
9840 These items are not allowed in the sandbox: | |
9841 - changing the buffer text | |
9842 - defining or changing mapping, autocommands, functions, user commands | |
9843 - setting certain options (see |option-summary|) | |
1156 | 9844 - setting certain v: variables (see |v:var|) *E794* |
7 | 9845 - executing a shell command |
9846 - reading or writing a file | |
9847 - jumping to another buffer or editing a file | |
625 | 9848 - executing Python, Perl, etc. commands |
29 | 9849 This is not guaranteed 100% secure, but it should block most attacks. |
9850 | |
9851 *:san* *:sandbox* | |
401 | 9852 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 9853 option that may have been set from a modeline, e.g. |
9854 'foldexpr'. | |
9855 | |
634 | 9856 *sandbox-option* |
9857 A few options contain an expression. When this expression is evaluated it may | |
790 | 9858 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 9859 restrictive, thus this only happens when the option was set from an insecure |
9860 location. Insecure in this context are: | |
843 | 9861 - sourcing a .vimrc or .exrc in the current directory |
634 | 9862 - while executing in the sandbox |
9863 - value coming from a modeline | |
9864 | |
9865 Note that when in the sandbox and saving an option value and restoring it, the | |
9866 option will still be marked as it was set in the sandbox. | |
9867 | |
9868 ============================================================================== | |
9869 12. Textlock *textlock* | |
9870 | |
9871 In a few situations it is not allowed to change the text in the buffer, jump | |
9872 to another window and some other things that might confuse or break what Vim | |
9873 is currently doing. This mostly applies to things that happen when Vim is | |
1621 | 9874 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 9875 happen any moment the mouse cursor is resting at some position. |
9876 | |
9877 This is not allowed when the textlock is active: | |
9878 - changing the buffer text | |
9879 - jumping to another buffer or window | |
9880 - editing another file | |
9881 - closing a window or quitting Vim | |
9882 - etc. | |
9883 | |
7 | 9884 |
9885 vim:tw=78:ts=8:ft=help:norl: |