|
99
|
1 *eval.txt* For Vim version 7.0aa. Last change: 2005 Jan 14
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
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
|
|
99
|
12 done, the features in this document are not available. See |+eval| and
|
|
|
13 |no-eval-feature|.
|
|
7
|
14
|
|
85
|
15 1. Variables |variables|
|
|
|
16 1.1 Variable types
|
|
87
|
17 1.2 Function references |Funcref|
|
|
|
18 1.3 Lists |List|
|
|
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|
|
|
7
|
31
|
|
|
32 {Vi does not have any of these commands}
|
|
|
33
|
|
|
34 ==============================================================================
|
|
|
35 1. Variables *variables*
|
|
|
36
|
|
85
|
37 1.1 Variable types ~
|
|
|
38
|
|
|
39 There are four types of variables:
|
|
55
|
40
|
|
99
|
41 Number A 32 bit signed number.
|
|
|
42 Examples: -123 0x10 0177
|
|
|
43
|
|
|
44 String A NUL terminated string of 8-bit unsigned characters (bytes).
|
|
|
45 Examples: "ab\txx\"--" 'x-z''a,c'
|
|
|
46
|
|
|
47 Funcref A reference to a function |Funcref|.
|
|
|
48 Example: function("strlen")
|
|
|
49
|
|
|
50 List An ordered sequence of items |List|.
|
|
|
51 Example: [1, 2, ['a', 'b']]
|
|
55
|
52
|
|
|
53 The Number and String types are converted automatically, depending on how they
|
|
|
54 are used.
|
|
7
|
55
|
|
|
56 Conversion from a Number to a String is by making the ASCII representation of
|
|
|
57 the Number. Examples: >
|
|
|
58 Number 123 --> String "123"
|
|
|
59 Number 0 --> String "0"
|
|
|
60 Number -1 --> String "-1"
|
|
|
61
|
|
|
62 Conversion from a String to a Number is done by converting the first digits
|
|
|
63 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
|
|
|
64 the String doesn't start with digits, the result is zero. Examples: >
|
|
|
65 String "456" --> Number 456
|
|
|
66 String "6bar" --> Number 6
|
|
|
67 String "foo" --> Number 0
|
|
|
68 String "0xf1" --> Number 241
|
|
|
69 String "0100" --> Number 64
|
|
|
70 String "-8" --> Number -8
|
|
|
71 String "+8" --> Number 0
|
|
|
72
|
|
|
73 To force conversion from String to Number, add zero to it: >
|
|
|
74 :echo "0100" + 0
|
|
|
75
|
|
|
76 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
|
|
|
77
|
|
|
78 Note that in the command >
|
|
|
79 :if "foo"
|
|
|
80 "foo" is converted to 0, which means FALSE. To test for a non-empty string,
|
|
|
81 use strlen(): >
|
|
|
82 :if strlen("foo")
|
|
|
83
|
|
85
|
84 List and Funcref types are not automatically converted.
|
|
|
85
|
|
|
86 *E706*
|
|
|
87 You will get an error if you try to change the type of a variable. You need
|
|
|
88 to |:unlet| it first to avoid this error. String and Number are considered
|
|
99
|
89 equivalent though. Consider this sequence of commands: >
|
|
85
|
90 :let l = "string"
|
|
87
|
91 :let l = 44 " changes type from String to Number
|
|
85
|
92 :let l = [1, 2, 3] " error!
|
|
|
93
|
|
|
94
|
|
87
|
95 1.2 Function references ~
|
|
85
|
96 *Funcref* *E695* *E703*
|
|
55
|
97 A Funcref variable is obtained with the |function()| function. It can be used
|
|
|
98 in an expression to invoke the function it refers to by using it in the place
|
|
|
99 of a function name, before the parenthesis around the arguments. Example: >
|
|
|
100
|
|
|
101 :let Fn = function("MyFunc")
|
|
|
102 :echo Fn()
|
|
85
|
103 <
|
|
|
104 *E704* *E705* *E707*
|
|
|
105 A Funcref variable must start with a capital, "s:", "w:" or "b:". You cannot
|
|
|
106 have both a Funcref variable and a function with the same name.
|
|
|
107
|
|
87
|
108 Note that a Funcref cannot be used with the |:call| command, because its
|
|
|
109 argument is not an expression.
|
|
85
|
110
|
|
|
111 The name of the referenced function can be obtained with |string()|. >
|
|
|
112 :echo "The function is " . string(Myfunc)
|
|
|
113
|
|
|
114 You can use |call()| to invoke a Funcref and use a list variable for the
|
|
|
115 arguments: >
|
|
|
116 :let r = call(Myfunc, mylist)
|
|
|
117
|
|
|
118
|
|
87
|
119 1.3 Lists ~
|
|
85
|
120 *List* *E686*
|
|
55
|
121 A List is an ordered sequence of items. An item can be of any type. Items
|
|
|
122 can be accessed by their index number. Items can be added and removed at any
|
|
|
123 position in the sequence.
|
|
|
124
|
|
85
|
125
|
|
|
126 List creation ~
|
|
|
127 *E696* *E697*
|
|
55
|
128 A List is created with a comma separated list of items in square brackets.
|
|
85
|
129 Examples: >
|
|
|
130 :let mylist = [1, two, 3, "four"]
|
|
|
131 :let emptylist = []
|
|
55
|
132
|
|
|
133 An item can be any expression. Using a List for an item creates a
|
|
85
|
134 nested List: >
|
|
|
135 :let nestlist = [[11, 12], [21, 22], [31, 32]]
|
|
55
|
136
|
|
|
137 An extra comma after the last item is ignored.
|
|
|
138
|
|
85
|
139
|
|
|
140 List index ~
|
|
|
141 *list-index* *E684*
|
|
55
|
142 An item in the List can be accessed by putting the index in square brackets
|
|
85
|
143 after the List. Indexes are zero-based, thus the first item has index zero. >
|
|
|
144 :let item = mylist[0] " get the first item: 1
|
|
55
|
145 :let item = mylist[2] " get the third item: 3
|
|
85
|
146
|
|
87
|
147 When the resulting item is a list this can be repeated: >
|
|
85
|
148 :let item = nestlist[0][1] " get the first list, second item: 12
|
|
55
|
149 <
|
|
85
|
150 A negative index is counted from the end. Index -1 refers to the last item in
|
|
|
151 the List, -2 to the last but one item, etc. >
|
|
55
|
152 :let last = mylist[-1] " get the last item: "four"
|
|
|
153
|
|
85
|
154 To avoid an error for an invalid index use the |get()| function. When an item
|
|
87
|
155 is not available it returns zero or the default value you specify: >
|
|
85
|
156 :echo get(mylist, idx)
|
|
|
157 :echo get(mylist, idx, "NONE")
|
|
|
158
|
|
|
159
|
|
|
160 List concatenation ~
|
|
|
161
|
|
|
162 Two lists can be concatenated with the "+" operator: >
|
|
|
163 :let longlist = mylist + [5, 6]
|
|
|
164
|
|
|
165 To prepend or append an item turn the item into a list by putting [] around
|
|
|
166 it. To change a list in-place see |list-modification| below.
|
|
|
167
|
|
|
168
|
|
|
169 Sublist ~
|
|
|
170
|
|
55
|
171 A part of the List can be obtained by specifying the first and last index,
|
|
|
172 separated by a colon in square brackets: >
|
|
85
|
173 :let shortlist = mylist[2:-1] " get List [3, "four"]
|
|
55
|
174
|
|
|
175 Omitting the first index is similar to zero. Omitting the last index is
|
|
|
176 similar to -1. The difference is that there is no error if the items are not
|
|
|
177 available. >
|
|
90
|
178 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
|
|
|
179 :let shortlist = mylist[2:2] " List with one item: [3]
|
|
|
180 :let otherlist = mylist[:] " make a copy of the List
|
|
85
|
181
|
|
99
|
182 The second index can be just before the first index. In that case the result
|
|
|
183 is an empty list. If the second index is lower, this results in an error. >
|
|
|
184 :echo mylist[2:1] " result: []
|
|
|
185 :echo mylist[2:0] " error!
|
|
|
186
|
|
85
|
187
|
|
|
188 List identity ~
|
|
99
|
189 *list-identity*
|
|
85
|
190 When variable "aa" is a list and you assign it to another variable "bb", both
|
|
|
191 variables refer to the same list. Thus changing the list "aa" will also
|
|
|
192 change "bb": >
|
|
|
193 :let aa = [1, 2, 3]
|
|
|
194 :let bb = aa
|
|
|
195 :call add(aa, 4)
|
|
|
196 :echo bb
|
|
|
197 [1, 2, 3, 4]
|
|
|
198
|
|
|
199 Making a copy of a list is done with the |copy()| function. Using [:] also
|
|
|
200 works, as explained above. This creates a shallow copy of the list: Changing
|
|
87
|
201 a list item in the list will also change the item in the copied list: >
|
|
85
|
202 :let aa = [[1, 'a'], 2, 3]
|
|
|
203 :let bb = copy(aa)
|
|
|
204 :let aa = aa + [4]
|
|
|
205 :let aa[0][1] = 'aaa'
|
|
|
206 :echo aa
|
|
|
207 [[1, aaa], 2, 3, 4]
|
|
|
208 :echo bb
|
|
|
209 [[1, aaa], 2, 3]
|
|
|
210
|
|
87
|
211 To make a completely independent list use |deepcopy()|. This also makes a
|
|
|
212 copy of the values in the list, recursively.
|
|
85
|
213
|
|
|
214 The operator "is" can be used to check if two variables refer to the same
|
|
|
215 list. "isnot" does the opposite. In contrast "==" compares if two lists have
|
|
87
|
216 the same value. >
|
|
|
217 :let alist = [1, 2, 3]
|
|
|
218 :let blist = [1, 2, 3]
|
|
|
219 :echo alist is blist
|
|
|
220 0
|
|
|
221 :echo alist == blist
|
|
|
222 1
|
|
85
|
223
|
|
|
224
|
|
|
225 List unpack ~
|
|
|
226
|
|
|
227 To unpack the items in a list to individual variables, put the variables in
|
|
|
228 square brackets, like list items: >
|
|
|
229 :let [var1, var2] = mylist
|
|
|
230
|
|
|
231 When the number of variables does not match the number of items in the list
|
|
|
232 this produces an error. To handle any extra items from the list append ";"
|
|
|
233 and a variable name: >
|
|
|
234 :let [var1, var2; rest] = mylist
|
|
|
235
|
|
|
236 This works like: >
|
|
|
237 :let var1 = mylist[0]
|
|
|
238 :let var2 = mylist[1]
|
|
95
|
239 :let rest = mylist[2:]
|
|
85
|
240
|
|
|
241 Except that there is no error if there are only two items. "rest" will be an
|
|
|
242 empty list then.
|
|
|
243
|
|
|
244
|
|
|
245 List modification ~
|
|
|
246 *list-modification*
|
|
87
|
247 To change a specific item of a list use |:let| this way: >
|
|
85
|
248 :let list[4] = "four"
|
|
|
249 :let listlist[0][3] = item
|
|
|
250
|
|
87
|
251 To change part of a list you can specify the first and last item to be
|
|
90
|
252 modified. The value must match the range of replaced items: >
|
|
87
|
253 :let list[3:5] = [3, 4, 5]
|
|
|
254
|
|
85
|
255 Adding and removing items from a list is done with functions. Here are a few
|
|
|
256 examples: >
|
|
|
257 :call insert(list, 'a') " prepend item 'a'
|
|
|
258 :call insert(list, 'a', 3) " insert item 'a' before list[3]
|
|
|
259 :call add(list, "new") " append String item
|
|
|
260 :call add(list, [1, 2]) " append List as one new item
|
|
|
261 :call extend(list, [1, 2]) " extend the list with two more items
|
|
|
262 :let i = remove(list, 3) " remove item 3
|
|
|
263 :let l = remove(list, 3, -1) " remove items 3 to last item
|
|
99
|
264 :call filter(list, '& =~ "x"') " remove items with an 'x'
|
|
85
|
265
|
|
87
|
266 Changing the oder of items in a list: >
|
|
|
267 :call sort(list) " sort a list alphabetically
|
|
|
268 :call reverse(list) " reverse the order of items
|
|
|
269
|
|
85
|
270
|
|
|
271 For loop ~
|
|
|
272
|
|
87
|
273 The |:for| loop executes commands for each item in a list. A variable is set
|
|
|
274 to each item in the list in sequence. Example: >
|
|
85
|
275 :for i in mylist
|
|
|
276 : call Doit(i)
|
|
|
277 :endfor
|
|
|
278
|
|
|
279 This works like: >
|
|
|
280 :let index = 0
|
|
|
281 :while index < len(mylist)
|
|
|
282 : let i = mylist[index]
|
|
|
283 : :call Doit(i)
|
|
|
284 : let index = index + 1
|
|
|
285 :endwhile
|
|
|
286
|
|
|
287 Note that all items in the list should be of the same type, otherwise this
|
|
87
|
288 results in an error |E706|. To avoid this |:unlet| the variable at the end of
|
|
|
289 the loop.
|
|
85
|
290
|
|
95
|
291 If all you want to do is modify each item in the list then the |map()|
|
|
|
292 function might be a simpler method than a for loop.
|
|
|
293
|
|
85
|
294 Just like the |:let| command, |:for| also accepts a list of variables. This
|
|
|
295 requires the argument to be a list of lists. >
|
|
|
296 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
|
|
|
297 : call Doit(lnum, col)
|
|
|
298 :endfor
|
|
|
299
|
|
|
300 This works like a |:let| command is done for each list item. Again, the types
|
|
|
301 must remain the same to avoid an error.
|
|
|
302
|
|
|
303 It is also possible to put remaining items in a list: >
|
|
|
304 :for [i, j; rest] in listlist
|
|
|
305 : call Doit(i, j)
|
|
|
306 : if !empty(rest)
|
|
|
307 : echo "remainder: " . string(rest)
|
|
|
308 : endif
|
|
|
309 :endfor
|
|
|
310
|
|
|
311
|
|
|
312 List functions ~
|
|
|
313
|
|
|
314 Functions that are useful with a List: >
|
|
87
|
315 :let r = call(funcname, list) " call a function with an argument list
|
|
85
|
316 :if empty(list) " check if list is empty
|
|
|
317 :let l = len(list) " number of items in a list
|
|
87
|
318 :let big = max(list) " maximum value in a list
|
|
99
|
319 :let small = min(list) " minimum value in a list
|
|
87
|
320 :let xs = count(list, 'x') " count nr of times 'x' appears in list
|
|
|
321 :let i = index(list, 'x') " index of first 'x' in list
|
|
85
|
322 :let lines = getline(1, 10) " get ten text lines from buffer
|
|
|
323 :call append('$', lines) " append text lines in buffer
|
|
95
|
324 :let list = split("a b c") " create list from items in a string
|
|
|
325 :let string = join(list, ', ') " create string from list items
|
|
85
|
326 :let s = string() " String representation of a list
|
|
99
|
327 :call map(list, '">> " . &') " prepend ">> " to each item
|
|
|
328
|
|
|
329
|
|
|
330 1.4 Dictionaries ~
|
|
|
331 *Dictionaries*
|
|
|
332 A Dictionary is an associative array: Each entry has a key and a value. The
|
|
|
333 entry can be located with the key. The entries are stored without ordering.
|
|
|
334
|
|
|
335
|
|
|
336 Dictionary creation ~
|
|
|
337
|
|
|
338 A Dictionary is created with a comma separated list of entries in curly
|
|
|
339 braces. Each entry has a key and a value, separated by a colon. Examples: >
|
|
|
340 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
|
|
|
341 :let emptydict = {}
|
|
|
342
|
|
|
343 A key is always a String. You can use a Number, it will be converted to a
|
|
|
344 String automatically. Thus the String '4' and the number 4 will find the same
|
|
|
345 entry. Note that the String '04' and the Number 04 are different, since 04
|
|
|
346 will be converted to the String '4'.
|
|
|
347
|
|
|
348 A value can be any expression. Using a Dictionary for an entry creates a
|
|
|
349 nested Dictionary: >
|
|
|
350 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
|
|
|
351
|
|
|
352 An extra comma after the last entry is ignored.
|
|
|
353
|
|
|
354
|
|
|
355 Accessing entries ~
|
|
|
356
|
|
|
357 The normal way to access an entry is by putting the key in square brackets: >
|
|
|
358 :let val = mydict["one"]
|
|
|
359 :let mydict["four"] = 4
|
|
|
360
|
|
|
361 You can add new entries to an existing Dictionary this way.
|
|
|
362
|
|
|
363 For keys that consist entirely of letters, digits and underscore the following
|
|
|
364 form can be used |expr-entry|: >
|
|
|
365 :let val = mydict.one
|
|
|
366 :let mydict.four = 4
|
|
|
367
|
|
|
368 Since an entry can be any type, also a List and a Dictionary, the indexing and
|
|
|
369 key lookup can be repeated: >
|
|
|
370 :let dict.key[idx].key = 0
|
|
|
371
|
|
|
372
|
|
|
373 Dictionary to List conversion ~
|
|
|
374
|
|
|
375 You may want to loop over the entries in a dictionary. For this you need to
|
|
|
376 turn the Dictionary into a List and pass it to |:for|.
|
|
|
377
|
|
|
378 Most often you want to loop over the keys, using the |keys()| function: >
|
|
|
379 :for key in keys(mydict)
|
|
|
380 : echo key . ': ' . mydict[key]
|
|
|
381 :endfor
|
|
|
382
|
|
|
383 The List of keys is unsorted. You may want to sort them first: >
|
|
|
384 :for key in sort(keys(mydict))
|
|
|
385
|
|
|
386 To loop over the values use the |values()| function: >
|
|
|
387 :for v in values(mydict)
|
|
|
388 : echo "value: " . v
|
|
|
389 :endfor
|
|
|
390
|
|
|
391 If you want both the key and the value use the |items()| function. It returns
|
|
|
392 a List of Lists with two items: the key and the value: >
|
|
|
393 :for entry in items(mydict)
|
|
|
394 : echo entry[0] . ': ' . entry[1]
|
|
|
395 :endfor
|
|
|
396
|
|
|
397
|
|
|
398 Dictionary identity ~
|
|
|
399
|
|
|
400 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
|
|
|
401 Dictionary. Otherwise, assignment results in referring to the same
|
|
|
402 Dictionary: >
|
|
|
403 :let onedict = {'a': 1, 'b': 2}
|
|
|
404 :let adict = onedict
|
|
|
405 :let adict['a'] = 11
|
|
|
406 :echo onedict['a']
|
|
|
407 11
|
|
|
408
|
|
|
409 For more info see |list-identity|.
|
|
|
410
|
|
|
411
|
|
|
412 Dictionary modification ~
|
|
|
413 *dict-modification*
|
|
|
414 To change an already existing entry of a Dictionary, or to add a new entry,
|
|
|
415 use |:let| this way: >
|
|
|
416 :let dict[4] = "four"
|
|
|
417 :let dict['one'] = item
|
|
|
418
|
|
|
419 Removing an entry from a Dictionary is done with |remove()|: >
|
|
|
420 :let i = remove(dict, 'aaa') " remove item with key 'aaa'
|
|
|
421
|
|
|
422 Merging a Dictionary with another is done with |extend()|: >
|
|
|
423 :call extend(adict, bdict) " extend adict with entries from bdict
|
|
|
424
|
|
|
425 Weeding out entries from a Dictionary can be done with |filter()|: >
|
|
|
426 :call filter(dict '& =~ "x"') " remove entries with value 'x'
|
|
|
427
|
|
|
428
|
|
|
429 1.5 More about variables ~
|
|
85
|
430 *more-variables*
|
|
7
|
431 If you need to know the type of a variable or expression, use the |type()|
|
|
|
432 function.
|
|
|
433
|
|
|
434 When the '!' flag is included in the 'viminfo' option, global variables that
|
|
|
435 start with an uppercase letter, and don't contain a lowercase letter, are
|
|
|
436 stored in the viminfo file |viminfo-file|.
|
|
|
437
|
|
|
438 When the 'sessionoptions' option contains "global", global variables that
|
|
|
439 start with an uppercase letter and contain at least one lowercase letter are
|
|
|
440 stored in the session file |session-file|.
|
|
|
441
|
|
|
442 variable name can be stored where ~
|
|
|
443 my_var_6 not
|
|
|
444 My_Var_6 session file
|
|
|
445 MY_VAR_6 viminfo file
|
|
|
446
|
|
|
447
|
|
|
448 It's possible to form a variable name with curly braces, see
|
|
|
449 |curly-braces-names|.
|
|
|
450
|
|
|
451 ==============================================================================
|
|
|
452 2. Expression syntax *expression-syntax*
|
|
|
453
|
|
|
454 Expression syntax summary, from least to most significant:
|
|
|
455
|
|
|
456 |expr1| expr2 ? expr1 : expr1 if-then-else
|
|
|
457
|
|
|
458 |expr2| expr3 || expr3 .. logical OR
|
|
|
459
|
|
|
460 |expr3| expr4 && expr4 .. logical AND
|
|
|
461
|
|
|
462 |expr4| expr5 == expr5 equal
|
|
|
463 expr5 != expr5 not equal
|
|
|
464 expr5 > expr5 greater than
|
|
|
465 expr5 >= expr5 greater than or equal
|
|
|
466 expr5 < expr5 smaller than
|
|
|
467 expr5 <= expr5 smaller than or equal
|
|
|
468 expr5 =~ expr5 regexp matches
|
|
|
469 expr5 !~ expr5 regexp doesn't match
|
|
|
470
|
|
|
471 expr5 ==? expr5 equal, ignoring case
|
|
|
472 expr5 ==# expr5 equal, match case
|
|
|
473 etc. As above, append ? for ignoring case, # for
|
|
|
474 matching case
|
|
|
475
|
|
79
|
476 expr5 is expr5 same List instance
|
|
|
477 expr5 isnot expr5 different List instance
|
|
|
478
|
|
|
479 |expr5| expr6 + expr6 .. number addition or list concatenation
|
|
7
|
480 expr6 - expr6 .. number subtraction
|
|
|
481 expr6 . expr6 .. string concatenation
|
|
|
482
|
|
|
483 |expr6| expr7 * expr7 .. number multiplication
|
|
|
484 expr7 / expr7 .. number division
|
|
|
485 expr7 % expr7 .. number modulo
|
|
|
486
|
|
|
487 |expr7| ! expr7 logical NOT
|
|
|
488 - expr7 unary minus
|
|
|
489 + expr7 unary plus
|
|
|
490 expr8
|
|
|
491
|
|
55
|
492 |expr8| expr9[expr1] byte of a String or item of a List
|
|
|
493 expr9[expr1 : expr2] substring of a String or sublist of a List
|
|
99
|
494 expr9.name entry in a Dictionary
|
|
7
|
495
|
|
|
496 |expr9| number number constant
|
|
26
|
497 "string" string constant, backslash is special
|
|
99
|
498 'string' string constant, ' is doubled
|
|
55
|
499 [expr1, ...] List
|
|
7
|
500 &option option value
|
|
|
501 (expr1) nested expression
|
|
|
502 variable internal variable
|
|
|
503 va{ria}ble internal variable with curly braces
|
|
|
504 $VAR environment variable
|
|
|
505 @r contents of register 'r'
|
|
|
506 function(expr1, ...) function call
|
|
55
|
507 Funcref(expr1, ...) function call with Funcref variable
|
|
7
|
508 func{ti}on(expr1, ...) function call with curly braces
|
|
|
509
|
|
|
510
|
|
|
511 ".." indicates that the operations in this level can be concatenated.
|
|
|
512 Example: >
|
|
|
513 &nu || &list && &shell == "csh"
|
|
|
514
|
|
|
515 All expressions within one level are parsed from left to right.
|
|
|
516
|
|
|
517
|
|
|
518 expr1 *expr1* *E109*
|
|
|
519 -----
|
|
|
520
|
|
|
521 expr2 ? expr1 : expr1
|
|
|
522
|
|
|
523 The expression before the '?' is evaluated to a number. If it evaluates to
|
|
|
524 non-zero, the result is the value of the expression between the '?' and ':',
|
|
|
525 otherwise the result is the value of the expression after the ':'.
|
|
|
526 Example: >
|
|
|
527 :echo lnum == 1 ? "top" : lnum
|
|
|
528
|
|
|
529 Since the first expression is an "expr2", it cannot contain another ?:. The
|
|
|
530 other two expressions can, thus allow for recursive use of ?:.
|
|
|
531 Example: >
|
|
|
532 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
|
|
|
533
|
|
|
534 To keep this readable, using |line-continuation| is suggested: >
|
|
|
535 :echo lnum == 1
|
|
|
536 :\ ? "top"
|
|
|
537 :\ : lnum == 1000
|
|
|
538 :\ ? "last"
|
|
|
539 :\ : lnum
|
|
|
540
|
|
|
541
|
|
|
542 expr2 and expr3 *expr2* *expr3*
|
|
|
543 ---------------
|
|
|
544
|
|
|
545 *expr-barbar* *expr-&&*
|
|
|
546 The "||" and "&&" operators take one argument on each side. The arguments
|
|
|
547 are (converted to) Numbers. The result is:
|
|
|
548
|
|
|
549 input output ~
|
|
|
550 n1 n2 n1 || n2 n1 && n2 ~
|
|
|
551 zero zero zero zero
|
|
|
552 zero non-zero non-zero zero
|
|
|
553 non-zero zero non-zero zero
|
|
|
554 non-zero non-zero non-zero non-zero
|
|
|
555
|
|
|
556 The operators can be concatenated, for example: >
|
|
|
557
|
|
|
558 &nu || &list && &shell == "csh"
|
|
|
559
|
|
|
560 Note that "&&" takes precedence over "||", so this has the meaning of: >
|
|
|
561
|
|
|
562 &nu || (&list && &shell == "csh")
|
|
|
563
|
|
|
564 Once the result is known, the expression "short-circuits", that is, further
|
|
|
565 arguments are not evaluated. This is like what happens in C. For example: >
|
|
|
566
|
|
|
567 let a = 1
|
|
|
568 echo a || b
|
|
|
569
|
|
|
570 This is valid even if there is no variable called "b" because "a" is non-zero,
|
|
|
571 so the result must be non-zero. Similarly below: >
|
|
|
572
|
|
|
573 echo exists("b") && b == "yes"
|
|
|
574
|
|
|
575 This is valid whether "b" has been defined or not. The second clause will
|
|
|
576 only be evaluated if "b" has been defined.
|
|
|
577
|
|
|
578
|
|
|
579 expr4 *expr4*
|
|
|
580 -----
|
|
|
581
|
|
|
582 expr5 {cmp} expr5
|
|
|
583
|
|
|
584 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
|
|
|
585 if it evaluates to true.
|
|
|
586
|
|
|
587 *expr-==* *expr-!=* *expr->* *expr->=*
|
|
|
588 *expr-<* *expr-<=* *expr-=~* *expr-!~*
|
|
|
589 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
|
|
|
590 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
|
|
|
591 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
|
|
|
592 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
|
|
79
|
593 *expr-is*
|
|
7
|
594 use 'ignorecase' match case ignore case ~
|
|
|
595 equal == ==# ==?
|
|
|
596 not equal != !=# !=?
|
|
|
597 greater than > ># >?
|
|
|
598 greater than or equal >= >=# >=?
|
|
|
599 smaller than < <# <?
|
|
|
600 smaller than or equal <= <=# <=?
|
|
|
601 regexp matches =~ =~# =~?
|
|
|
602 regexp doesn't match !~ !~# !~?
|
|
79
|
603 same instance is
|
|
|
604 different instance isnot
|
|
7
|
605
|
|
|
606 Examples:
|
|
|
607 "abc" ==# "Abc" evaluates to 0
|
|
|
608 "abc" ==? "Abc" evaluates to 1
|
|
|
609 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
|
|
|
610
|
|
85
|
611 *E691* *E692*
|
|
79
|
612 A List can only be compared with a List and only "equal", "not equal" and "is"
|
|
|
613 can be used. This compares the values of the list, recursively. Ignoring
|
|
|
614 case means case is ignored when comparing item values.
|
|
|
615
|
|
85
|
616 *E693* *E694*
|
|
79
|
617 A Funcref can only be compared with a Funcref and only "equal" and "not equal"
|
|
|
618 can be used. Case is never ignored.
|
|
|
619
|
|
|
620 When using "is" or "isnot" with a List this checks if the expressions are
|
|
|
621 referring to the same List instance. A copy of a List is different from the
|
|
|
622 original List. When using "is" without a List it is equivalent to using
|
|
|
623 "equal", using "isnot" equivalent to using "not equal". Except that a
|
|
|
624 different type means the values are different. "4 == '4'" is true, "4 is '4'"
|
|
|
625 is false.
|
|
|
626
|
|
7
|
627 When comparing a String with a Number, the String is converted to a Number,
|
|
|
628 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
|
|
|
629 because 'x' converted to a Number is zero.
|
|
|
630
|
|
|
631 When comparing two Strings, this is done with strcmp() or stricmp(). This
|
|
|
632 results in the mathematical difference (comparing byte values), not
|
|
|
633 necessarily the alphabetical difference in the local language.
|
|
|
634
|
|
|
635 When using the operators with a trailing '#", or the short version and
|
|
|
636 'ignorecase' is off, the comparing is done with strcmp().
|
|
|
637
|
|
|
638 When using the operators with a trailing '?', or the short version and
|
|
|
639 'ignorecase' is set, the comparing is done with stricmp().
|
|
|
640
|
|
|
641 The "=~" and "!~" operators match the lefthand argument with the righthand
|
|
|
642 argument, which is used as a pattern. See |pattern| for what a pattern is.
|
|
|
643 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
|
|
|
644 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
|
|
|
645 portable. To avoid backslashes in the regexp pattern to be doubled, use a
|
|
|
646 single-quote string, see |literal-string|.
|
|
|
647 Since a string is considered to be a single line, a multi-line pattern
|
|
|
648 (containing \n, backslash-n) will not match. However, a literal NL character
|
|
|
649 can be matched like an ordinary character. Examples:
|
|
|
650 "foo\nbar" =~ "\n" evaluates to 1
|
|
|
651 "foo\nbar" =~ "\\n" evaluates to 0
|
|
|
652
|
|
|
653
|
|
|
654 expr5 and expr6 *expr5* *expr6*
|
|
|
655 ---------------
|
|
79
|
656 expr6 + expr6 .. Number addition or List concatenation *expr-+*
|
|
|
657 expr6 - expr6 .. Number subtraction *expr--*
|
|
|
658 expr6 . expr6 .. String concatenation *expr-.*
|
|
|
659
|
|
|
660 For Lists only "+" is possible and then both expr6 must be a list. The result
|
|
|
661 is a new list with the two lists Concatenated.
|
|
|
662
|
|
|
663 expr7 * expr7 .. number multiplication *expr-star*
|
|
|
664 expr7 / expr7 .. number division *expr-/*
|
|
|
665 expr7 % expr7 .. number modulo *expr-%*
|
|
7
|
666
|
|
|
667 For all, except ".", Strings are converted to Numbers.
|
|
|
668
|
|
|
669 Note the difference between "+" and ".":
|
|
|
670 "123" + "456" = 579
|
|
|
671 "123" . "456" = "123456"
|
|
|
672
|
|
|
673 When the righthand side of '/' is zero, the result is 0x7fffffff.
|
|
|
674 When the righthand side of '%' is zero, the result is 0.
|
|
|
675
|
|
79
|
676 None of these work for Funcrefs.
|
|
|
677
|
|
7
|
678
|
|
|
679 expr7 *expr7*
|
|
|
680 -----
|
|
|
681 ! expr7 logical NOT *expr-!*
|
|
|
682 - expr7 unary minus *expr-unary--*
|
|
|
683 + expr7 unary plus *expr-unary-+*
|
|
|
684
|
|
|
685 For '!' non-zero becomes zero, zero becomes one.
|
|
|
686 For '-' the sign of the number is changed.
|
|
|
687 For '+' the number is unchanged.
|
|
|
688
|
|
|
689 A String will be converted to a Number first.
|
|
|
690
|
|
|
691 These three can be repeated and mixed. Examples:
|
|
|
692 !-1 == 0
|
|
|
693 !!8 == 1
|
|
|
694 --9 == 9
|
|
|
695
|
|
|
696
|
|
|
697 expr8 *expr8*
|
|
|
698 -----
|
|
55
|
699 expr9[expr1] item of String or List *expr-[]* *E111*
|
|
|
700
|
|
|
701 If expr9 is a Number or String this results in a String that contains the
|
|
|
702 expr1'th single byte from expr9. expr9 is used as a String, expr1 as a
|
|
|
703 Number. Note that this doesn't recognize multi-byte encodings.
|
|
|
704
|
|
|
705 Index zero gives the first character. This is like it works in C. Careful:
|
|
|
706 text column numbers start with one! Example, to get the character under the
|
|
|
707 cursor: >
|
|
7
|
708 :let c = getline(line("."))[col(".") - 1]
|
|
|
709
|
|
|
710 If the length of the String is less than the index, the result is an empty
|
|
55
|
711 String. A negative index always results in an empty string (reason: backwards
|
|
|
712 compatibility). Use [-1:] to get the last byte.
|
|
|
713
|
|
|
714 If expr9 is a List then it results the item at index expr1. See |list-index|
|
|
|
715 for possible index values. If the index is out of range this results in an
|
|
|
716 error. Example: >
|
|
|
717 :let item = mylist[-1] " get last item
|
|
|
718
|
|
|
719 Generally, if a List index is equal to or higher than the length of the List,
|
|
|
720 or more negative than the length of the List, this results in an error.
|
|
|
721
|
|
99
|
722
|
|
55
|
723 expr9[expr1a : expr1b] substring or sublist *expr-[:]*
|
|
|
724
|
|
|
725 If expr9 is a Number or String this results in the substring with the bytes
|
|
|
726 from expr1a to and including expr1b. expr9 is used as a String, expr1a and
|
|
|
727 expr1b are used as a Number. Note that this doesn't recognize multi-byte
|
|
|
728 encodings.
|
|
|
729
|
|
|
730 If expr1a is omitted zero is used. If expr1b is omitted the length of the
|
|
|
731 string minus one is used.
|
|
|
732
|
|
|
733 A negative number can be used to measure from the end of the string. -1 is
|
|
|
734 the last character, -2 the last but one, etc.
|
|
|
735
|
|
|
736 If an index goes out of range for the string characters are omitted. If
|
|
|
737 expr1b is smaller than expr1a the result is an empty string.
|
|
|
738
|
|
|
739 Examples: >
|
|
|
740 :let c = name[-1:] " last byte of a string
|
|
|
741 :let c = name[-2:-2] " last but one byte of a string
|
|
|
742 :let s = line(".")[4:] " from the fifth byte to the end
|
|
|
743 :let s = s[:-3] " remove last two bytes
|
|
|
744
|
|
|
745 If expr9 is a List this results in a new List with the items indicated by the
|
|
|
746 indexes expr1a and expr1b. This works like with a String, as explained just
|
|
|
747 above, except that indexes out of range cause an error. Examples: >
|
|
|
748 :let l = mylist[:3] " first four items
|
|
|
749 :let l = mylist[4:4] " List with one item
|
|
|
750 :let l = mylist[:] " shallow copy of a List
|
|
|
751
|
|
|
752 Using expr9[expr1] or expr9[expr1a : expr1b] on a Funcref results in an error.
|
|
7
|
753
|
|
99
|
754
|
|
|
755 expr9.name entry in a Dictionary *expr-entry*
|
|
|
756
|
|
|
757 If expr9 is a Dictionary and it is followed by a dot, then the following name
|
|
|
758 will be used as a key in the Dictionary. This is just like: expr9[name].
|
|
|
759
|
|
|
760 The name must consist of alphanumeric characters, just like a variable name,
|
|
|
761 but it may start with a number. Curly braces cannot be used.
|
|
|
762
|
|
|
763 There must not be white space before or after the dot.
|
|
|
764
|
|
|
765 Examples: >
|
|
|
766 :let dict = {"one": 1, 2: "two"}
|
|
|
767 :echo dict.one
|
|
|
768 :echo dict .2
|
|
|
769
|
|
|
770 Note that the dot is also used for String concatenation. To avoid confusion
|
|
|
771 always put spaces around the dot for String concatenation.
|
|
|
772
|
|
|
773
|
|
7
|
774 *expr9*
|
|
|
775 number
|
|
|
776 ------
|
|
|
777 number number constant *expr-number*
|
|
|
778
|
|
|
779 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
|
|
|
780
|
|
|
781
|
|
|
782 string *expr-string* *E114*
|
|
|
783 ------
|
|
|
784 "string" string constant *expr-quote*
|
|
|
785
|
|
|
786 Note that double quotes are used.
|
|
|
787
|
|
|
788 A string constant accepts these special characters:
|
|
|
789 \... three-digit octal number (e.g., "\316")
|
|
|
790 \.. two-digit octal number (must be followed by non-digit)
|
|
|
791 \. one-digit octal number (must be followed by non-digit)
|
|
|
792 \x.. byte specified with two hex numbers (e.g., "\x1f")
|
|
|
793 \x. byte specified with one hex number (must be followed by non-hex char)
|
|
|
794 \X.. same as \x..
|
|
|
795 \X. same as \x.
|
|
|
796 \u.... character specified with up to 4 hex numbers, stored according to the
|
|
|
797 current value of 'encoding' (e.g., "\u02a4")
|
|
|
798 \U.... same as \u....
|
|
|
799 \b backspace <BS>
|
|
|
800 \e escape <Esc>
|
|
|
801 \f formfeed <FF>
|
|
|
802 \n newline <NL>
|
|
|
803 \r return <CR>
|
|
|
804 \t tab <Tab>
|
|
|
805 \\ backslash
|
|
|
806 \" double quote
|
|
|
807 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W.
|
|
|
808
|
|
|
809 Note that "\000" and "\x00" force the end of the string.
|
|
|
810
|
|
|
811
|
|
|
812 literal-string *literal-string* *E115*
|
|
|
813 ---------------
|
|
26
|
814 'string' string constant *expr-'*
|
|
7
|
815
|
|
|
816 Note that single quotes are used.
|
|
|
817
|
|
26
|
818 This string is taken as it is. No backslashes are removed or have a special
|
|
99
|
819 meaning. The only exception is that two quotes stand for one quote.
|
|
26
|
820
|
|
|
821 Single quoted strings are useful for patterns, so that backslashes do not need
|
|
|
822 to be doubled. These two commands are equivalent: >
|
|
|
823 if a =~ "\\s*"
|
|
|
824 if a =~ '\s*'
|
|
7
|
825
|
|
|
826
|
|
|
827 option *expr-option* *E112* *E113*
|
|
|
828 ------
|
|
|
829 &option option value, local value if possible
|
|
|
830 &g:option global option value
|
|
|
831 &l:option local option value
|
|
|
832
|
|
|
833 Examples: >
|
|
|
834 echo "tabstop is " . &tabstop
|
|
|
835 if &insertmode
|
|
|
836
|
|
|
837 Any option name can be used here. See |options|. When using the local value
|
|
|
838 and there is no buffer-local or window-local value, the global value is used
|
|
|
839 anyway.
|
|
|
840
|
|
|
841
|
|
|
842 register *expr-register*
|
|
|
843 --------
|
|
|
844 @r contents of register 'r'
|
|
|
845
|
|
|
846 The result is the contents of the named register, as a single string.
|
|
|
847 Newlines are inserted where required. To get the contents of the unnamed
|
|
|
848 register use @" or @@. The '=' register can not be used here. See
|
|
|
849 |registers| for an explanation of the available registers.
|
|
|
850
|
|
|
851
|
|
|
852 nesting *expr-nesting* *E110*
|
|
|
853 -------
|
|
|
854 (expr1) nested expression
|
|
|
855
|
|
|
856
|
|
|
857 environment variable *expr-env*
|
|
|
858 --------------------
|
|
|
859 $VAR environment variable
|
|
|
860
|
|
|
861 The String value of any environment variable. When it is not defined, the
|
|
|
862 result is an empty string.
|
|
|
863 *expr-env-expand*
|
|
|
864 Note that there is a difference between using $VAR directly and using
|
|
|
865 expand("$VAR"). Using it directly will only expand environment variables that
|
|
|
866 are known inside the current Vim session. Using expand() will first try using
|
|
|
867 the environment variables known inside the current Vim session. If that
|
|
|
868 fails, a shell will be used to expand the variable. This can be slow, but it
|
|
|
869 does expand all variables that the shell knows about. Example: >
|
|
|
870 :echo $version
|
|
|
871 :echo expand("$version")
|
|
|
872 The first one probably doesn't echo anything, the second echoes the $version
|
|
|
873 variable (if your shell supports it).
|
|
|
874
|
|
|
875
|
|
|
876 internal variable *expr-variable*
|
|
|
877 -----------------
|
|
|
878 variable internal variable
|
|
|
879 See below |internal-variables|.
|
|
|
880
|
|
|
881
|
|
|
882 function call *expr-function* *E116* *E117* *E118* *E119* *E120*
|
|
|
883 -------------
|
|
|
884 function(expr1, ...) function call
|
|
|
885 See below |functions|.
|
|
|
886
|
|
|
887
|
|
|
888 ==============================================================================
|
|
|
889 3. Internal variable *internal-variables* *E121*
|
|
|
890 *E461*
|
|
|
891 An internal variable name can be made up of letters, digits and '_'. But it
|
|
|
892 cannot start with a digit. It's also possible to use curly braces, see
|
|
|
893 |curly-braces-names|.
|
|
|
894
|
|
|
895 An internal variable is created with the ":let" command |:let|.
|
|
87
|
896 An internal variable is explicitly destroyed with the ":unlet" command
|
|
|
897 |:unlet|.
|
|
|
898 Using a name that is not an internal variable or refers to a variable that has
|
|
|
899 been destroyed results in an error.
|
|
7
|
900
|
|
|
901 There are several name spaces for variables. Which one is to be used is
|
|
|
902 specified by what is prepended:
|
|
|
903
|
|
|
904 (nothing) In a function: local to a function; otherwise: global
|
|
|
905 |buffer-variable| b: Local to the current buffer.
|
|
|
906 |window-variable| w: Local to the current window.
|
|
|
907 |global-variable| g: Global.
|
|
|
908 |local-variable| l: Local to a function.
|
|
|
909 |script-variable| s: Local to a |:source|'ed Vim script.
|
|
|
910 |function-argument| a: Function argument (only inside a function).
|
|
|
911 |vim-variable| v: Global, predefined by Vim.
|
|
|
912
|
|
|
913 *buffer-variable* *b:var*
|
|
|
914 A variable name that is preceded with "b:" is local to the current buffer.
|
|
|
915 Thus you can have several "b:foo" variables, one for each buffer.
|
|
|
916 This kind of variable is deleted when the buffer is wiped out or deleted with
|
|
|
917 |:bdelete|.
|
|
|
918
|
|
|
919 One local buffer variable is predefined:
|
|
|
920 *b:changedtick-variable* *changetick*
|
|
|
921 b:changedtick The total number of changes to the current buffer. It is
|
|
|
922 incremented for each change. An undo command is also a change
|
|
|
923 in this case. This can be used to perform an action only when
|
|
|
924 the buffer has changed. Example: >
|
|
|
925 :if my_changedtick != b:changedtick
|
|
|
926 : let my_changedtick = b:changedtick
|
|
|
927 : call My_Update()
|
|
|
928 :endif
|
|
|
929 <
|
|
|
930 *window-variable* *w:var*
|
|
|
931 A variable name that is preceded with "w:" is local to the current window. It
|
|
|
932 is deleted when the window is closed.
|
|
|
933
|
|
|
934 *global-variable* *g:var*
|
|
|
935 Inside functions global variables are accessed with "g:". Omitting this will
|
|
|
936 access a variable local to a function. But "g:" can also be used in any other
|
|
|
937 place if you like.
|
|
|
938
|
|
|
939 *local-variable* *l:var*
|
|
|
940 Inside functions local variables are accessed without prepending anything.
|
|
|
941 But you can also prepend "l:" if you like.
|
|
|
942
|
|
|
943 *script-variable* *s:var*
|
|
|
944 In a Vim script variables starting with "s:" can be used. They cannot be
|
|
|
945 accessed from outside of the scripts, thus are local to the script.
|
|
|
946
|
|
|
947 They can be used in:
|
|
|
948 - commands executed while the script is sourced
|
|
|
949 - functions defined in the script
|
|
|
950 - autocommands defined in the script
|
|
|
951 - functions and autocommands defined in functions and autocommands which were
|
|
|
952 defined in the script (recursively)
|
|
|
953 - user defined commands defined in the script
|
|
|
954 Thus not in:
|
|
|
955 - other scripts sourced from this one
|
|
|
956 - mappings
|
|
|
957 - etc.
|
|
|
958
|
|
|
959 script variables can be used to avoid conflicts with global variable names.
|
|
|
960 Take this example:
|
|
|
961
|
|
|
962 let s:counter = 0
|
|
|
963 function MyCounter()
|
|
|
964 let s:counter = s:counter + 1
|
|
|
965 echo s:counter
|
|
|
966 endfunction
|
|
|
967 command Tick call MyCounter()
|
|
|
968
|
|
|
969 You can now invoke "Tick" from any script, and the "s:counter" variable in
|
|
|
970 that script will not be changed, only the "s:counter" in the script where
|
|
|
971 "Tick" was defined is used.
|
|
|
972
|
|
|
973 Another example that does the same: >
|
|
|
974
|
|
|
975 let s:counter = 0
|
|
|
976 command Tick let s:counter = s:counter + 1 | echo s:counter
|
|
|
977
|
|
|
978 When calling a function and invoking a user-defined command, the context for
|
|
9
|
979 script variables is set to the script where the function or command was
|
|
7
|
980 defined.
|
|
|
981
|
|
|
982 The script variables are also available when a function is defined inside a
|
|
|
983 function that is defined in a script. Example: >
|
|
|
984
|
|
|
985 let s:counter = 0
|
|
|
986 function StartCounting(incr)
|
|
|
987 if a:incr
|
|
|
988 function MyCounter()
|
|
|
989 let s:counter = s:counter + 1
|
|
|
990 endfunction
|
|
|
991 else
|
|
|
992 function MyCounter()
|
|
|
993 let s:counter = s:counter - 1
|
|
|
994 endfunction
|
|
|
995 endif
|
|
|
996 endfunction
|
|
|
997
|
|
|
998 This defines the MyCounter() function either for counting up or counting down
|
|
|
999 when calling StartCounting(). It doesn't matter from where StartCounting() is
|
|
|
1000 called, the s:counter variable will be accessible in MyCounter().
|
|
|
1001
|
|
|
1002 When the same script is sourced again it will use the same script variables.
|
|
|
1003 They will remain valid as long as Vim is running. This can be used to
|
|
|
1004 maintain a counter: >
|
|
|
1005
|
|
|
1006 if !exists("s:counter")
|
|
|
1007 let s:counter = 1
|
|
|
1008 echo "script executed for the first time"
|
|
|
1009 else
|
|
|
1010 let s:counter = s:counter + 1
|
|
|
1011 echo "script executed " . s:counter . " times now"
|
|
|
1012 endif
|
|
|
1013
|
|
|
1014 Note that this means that filetype plugins don't get a different set of script
|
|
|
1015 variables for each buffer. Use local buffer variables instead |b:var|.
|
|
|
1016
|
|
|
1017
|
|
|
1018 Predefined Vim variables: *vim-variable* *v:var*
|
|
|
1019
|
|
|
1020 *v:charconvert_from* *charconvert_from-variable*
|
|
|
1021 v:charconvert_from
|
|
|
1022 The name of the character encoding of a file to be converted.
|
|
|
1023 Only valid while evaluating the 'charconvert' option.
|
|
|
1024
|
|
|
1025 *v:charconvert_to* *charconvert_to-variable*
|
|
|
1026 v:charconvert_to
|
|
|
1027 The name of the character encoding of a file after conversion.
|
|
|
1028 Only valid while evaluating the 'charconvert' option.
|
|
|
1029
|
|
|
1030 *v:cmdarg* *cmdarg-variable*
|
|
|
1031 v:cmdarg This variable is used for two purposes:
|
|
|
1032 1. The extra arguments given to a file read/write command.
|
|
|
1033 Currently these are "++enc=" and "++ff=". This variable is
|
|
|
1034 set before an autocommand event for a file read/write
|
|
|
1035 command is triggered. There is a leading space to make it
|
|
|
1036 possible to append this variable directly after the
|
|
|
1037 read/write command. Note: The "+cmd" argument isn't
|
|
|
1038 included here, because it will be executed anyway.
|
|
|
1039 2. When printing a PostScript file with ":hardcopy" this is
|
|
|
1040 the argument for the ":hardcopy" command. This can be used
|
|
|
1041 in 'printexpr'.
|
|
|
1042
|
|
|
1043 *v:cmdbang* *cmdbang-variable*
|
|
|
1044 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
|
|
|
1045 was used the value is 1, otherwise it is 0. Note that this
|
|
|
1046 can only be used in autocommands. For user commands |<bang>|
|
|
|
1047 can be used.
|
|
|
1048
|
|
|
1049 *v:count* *count-variable*
|
|
|
1050 v:count The count given for the last Normal mode command. Can be used
|
|
|
1051 to get the count before a mapping. Read-only. Example: >
|
|
|
1052 :map _x :<C-U>echo "the count is " . v:count<CR>
|
|
|
1053 < Note: The <C-U> is required to remove the line range that you
|
|
|
1054 get when typing ':' after a count.
|
|
|
1055 "count" also works, for backwards compatibility.
|
|
|
1056
|
|
|
1057 *v:count1* *count1-variable*
|
|
|
1058 v:count1 Just like "v:count", but defaults to one when no count is
|
|
|
1059 used.
|
|
|
1060
|
|
|
1061 *v:ctype* *ctype-variable*
|
|
|
1062 v:ctype The current locale setting for characters of the runtime
|
|
|
1063 environment. This allows Vim scripts to be aware of the
|
|
|
1064 current locale encoding. Technical: it's the value of
|
|
|
1065 LC_CTYPE. When not using a locale the value is "C".
|
|
|
1066 This variable can not be set directly, use the |:language|
|
|
|
1067 command.
|
|
|
1068 See |multi-lang|.
|
|
|
1069
|
|
|
1070 *v:dying* *dying-variable*
|
|
|
1071 v:dying Normally zero. When a deadly signal is caught it's set to
|
|
|
1072 one. When multiple signals are caught the number increases.
|
|
|
1073 Can be used in an autocommand to check if Vim didn't
|
|
|
1074 terminate normally. {only works on Unix}
|
|
|
1075 Example: >
|
|
|
1076 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
|
|
|
1077 <
|
|
|
1078 *v:errmsg* *errmsg-variable*
|
|
|
1079 v:errmsg Last given error message. It's allowed to set this variable.
|
|
|
1080 Example: >
|
|
|
1081 :let v:errmsg = ""
|
|
|
1082 :silent! next
|
|
|
1083 :if v:errmsg != ""
|
|
|
1084 : ... handle error
|
|
|
1085 < "errmsg" also works, for backwards compatibility.
|
|
|
1086
|
|
|
1087 *v:exception* *exception-variable*
|
|
|
1088 v:exception The value of the exception most recently caught and not
|
|
|
1089 finished. See also |v:throwpoint| and |throw-variables|.
|
|
|
1090 Example: >
|
|
|
1091 :try
|
|
|
1092 : throw "oops"
|
|
|
1093 :catch /.*/
|
|
|
1094 : echo "caught" v:exception
|
|
|
1095 :endtry
|
|
|
1096 < Output: "caught oops".
|
|
|
1097
|
|
|
1098 *v:fname_in* *fname_in-variable*
|
|
|
1099 v:fname_in The name of the input file. Only valid while evaluating:
|
|
|
1100 option used for ~
|
|
|
1101 'charconvert' file to be converted
|
|
|
1102 'diffexpr' original file
|
|
|
1103 'patchexpr' original file
|
|
|
1104 'printexpr' file to be printed
|
|
|
1105
|
|
|
1106 *v:fname_out* *fname_out-variable*
|
|
|
1107 v:fname_out The name of the output file. Only valid while
|
|
|
1108 evaluating:
|
|
|
1109 option used for ~
|
|
|
1110 'charconvert' resulting converted file (*)
|
|
|
1111 'diffexpr' output of diff
|
|
|
1112 'patchexpr' resulting patched file
|
|
|
1113 (*) When doing conversion for a write command (e.g., ":w
|
|
|
1114 file") it will be equal to v:fname_in. When doing conversion
|
|
|
1115 for a read command (e.g., ":e file") it will be a temporary
|
|
|
1116 file and different from v:fname_in.
|
|
|
1117
|
|
|
1118 *v:fname_new* *fname_new-variable*
|
|
|
1119 v:fname_new The name of the new version of the file. Only valid while
|
|
|
1120 evaluating 'diffexpr'.
|
|
|
1121
|
|
|
1122 *v:fname_diff* *fname_diff-variable*
|
|
|
1123 v:fname_diff The name of the diff (patch) file. Only valid while
|
|
|
1124 evaluating 'patchexpr'.
|
|
|
1125
|
|
|
1126 *v:folddashes* *folddashes-variable*
|
|
|
1127 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
|
|
|
1128 fold.
|
|
29
|
1129 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1130
|
|
|
1131 *v:foldlevel* *foldlevel-variable*
|
|
|
1132 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
|
|
29
|
1133 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1134
|
|
|
1135 *v:foldend* *foldend-variable*
|
|
|
1136 v:foldend Used for 'foldtext': last line of closed fold.
|
|
29
|
1137 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1138
|
|
|
1139 *v:foldstart* *foldstart-variable*
|
|
|
1140 v:foldstart Used for 'foldtext': first line of closed fold.
|
|
29
|
1141 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1142
|
|
11
|
1143 *v:insertmode* *insertmode-variable*
|
|
|
1144 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
|
|
|
1145 events. Values:
|
|
|
1146 i Insert mode
|
|
|
1147 r Replace mode
|
|
|
1148 v Virtual Replace mode
|
|
|
1149
|
|
7
|
1150 *v:lang* *lang-variable*
|
|
|
1151 v:lang The current locale setting for messages of the runtime
|
|
|
1152 environment. This allows Vim scripts to be aware of the
|
|
|
1153 current language. Technical: it's the value of LC_MESSAGES.
|
|
|
1154 The value is system dependent.
|
|
|
1155 This variable can not be set directly, use the |:language|
|
|
|
1156 command.
|
|
|
1157 It can be different from |v:ctype| when messages are desired
|
|
|
1158 in a different language than what is used for character
|
|
|
1159 encoding. See |multi-lang|.
|
|
|
1160
|
|
|
1161 *v:lc_time* *lc_time-variable*
|
|
|
1162 v:lc_time The current locale setting for time messages of the runtime
|
|
|
1163 environment. This allows Vim scripts to be aware of the
|
|
|
1164 current language. Technical: it's the value of LC_TIME.
|
|
|
1165 This variable can not be set directly, use the |:language|
|
|
|
1166 command. See |multi-lang|.
|
|
|
1167
|
|
|
1168 *v:lnum* *lnum-variable*
|
|
29
|
1169 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr'
|
|
|
1170 expressions. Only valid while one of these expressions is
|
|
|
1171 being evaluated. Read-only when in the |sandbox|.
|
|
7
|
1172
|
|
|
1173 *v:prevcount* *prevcount-variable*
|
|
|
1174 v:prevcount The count given for the last but one Normal mode command.
|
|
|
1175 This is the v:count value of the previous command. Useful if
|
|
|
1176 you want to cancel Visual mode and then use the count. >
|
|
|
1177 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
|
|
|
1178 < Read-only.
|
|
|
1179
|
|
|
1180 *v:progname* *progname-variable*
|
|
|
1181 v:progname Contains the name (with path removed) with which Vim was
|
|
|
1182 invoked. Allows you to do special initialisations for "view",
|
|
|
1183 "evim" etc., or any other name you might symlink to Vim.
|
|
|
1184 Read-only.
|
|
|
1185
|
|
|
1186 *v:register* *register-variable*
|
|
|
1187 v:register The name of the register supplied to the last normal mode
|
|
|
1188 command. Empty if none were supplied. |getreg()| |setreg()|
|
|
|
1189
|
|
|
1190 *v:servername* *servername-variable*
|
|
|
1191 v:servername The resulting registered |x11-clientserver| name if any.
|
|
|
1192 Read-only.
|
|
|
1193
|
|
|
1194 *v:shell_error* *shell_error-variable*
|
|
|
1195 v:shell_error Result of the last shell command. When non-zero, the last
|
|
|
1196 shell command had an error. When zero, there was no problem.
|
|
|
1197 This only works when the shell returns the error code to Vim.
|
|
|
1198 The value -1 is often used when the command could not be
|
|
|
1199 executed. Read-only.
|
|
|
1200 Example: >
|
|
|
1201 :!mv foo bar
|
|
|
1202 :if v:shell_error
|
|
|
1203 : echo 'could not rename "foo" to "bar"!'
|
|
|
1204 :endif
|
|
|
1205 < "shell_error" also works, for backwards compatibility.
|
|
|
1206
|
|
|
1207 *v:statusmsg* *statusmsg-variable*
|
|
|
1208 v:statusmsg Last given status message. It's allowed to set this variable.
|
|
|
1209
|
|
|
1210 *v:termresponse* *termresponse-variable*
|
|
|
1211 v:termresponse The escape sequence returned by the terminal for the |t_RV|
|
|
|
1212 termcap entry. It is set when Vim receives an escape sequence
|
|
|
1213 that starts with ESC [ or CSI and ends in a 'c', with only
|
|
|
1214 digits, ';' and '.' in between.
|
|
|
1215 When this option is set, the TermResponse autocommand event is
|
|
|
1216 fired, so that you can react to the response from the
|
|
|
1217 terminal.
|
|
|
1218 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
|
|
|
1219 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
|
|
|
1220 patch level (since this was introduced in patch 95, it's
|
|
|
1221 always 95 or bigger). Pc is always zero.
|
|
|
1222 {only when compiled with |+termresponse| feature}
|
|
|
1223
|
|
|
1224 *v:this_session* *this_session-variable*
|
|
|
1225 v:this_session Full filename of the last loaded or saved session file. See
|
|
|
1226 |:mksession|. It is allowed to set this variable. When no
|
|
|
1227 session file has been saved, this variable is empty.
|
|
|
1228 "this_session" also works, for backwards compatibility.
|
|
|
1229
|
|
|
1230 *v:throwpoint* *throwpoint-variable*
|
|
|
1231 v:throwpoint The point where the exception most recently caught and not
|
|
|
1232 finished was thrown. Not set when commands are typed. See
|
|
|
1233 also |v:exception| and |throw-variables|.
|
|
|
1234 Example: >
|
|
|
1235 :try
|
|
|
1236 : throw "oops"
|
|
|
1237 :catch /.*/
|
|
|
1238 : echo "Exception from" v:throwpoint
|
|
|
1239 :endtry
|
|
|
1240 < Output: "Exception from test.vim, line 2"
|
|
|
1241
|
|
|
1242 *v:version* *version-variable*
|
|
|
1243 v:version Version number of Vim: Major version number times 100 plus
|
|
|
1244 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
|
|
|
1245 is 501. Read-only. "version" also works, for backwards
|
|
|
1246 compatibility.
|
|
|
1247 Use |has()| to check if a certain patch was included, e.g.: >
|
|
|
1248 if has("patch123")
|
|
|
1249 < Note that patch numbers are specific to the version, thus both
|
|
|
1250 version 5.0 and 5.1 may have a patch 123, but these are
|
|
|
1251 completely different.
|
|
|
1252
|
|
|
1253 *v:warningmsg* *warningmsg-variable*
|
|
|
1254 v:warningmsg Last given warning message. It's allowed to set this variable.
|
|
|
1255
|
|
|
1256 ==============================================================================
|
|
|
1257 4. Builtin Functions *functions*
|
|
|
1258
|
|
|
1259 See |function-list| for a list grouped by what the function is used for.
|
|
|
1260
|
|
|
1261 (Use CTRL-] on the function name to jump to the full explanation)
|
|
|
1262
|
|
|
1263 USAGE RESULT DESCRIPTION ~
|
|
|
1264
|
|
82
|
1265 add( {list}, {item}) List append {item} to List {list}
|
|
55
|
1266 append( {lnum}, {string}) Number append {string} below line {lnum}
|
|
7
|
1267 argc() Number number of files in the argument list
|
|
55
|
1268 argidx() Number current index in the argument list
|
|
7
|
1269 argv( {nr}) String {nr} entry of the argument list
|
|
|
1270 browse( {save}, {title}, {initdir}, {default})
|
|
|
1271 String put up a file requester
|
|
29
|
1272 browsedir( {title}, {initdir}) String put up a directory requester
|
|
7
|
1273 bufexists( {expr}) Number TRUE if buffer {expr} exists
|
|
55
|
1274 buflisted( {expr}) Number TRUE if buffer {expr} is listed
|
|
|
1275 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
|
|
7
|
1276 bufname( {expr}) String Name of the buffer {expr}
|
|
|
1277 bufnr( {expr}) Number Number of the buffer {expr}
|
|
|
1278 bufwinnr( {expr}) Number window number of buffer {expr}
|
|
|
1279 byte2line( {byte}) Number line number at byte count {byte}
|
|
55
|
1280 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
|
|
79
|
1281 call( {func}, {arglist}) any call {func} with arguments {arglist}
|
|
7
|
1282 char2nr( {expr}) Number ASCII value of first char in {expr}
|
|
55
|
1283 cindent( {lnum}) Number C indent for line {lnum}
|
|
7
|
1284 col( {expr}) Number column nr of cursor or mark
|
|
|
1285 confirm( {msg} [, {choices} [, {default} [, {type}]]])
|
|
|
1286 Number number of choice picked by user
|
|
55
|
1287 copy( {expr}) any make a shallow copy of {expr}
|
|
95
|
1288 count( {list}, {expr} [, {start} [, {ic}]])
|
|
|
1289 Number count how many {expr} are in {list}
|
|
7
|
1290 cscope_connection( [{num} , {dbpath} [, {prepend}]])
|
|
|
1291 Number checks existence of cscope connection
|
|
55
|
1292 cursor( {lnum}, {col}) Number position cursor at {lnum}, {col}
|
|
|
1293 deepcopy( {expr}) any make a full copy of {expr}
|
|
7
|
1294 delete( {fname}) Number delete file {fname}
|
|
|
1295 did_filetype() Number TRUE if FileType autocommand event used
|
|
55
|
1296 diff_filler( {lnum}) Number diff filler lines about {lnum}
|
|
|
1297 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
|
|
85
|
1298 empty( {expr}) Number TRUE if {expr} is empty
|
|
7
|
1299 escape( {string}, {chars}) String escape {chars} in {string} with '\'
|
|
95
|
1300 eval( {string}) any evaluate {string} into its value
|
|
55
|
1301 eventhandler( ) Number TRUE if inside an event handler
|
|
7
|
1302 executable( {expr}) Number 1 if executable {expr} exists
|
|
|
1303 exists( {expr}) Number TRUE if {expr} exists
|
|
|
1304 expand( {expr}) String expand special keywords in {expr}
|
|
|
1305 filereadable( {file}) Number TRUE if {file} is a readable file
|
|
95
|
1306 filter( {list}, {expr}) List remove from {list} where {expr} is 0
|
|
|
1307 finddir( {name}[, {path}[, {count}]])
|
|
|
1308 String Find directory {name} in {path}
|
|
19
|
1309 findfile( {name}[, {path}[, {count}]])
|
|
95
|
1310 String Find file {name} in {path}
|
|
7
|
1311 filewritable( {file}) Number TRUE if {file} is a writable file
|
|
|
1312 fnamemodify( {fname}, {mods}) String modify file name
|
|
55
|
1313 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
|
|
|
1314 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
|
|
7
|
1315 foldlevel( {lnum}) Number fold level at {lnum}
|
|
55
|
1316 foldtext( ) String line displayed for closed fold
|
|
7
|
1317 foreground( ) Number bring the Vim window to the foreground
|
|
55
|
1318 function( {name}) Funcref reference to function {name}
|
|
82
|
1319 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
|
|
55
|
1320 getchar( [expr]) Number get one character from the user
|
|
|
1321 getcharmod( ) Number modifiers for the last typed character
|
|
7
|
1322 getbufvar( {expr}, {varname}) variable {varname} in buffer {expr}
|
|
|
1323 getcmdline() String return the current command-line
|
|
|
1324 getcmdpos() Number return cursor position in command-line
|
|
|
1325 getcwd() String the current working directory
|
|
20
|
1326 getfperm( {fname}) String file permissions of file {fname}
|
|
|
1327 getfsize( {fname}) Number size in bytes of file {fname}
|
|
37
|
1328 getfontname( [{name}]) String name of font being used
|
|
7
|
1329 getftime( {fname}) Number last modification time of file
|
|
20
|
1330 getftype( {fname}) String description of type of file {fname}
|
|
7
|
1331 getline( {lnum}) String line {lnum} from current buffer
|
|
55
|
1332 getreg( [{regname}]) String contents of register
|
|
|
1333 getregtype( [{regname}]) String type of register
|
|
7
|
1334 getwinposx() Number X coord in pixels of GUI Vim window
|
|
|
1335 getwinposy() Number Y coord in pixels of GUI Vim window
|
|
|
1336 getwinvar( {nr}, {varname}) variable {varname} in window {nr}
|
|
|
1337 glob( {expr}) String expand file wildcards in {expr}
|
|
|
1338 globpath( {path}, {expr}) String do glob({expr}) for all dirs in {path}
|
|
|
1339 has( {feature}) Number TRUE if feature {feature} supported
|
|
|
1340 hasmapto( {what} [, {mode}]) Number TRUE if mapping to {what} exists
|
|
|
1341 histadd( {history},{item}) String add an item to a history
|
|
|
1342 histdel( {history} [, {item}]) String remove an item from a history
|
|
|
1343 histget( {history} [, {index}]) String get the item {index} from a history
|
|
|
1344 histnr( {history}) Number highest index of a history
|
|
|
1345 hlexists( {name}) Number TRUE if highlight group {name} exists
|
|
|
1346 hlID( {name}) Number syntax ID of highlight group {name}
|
|
|
1347 hostname() String name of the machine Vim is running on
|
|
55
|
1348 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
|
|
|
1349 indent( {lnum}) Number indent of line {lnum}
|
|
95
|
1350 index( {list}, {expr} [, {start} [, {ic}]])
|
|
|
1351 Number index in {list} where {expr} appears
|
|
7
|
1352 input( {prompt} [, {text}]) String get input from the user
|
|
|
1353 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
|
|
55
|
1354 inputrestore() Number restore typeahead
|
|
|
1355 inputsave() Number save and clear typeahead
|
|
7
|
1356 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
|
|
55
|
1357 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
|
|
7
|
1358 isdirectory( {directory}) Number TRUE if {directory} is a directory
|
|
95
|
1359 join( {list} [, {sep}]) String join {list} items into one String
|
|
99
|
1360 keys( {dict}) List List of keys in {dict}
|
|
55
|
1361 len( {expr}) Number the length of {expr}
|
|
|
1362 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
|
|
7
|
1363 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
|
|
|
1364 line( {expr}) Number line nr of cursor, last line or mark
|
|
|
1365 line2byte( {lnum}) Number byte count of line {lnum}
|
|
55
|
1366 lispindent( {lnum}) Number Lisp indent for line {lnum}
|
|
7
|
1367 localtime() Number current time
|
|
95
|
1368 map( {list}, {expr}) List change each item in {list} to {expr}
|
|
7
|
1369 maparg( {name}[, {mode}]) String rhs of mapping {name} in mode {mode}
|
|
|
1370 mapcheck( {name}[, {mode}]) String check for mappings matching {name}
|
|
19
|
1371 match( {expr}, {pat}[, {start}[, {count}]])
|
|
7
|
1372 Number position where {pat} matches in {expr}
|
|
19
|
1373 matchend( {expr}, {pat}[, {start}[, {count}]])
|
|
7
|
1374 Number position where {pat} ends in {expr}
|
|
19
|
1375 matchstr( {expr}, {pat}[, {start}[, {count}]])
|
|
|
1376 String {count}'th match of {pat} in {expr}
|
|
87
|
1377 max({list}) Number maximum value of items in {list}
|
|
|
1378 min({list}) Number minumum value of items in {list}
|
|
55
|
1379 mode() String current editing mode
|
|
7
|
1380 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
|
|
|
1381 nr2char( {expr}) String single char with ASCII value {expr}
|
|
|
1382 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
|
|
99
|
1383 range( {expr} [, {max} [, {stride}]])
|
|
|
1384 List items from {expr} to {max}
|
|
7
|
1385 remote_expr( {server}, {string} [, {idvar}])
|
|
|
1386 String send expression
|
|
|
1387 remote_foreground( {server}) Number bring Vim server to the foreground
|
|
|
1388 remote_peek( {serverid} [, {retvar}])
|
|
|
1389 Number check for reply string
|
|
|
1390 remote_read( {serverid}) String read reply string
|
|
|
1391 remote_send( {server}, {string} [, {idvar}])
|
|
|
1392 String send key sequence
|
|
79
|
1393 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
|
|
99
|
1394 remove( {dict}, {key}) any remove entry {key} from {dict}
|
|
55
|
1395 rename( {from}, {to}) Number rename (move) file from {from} to {to}
|
|
|
1396 repeat( {expr}, {count}) String repeat {expr} {count} times
|
|
|
1397 resolve( {filename}) String get filename a shortcut points to
|
|
82
|
1398 reverse( {list}) List reverse {list} in-place
|
|
55
|
1399 search( {pattern} [, {flags}]) Number search for {pattern}
|
|
7
|
1400 searchpair( {start}, {middle}, {end} [, {flags} [, {skip}]])
|
|
55
|
1401 Number search for other end of start/end pair
|
|
7
|
1402 server2client( {clientid}, {string})
|
|
|
1403 Number send reply string
|
|
|
1404 serverlist() String get a list of available servers
|
|
|
1405 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
|
|
|
1406 setcmdpos( {pos}) Number set cursor position in command-line
|
|
|
1407 setline( {lnum}, {line}) Number set line {lnum} to {line}
|
|
55
|
1408 setreg( {n}, {v}[, {opt}]) Number set register to value and type
|
|
7
|
1409 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
|
|
55
|
1410 simplify( {filename}) String simplify filename as much as possible
|
|
82
|
1411 sort( {list} [, {func}]) List sort {list}, using {func} to compare
|
|
95
|
1412 split( {expr} [, {pat}]) List make List from {pat} separated {expr}
|
|
7
|
1413 strftime( {format}[, {time}]) String time in specified format
|
|
|
1414 stridx( {haystack}, {needle}) Number first index of {needle} in {haystack}
|
|
95
|
1415 string( {expr}) String String representation of {expr} value
|
|
7
|
1416 strlen( {expr}) Number length of the String {expr}
|
|
|
1417 strpart( {src}, {start}[, {len}])
|
|
|
1418 String {len} characters of {src} at {start}
|
|
|
1419 strridx( {haystack}, {needle}) Number last index of {needle} in {haystack}
|
|
|
1420 strtrans( {expr}) String translate string to make it printable
|
|
55
|
1421 submatch( {nr}) String specific match in ":substitute"
|
|
7
|
1422 substitute( {expr}, {pat}, {sub}, {flags})
|
|
|
1423 String all {pat} in {expr} replaced with {sub}
|
|
32
|
1424 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
|
|
7
|
1425 synIDattr( {synID}, {what} [, {mode}])
|
|
|
1426 String attribute {what} of syntax ID {synID}
|
|
|
1427 synIDtrans( {synID}) Number translated syntax ID of {synID}
|
|
24
|
1428 system( {expr} [, {input}]) String output of shell command/filter {expr}
|
|
7
|
1429 tempname() String name for a temporary file
|
|
|
1430 tolower( {expr}) String the String {expr} switched to lowercase
|
|
|
1431 toupper( {expr}) String the String {expr} switched to uppercase
|
|
15
|
1432 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
|
|
|
1433 to chars in {tostr}
|
|
7
|
1434 type( {name}) Number type of variable {name}
|
|
|
1435 virtcol( {expr}) Number screen column of cursor or mark
|
|
|
1436 visualmode( [expr]) String last visual mode used
|
|
|
1437 winbufnr( {nr}) Number buffer number of window {nr}
|
|
|
1438 wincol() Number window column of the cursor
|
|
|
1439 winheight( {nr}) Number height of window {nr}
|
|
|
1440 winline() Number window line of the cursor
|
|
|
1441 winnr() Number number of current window
|
|
55
|
1442 winrestcmd() String returns command to restore window sizes
|
|
7
|
1443 winwidth( {nr}) Number width of window {nr}
|
|
|
1444
|
|
82
|
1445 add({list}, {expr}) *add()*
|
|
|
1446 Append the item {expr} to List {list}. Returns the resulting
|
|
|
1447 List. Examples: >
|
|
|
1448 :let alist = add([1, 2, 3], item)
|
|
|
1449 :call add(mylist, "woodstock")
|
|
|
1450 < Note that when {expr} is a List it is appended as a single
|
|
55
|
1451 item. Use |extend()| to concatenate Lists.
|
|
85
|
1452 Use |insert()| to add an item at another position.
|
|
55
|
1453
|
|
82
|
1454
|
|
|
1455 append({lnum}, {expr}) *append()*
|
|
|
1456 When {expr} is a List: Append each item of the list as a text
|
|
|
1457 line below line {lnum} in the current buffer.
|
|
|
1458 Otherwise append the text line {expr} below line {lnum} in the
|
|
|
1459 current buffer.
|
|
|
1460 {lnum} can be zero, to insert a line before the first one.
|
|
|
1461 Returns 1 for failure ({lnum} out of range or out of memory),
|
|
|
1462 0 for success. Example: >
|
|
55
|
1463 :let failed = append(line('$'), "# THE END")
|
|
82
|
1464 :let failed = append(0, ["Chapter 1", "the beginning"])
|
|
55
|
1465 <
|
|
7
|
1466 *argc()*
|
|
|
1467 argc() The result is the number of files in the argument list of the
|
|
|
1468 current window. See |arglist|.
|
|
|
1469
|
|
|
1470 *argidx()*
|
|
|
1471 argidx() The result is the current index in the argument list. 0 is
|
|
|
1472 the first file. argc() - 1 is the last one. See |arglist|.
|
|
|
1473
|
|
|
1474 *argv()*
|
|
|
1475 argv({nr}) The result is the {nr}th file in the argument list of the
|
|
|
1476 current window. See |arglist|. "argv(0)" is the first one.
|
|
|
1477 Example: >
|
|
|
1478 :let i = 0
|
|
|
1479 :while i < argc()
|
|
|
1480 : let f = escape(argv(i), '. ')
|
|
|
1481 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
|
|
|
1482 : let i = i + 1
|
|
|
1483 :endwhile
|
|
|
1484 <
|
|
|
1485 *browse()*
|
|
|
1486 browse({save}, {title}, {initdir}, {default})
|
|
|
1487 Put up a file requester. This only works when "has("browse")"
|
|
|
1488 returns non-zero (only in some GUI versions).
|
|
|
1489 The input fields are:
|
|
|
1490 {save} when non-zero, select file to write
|
|
|
1491 {title} title for the requester
|
|
|
1492 {initdir} directory to start browsing in
|
|
|
1493 {default} default file name
|
|
|
1494 When the "Cancel" button is hit, something went wrong, or
|
|
|
1495 browsing is not possible, an empty string is returned.
|
|
|
1496
|
|
29
|
1497 *browsedir()*
|
|
|
1498 browsedir({title}, {initdir})
|
|
|
1499 Put up a directory requester. This only works when
|
|
|
1500 "has("browse")" returns non-zero (only in some GUI versions).
|
|
|
1501 On systems where a directory browser is not supported a file
|
|
|
1502 browser is used. In that case: select a file in the directory
|
|
|
1503 to be used.
|
|
|
1504 The input fields are:
|
|
|
1505 {title} title for the requester
|
|
|
1506 {initdir} directory to start browsing in
|
|
|
1507 When the "Cancel" button is hit, something went wrong, or
|
|
|
1508 browsing is not possible, an empty string is returned.
|
|
|
1509
|
|
7
|
1510 bufexists({expr}) *bufexists()*
|
|
|
1511 The result is a Number, which is non-zero if a buffer called
|
|
|
1512 {expr} exists.
|
|
9
|
1513 If the {expr} argument is a number, buffer numbers are used.
|
|
7
|
1514 If the {expr} argument is a string it must match a buffer name
|
|
9
|
1515 exactly. The name can be:
|
|
|
1516 - Relative to the current directory.
|
|
|
1517 - A full path.
|
|
|
1518 - The name of a buffer with 'filetype' set to "nofile".
|
|
|
1519 - A URL name.
|
|
7
|
1520 Unlisted buffers will be found.
|
|
|
1521 Note that help files are listed by their short name in the
|
|
|
1522 output of |:buffers|, but bufexists() requires using their
|
|
|
1523 long name to be able to find them.
|
|
|
1524 Use "bufexists(0)" to test for the existence of an alternate
|
|
|
1525 file name.
|
|
|
1526 *buffer_exists()*
|
|
|
1527 Obsolete name: buffer_exists().
|
|
|
1528
|
|
|
1529 buflisted({expr}) *buflisted()*
|
|
|
1530 The result is a Number, which is non-zero if a buffer called
|
|
|
1531 {expr} exists and is listed (has the 'buflisted' option set).
|
|
9
|
1532 The {expr} argument is used like with |bufexists()|.
|
|
7
|
1533
|
|
|
1534 bufloaded({expr}) *bufloaded()*
|
|
|
1535 The result is a Number, which is non-zero if a buffer called
|
|
|
1536 {expr} exists and is loaded (shown in a window or hidden).
|
|
9
|
1537 The {expr} argument is used like with |bufexists()|.
|
|
7
|
1538
|
|
|
1539 bufname({expr}) *bufname()*
|
|
|
1540 The result is the name of a buffer, as it is displayed by the
|
|
|
1541 ":ls" command.
|
|
|
1542 If {expr} is a Number, that buffer number's name is given.
|
|
|
1543 Number zero is the alternate buffer for the current window.
|
|
|
1544 If {expr} is a String, it is used as a |file-pattern| to match
|
|
|
1545 with the buffer names. This is always done like 'magic' is
|
|
|
1546 set and 'cpoptions' is empty. When there is more than one
|
|
|
1547 match an empty string is returned.
|
|
|
1548 "" or "%" can be used for the current buffer, "#" for the
|
|
|
1549 alternate buffer.
|
|
|
1550 A full match is preferred, otherwise a match at the start, end
|
|
|
1551 or middle of the buffer name is accepted.
|
|
|
1552 Listed buffers are found first. If there is a single match
|
|
|
1553 with a listed buffer, that one is returned. Next unlisted
|
|
|
1554 buffers are searched for.
|
|
|
1555 If the {expr} is a String, but you want to use it as a buffer
|
|
|
1556 number, force it to be a Number by adding zero to it: >
|
|
|
1557 :echo bufname("3" + 0)
|
|
|
1558 < If the buffer doesn't exist, or doesn't have a name, an empty
|
|
|
1559 string is returned. >
|
|
|
1560 bufname("#") alternate buffer name
|
|
|
1561 bufname(3) name of buffer 3
|
|
|
1562 bufname("%") name of current buffer
|
|
|
1563 bufname("file2") name of buffer where "file2" matches.
|
|
|
1564 < *buffer_name()*
|
|
|
1565 Obsolete name: buffer_name().
|
|
|
1566
|
|
|
1567 *bufnr()*
|
|
|
1568 bufnr({expr}) The result is the number of a buffer, as it is displayed by
|
|
|
1569 the ":ls" command. For the use of {expr}, see |bufname()|
|
|
|
1570 above. If the buffer doesn't exist, -1 is returned.
|
|
|
1571 bufnr("$") is the last buffer: >
|
|
|
1572 :let last_buffer = bufnr("$")
|
|
|
1573 < The result is a Number, which is the highest buffer number
|
|
|
1574 of existing buffers. Note that not all buffers with a smaller
|
|
|
1575 number necessarily exist, because ":bwipeout" may have removed
|
|
|
1576 them. Use bufexists() to test for the existence of a buffer.
|
|
|
1577 *buffer_number()*
|
|
|
1578 Obsolete name: buffer_number().
|
|
|
1579 *last_buffer_nr()*
|
|
|
1580 Obsolete name for bufnr("$"): last_buffer_nr().
|
|
|
1581
|
|
|
1582 bufwinnr({expr}) *bufwinnr()*
|
|
|
1583 The result is a Number, which is the number of the first
|
|
|
1584 window associated with buffer {expr}. For the use of {expr},
|
|
|
1585 see |bufname()| above. If buffer {expr} doesn't exist or
|
|
|
1586 there is no such window, -1 is returned. Example: >
|
|
|
1587
|
|
|
1588 echo "A window containing buffer 1 is " . (bufwinnr(1))
|
|
|
1589
|
|
|
1590 < The number can be used with |CTRL-W_w| and ":wincmd w"
|
|
|
1591 |:wincmd|.
|
|
|
1592
|
|
|
1593
|
|
|
1594 byte2line({byte}) *byte2line()*
|
|
|
1595 Return the line number that contains the character at byte
|
|
|
1596 count {byte} in the current buffer. This includes the
|
|
|
1597 end-of-line character, depending on the 'fileformat' option
|
|
|
1598 for the current buffer. The first character has byte count
|
|
|
1599 one.
|
|
|
1600 Also see |line2byte()|, |go| and |:goto|.
|
|
|
1601 {not available when compiled without the |+byte_offset|
|
|
|
1602 feature}
|
|
|
1603
|
|
18
|
1604 byteidx({expr}, {nr}) *byteidx()*
|
|
|
1605 Return byte index of the {nr}'th character in the string
|
|
|
1606 {expr}. Use zero for the first character, it returns zero.
|
|
|
1607 This function is only useful when there are multibyte
|
|
|
1608 characters, otherwise the returned value is equal to {nr}.
|
|
|
1609 Composing characters are counted as a separate character.
|
|
|
1610 Example : >
|
|
|
1611 echo matchstr(str, ".", byteidx(str, 3))
|
|
|
1612 < will display the fourth character. Another way to do the
|
|
|
1613 same: >
|
|
|
1614 let s = strpart(str, byteidx(str, 3))
|
|
|
1615 echo strpart(s, 0, byteidx(s, 1))
|
|
|
1616 < If there are less than {nr} characters -1 is returned.
|
|
|
1617 If there are exactly {nr} characters the length of the string
|
|
|
1618 is returned.
|
|
|
1619
|
|
85
|
1620 call({func}, {arglist}) *call()* *E699*
|
|
79
|
1621 Call function {func} with the items in List {arglist} as
|
|
|
1622 arguments.
|
|
|
1623 {func} can either be a Funcref or the name of a function.
|
|
|
1624 a:firstline and a:lastline are set to the cursor line.
|
|
|
1625 Returns the return value of the called function.
|
|
|
1626
|
|
7
|
1627 char2nr({expr}) *char2nr()*
|
|
|
1628 Return number value of the first char in {expr}. Examples: >
|
|
|
1629 char2nr(" ") returns 32
|
|
|
1630 char2nr("ABC") returns 65
|
|
|
1631 < The current 'encoding' is used. Example for "utf-8": >
|
|
|
1632 char2nr("á") returns 225
|
|
|
1633 char2nr("á"[0]) returns 195
|
|
|
1634
|
|
|
1635 cindent({lnum}) *cindent()*
|
|
|
1636 Get the amount of indent for line {lnum} according the C
|
|
|
1637 indenting rules, as with 'cindent'.
|
|
|
1638 The indent is counted in spaces, the value of 'tabstop' is
|
|
|
1639 relevant. {lnum} is used just like in |getline()|.
|
|
|
1640 When {lnum} is invalid or Vim was not compiled the |+cindent|
|
|
|
1641 feature, -1 is returned.
|
|
|
1642
|
|
|
1643 *col()*
|
|
24
|
1644 col({expr}) The result is a Number, which is the byte index of the column
|
|
7
|
1645 position given with {expr}. The accepted positions are:
|
|
|
1646 . the cursor position
|
|
|
1647 $ the end of the cursor line (the result is the
|
|
|
1648 number of characters in the cursor line plus one)
|
|
|
1649 'x position of mark x (if the mark is not set, 0 is
|
|
|
1650 returned)
|
|
|
1651 For the screen column position use |virtcol()|.
|
|
|
1652 Note that only marks in the current file can be used.
|
|
|
1653 Examples: >
|
|
|
1654 col(".") column of cursor
|
|
|
1655 col("$") length of cursor line plus one
|
|
|
1656 col("'t") column of mark t
|
|
|
1657 col("'" . markname) column of mark markname
|
|
|
1658 < The first column is 1. 0 is returned for an error.
|
|
|
1659 For the cursor position, when 'virtualedit' is active, the
|
|
|
1660 column is one higher if the cursor is after the end of the
|
|
|
1661 line. This can be used to obtain the column in Insert mode: >
|
|
|
1662 :imap <F2> <C-O>:let save_ve = &ve<CR>
|
|
|
1663 \<C-O>:set ve=all<CR>
|
|
|
1664 \<C-O>:echo col(".") . "\n" <Bar>
|
|
|
1665 \let &ve = save_ve<CR>
|
|
|
1666 <
|
|
|
1667 *confirm()*
|
|
|
1668 confirm({msg} [, {choices} [, {default} [, {type}]]])
|
|
|
1669 Confirm() offers the user a dialog, from which a choice can be
|
|
|
1670 made. It returns the number of the choice. For the first
|
|
|
1671 choice this is 1.
|
|
|
1672 Note: confirm() is only supported when compiled with dialog
|
|
|
1673 support, see |+dialog_con| and |+dialog_gui|.
|
|
|
1674 {msg} is displayed in a |dialog| with {choices} as the
|
|
|
1675 alternatives. When {choices} is missing or empty, "&OK" is
|
|
|
1676 used (and translated).
|
|
|
1677 {msg} is a String, use '\n' to include a newline. Only on
|
|
|
1678 some systems the string is wrapped when it doesn't fit.
|
|
|
1679 {choices} is a String, with the individual choices separated
|
|
|
1680 by '\n', e.g. >
|
|
|
1681 confirm("Save changes?", "&Yes\n&No\n&Cancel")
|
|
|
1682 < The letter after the '&' is the shortcut key for that choice.
|
|
|
1683 Thus you can type 'c' to select "Cancel". The shortcut does
|
|
|
1684 not need to be the first letter: >
|
|
|
1685 confirm("file has been modified", "&Save\nSave &All")
|
|
|
1686 < For the console, the first letter of each choice is used as
|
|
|
1687 the default shortcut key.
|
|
|
1688 The optional {default} argument is the number of the choice
|
|
|
1689 that is made if the user hits <CR>. Use 1 to make the first
|
|
|
1690 choice the default one. Use 0 to not set a default. If
|
|
|
1691 {default} is omitted, 1 is used.
|
|
|
1692 The optional {type} argument gives the type of dialog. This
|
|
|
1693 is only used for the icon of the Win32 GUI. It can be one of
|
|
|
1694 these values: "Error", "Question", "Info", "Warning" or
|
|
|
1695 "Generic". Only the first character is relevant. When {type}
|
|
|
1696 is omitted, "Generic" is used.
|
|
|
1697 If the user aborts the dialog by pressing <Esc>, CTRL-C,
|
|
|
1698 or another valid interrupt key, confirm() returns 0.
|
|
|
1699
|
|
|
1700 An example: >
|
|
|
1701 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
|
|
|
1702 :if choice == 0
|
|
|
1703 : echo "make up your mind!"
|
|
|
1704 :elseif choice == 3
|
|
|
1705 : echo "tasteful"
|
|
|
1706 :else
|
|
|
1707 : echo "I prefer bananas myself."
|
|
|
1708 :endif
|
|
|
1709 < In a GUI dialog, buttons are used. The layout of the buttons
|
|
|
1710 depends on the 'v' flag in 'guioptions'. If it is included,
|
|
|
1711 the buttons are always put vertically. Otherwise, confirm()
|
|
|
1712 tries to put the buttons in one horizontal line. If they
|
|
|
1713 don't fit, a vertical layout is used anyway. For some systems
|
|
|
1714 the horizontal layout is always used.
|
|
|
1715
|
|
55
|
1716 *copy()*
|
|
|
1717 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
|
|
|
1718 different from using {expr} directly.
|
|
|
1719 When {expr} is a List a shallow copy is created. This means
|
|
|
1720 that the original List can be changed without changing the
|
|
|
1721 copy, and vise versa. But the items are identical, thus
|
|
|
1722 changing an item changes the contents of both Lists. Also see
|
|
|
1723 |deepcopy()|.
|
|
|
1724
|
|
95
|
1725 count({list}, {expr} [, {start} [, {ic}]]) *count()*
|
|
79
|
1726 Return the number of times an item with value {expr} appears
|
|
|
1727 in List {list}.
|
|
95
|
1728 If {start} is given then don't count items with a lower index.
|
|
79
|
1729 When {ic} is given and it's non-zero then case is ignored.
|
|
|
1730
|
|
|
1731
|
|
7
|
1732 *cscope_connection()*
|
|
|
1733 cscope_connection([{num} , {dbpath} [, {prepend}]])
|
|
|
1734 Checks for the existence of a |cscope| connection. If no
|
|
|
1735 parameters are specified, then the function returns:
|
|
|
1736 0, if cscope was not available (not compiled in), or
|
|
|
1737 if there are no cscope connections;
|
|
|
1738 1, if there is at least one cscope connection.
|
|
|
1739
|
|
|
1740 If parameters are specified, then the value of {num}
|
|
|
1741 determines how existence of a cscope connection is checked:
|
|
|
1742
|
|
|
1743 {num} Description of existence check
|
|
|
1744 ----- ------------------------------
|
|
|
1745 0 Same as no parameters (e.g., "cscope_connection()").
|
|
|
1746 1 Ignore {prepend}, and use partial string matches for
|
|
|
1747 {dbpath}.
|
|
|
1748 2 Ignore {prepend}, and use exact string matches for
|
|
|
1749 {dbpath}.
|
|
|
1750 3 Use {prepend}, use partial string matches for both
|
|
|
1751 {dbpath} and {prepend}.
|
|
|
1752 4 Use {prepend}, use exact string matches for both
|
|
|
1753 {dbpath} and {prepend}.
|
|
|
1754
|
|
|
1755 Note: All string comparisons are case sensitive!
|
|
|
1756
|
|
|
1757 Examples. Suppose we had the following (from ":cs show"): >
|
|
|
1758
|
|
|
1759 # pid database name prepend path
|
|
|
1760 0 27664 cscope.out /usr/local
|
|
|
1761 <
|
|
|
1762 Invocation Return Val ~
|
|
|
1763 ---------- ---------- >
|
|
|
1764 cscope_connection() 1
|
|
|
1765 cscope_connection(1, "out") 1
|
|
|
1766 cscope_connection(2, "out") 0
|
|
|
1767 cscope_connection(3, "out") 0
|
|
|
1768 cscope_connection(3, "out", "local") 1
|
|
|
1769 cscope_connection(4, "out") 0
|
|
|
1770 cscope_connection(4, "out", "local") 0
|
|
|
1771 cscope_connection(4, "cscope.out", "/usr/local") 1
|
|
|
1772 <
|
|
|
1773 cursor({lnum}, {col}) *cursor()*
|
|
|
1774 Positions the cursor at the column {col} in the line {lnum}.
|
|
|
1775 Does not change the jumplist.
|
|
|
1776 If {lnum} is greater than the number of lines in the buffer,
|
|
|
1777 the cursor will be positioned at the last line in the buffer.
|
|
|
1778 If {lnum} is zero, the cursor will stay in the current line.
|
|
|
1779 If {col} is greater than the number of characters in the line,
|
|
|
1780 the cursor will be positioned at the last character in the
|
|
|
1781 line.
|
|
|
1782 If {col} is zero, the cursor will stay in the current column.
|
|
|
1783
|
|
55
|
1784
|
|
85
|
1785 deepcopy({expr}) *deepcopy()* *E698*
|
|
55
|
1786 Make a copy of {expr}. For Numbers and Strings this isn't
|
|
|
1787 different from using {expr} directly.
|
|
|
1788 When {expr} is a List a full copy is created. This means
|
|
|
1789 that the original List can be changed without changing the
|
|
|
1790 copy, and vise versa. When an item is a List, a copy for it
|
|
|
1791 is made, recursively. Thus changing an item in the copy does
|
|
|
1792 not change the contents of the original List.
|
|
|
1793 Also see |copy()|.
|
|
|
1794
|
|
|
1795 delete({fname}) *delete()*
|
|
|
1796 Deletes the file by the name {fname}. The result is a Number,
|
|
7
|
1797 which is 0 if the file was deleted successfully, and non-zero
|
|
|
1798 when the deletion failed.
|
|
55
|
1799 Use |remove()| to delete an item from a List.
|
|
7
|
1800
|
|
|
1801 *did_filetype()*
|
|
|
1802 did_filetype() Returns non-zero when autocommands are being executed and the
|
|
|
1803 FileType event has been triggered at least once. Can be used
|
|
|
1804 to avoid triggering the FileType event again in the scripts
|
|
|
1805 that detect the file type. |FileType|
|
|
|
1806 When editing another file, the counter is reset, thus this
|
|
|
1807 really checks if the FileType event has been triggered for the
|
|
|
1808 current buffer. This allows an autocommand that starts
|
|
|
1809 editing another buffer to set 'filetype' and load a syntax
|
|
|
1810 file.
|
|
|
1811
|
|
32
|
1812 diff_filler({lnum}) *diff_filler()*
|
|
|
1813 Returns the number of filler lines above line {lnum}.
|
|
|
1814 These are the lines that were inserted at this point in
|
|
|
1815 another diff'ed window. These filler lines are shown in the
|
|
|
1816 display but don't exist in the buffer.
|
|
|
1817 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
1818 line, "'m" mark m, etc.
|
|
|
1819 Returns 0 if the current window is not in diff mode.
|
|
|
1820
|
|
|
1821 diff_hlID({lnum}, {col}) *diff_hlID()*
|
|
|
1822 Returns the highlight ID for diff mode at line {lnum} column
|
|
|
1823 {col} (byte index). When the current line does not have a
|
|
|
1824 diff change zero is returned.
|
|
|
1825 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
1826 line, "'m" mark m, etc.
|
|
|
1827 {col} is 1 for the leftmost column, {lnum} is 1 for the first
|
|
|
1828 line.
|
|
|
1829 The highlight ID can be used with |synIDattr()| to obtain
|
|
|
1830 syntax information about the highlighting.
|
|
|
1831
|
|
85
|
1832 empty({expr}) *empty()*
|
|
|
1833 Return the Number 1 if {expr} is empty, zero otherwise.
|
|
|
1834 A List is empty when it does not have any items.
|
|
|
1835 A Number is empty when its value is zero.
|
|
|
1836 For a long List this is much faster then comparing the length
|
|
|
1837 with zero.
|
|
|
1838
|
|
7
|
1839 escape({string}, {chars}) *escape()*
|
|
|
1840 Escape the characters in {chars} that occur in {string} with a
|
|
|
1841 backslash. Example: >
|
|
|
1842 :echo escape('c:\program files\vim', ' \')
|
|
|
1843 < results in: >
|
|
|
1844 c:\\program\ files\\vim
|
|
95
|
1845
|
|
|
1846 < *eval()*
|
|
|
1847 eval({string}) Evaluate {string} and return the result. Especially useful to
|
|
|
1848 turn the result of |string()| back into the original value.
|
|
|
1849 This works for Numbers, Strings and composites of them.
|
|
|
1850 Also works for Funcrefs that refer to existing functions.
|
|
|
1851
|
|
7
|
1852 eventhandler() *eventhandler()*
|
|
|
1853 Returns 1 when inside an event handler. That is that Vim got
|
|
|
1854 interrupted while waiting for the user to type a character,
|
|
|
1855 e.g., when dropping a file on Vim. This means interactive
|
|
|
1856 commands cannot be used. Otherwise zero is returned.
|
|
|
1857
|
|
|
1858 executable({expr}) *executable()*
|
|
|
1859 This function checks if an executable with the name {expr}
|
|
|
1860 exists. {expr} must be the name of the program without any
|
|
10
|
1861 arguments.
|
|
|
1862 executable() uses the value of $PATH and/or the normal
|
|
|
1863 searchpath for programs. *PATHEXT*
|
|
|
1864 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
|
|
|
1865 optionally be included. Then the extensions in $PATHEXT are
|
|
|
1866 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
|
|
|
1867 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
|
|
|
1868 used. A dot by itself can be used in $PATHEXT to try using
|
|
|
1869 the name without an extension. When 'shell' looks like a
|
|
|
1870 Unix shell, then the name is also tried without adding an
|
|
|
1871 extension.
|
|
|
1872 On MS-DOS and MS-Windows it only checks if the file exists and
|
|
|
1873 is not a directory, not if it's really executable.
|
|
7
|
1874 The result is a Number:
|
|
|
1875 1 exists
|
|
|
1876 0 does not exist
|
|
|
1877 -1 not implemented on this system
|
|
|
1878
|
|
|
1879 *exists()*
|
|
|
1880 exists({expr}) The result is a Number, which is non-zero if {expr} is
|
|
|
1881 defined, zero otherwise. The {expr} argument is a string,
|
|
|
1882 which contains one of these:
|
|
|
1883 &option-name Vim option (only checks if it exists,
|
|
|
1884 not if it really works)
|
|
|
1885 +option-name Vim option that works.
|
|
|
1886 $ENVNAME environment variable (could also be
|
|
|
1887 done by comparing with an empty
|
|
|
1888 string)
|
|
|
1889 *funcname built-in function (see |functions|)
|
|
|
1890 or user defined function (see
|
|
|
1891 |user-functions|).
|
|
|
1892 varname internal variable (see
|
|
|
1893 |internal-variables|). Does not work
|
|
|
1894 for |curly-braces-names|.
|
|
|
1895 :cmdname Ex command: built-in command, user
|
|
|
1896 command or command modifier |:command|.
|
|
|
1897 Returns:
|
|
|
1898 1 for match with start of a command
|
|
|
1899 2 full match with a command
|
|
|
1900 3 matches several user commands
|
|
|
1901 To check for a supported command
|
|
|
1902 always check the return value to be 2.
|
|
|
1903 #event autocommand defined for this event
|
|
|
1904 #event#pattern autocommand defined for this event and
|
|
|
1905 pattern (the pattern is taken
|
|
|
1906 literally and compared to the
|
|
|
1907 autocommand patterns character by
|
|
|
1908 character)
|
|
|
1909 For checking for a supported feature use |has()|.
|
|
|
1910
|
|
|
1911 Examples: >
|
|
|
1912 exists("&shortname")
|
|
|
1913 exists("$HOSTNAME")
|
|
|
1914 exists("*strftime")
|
|
|
1915 exists("*s:MyFunc")
|
|
|
1916 exists("bufcount")
|
|
|
1917 exists(":Make")
|
|
|
1918 exists("#CursorHold");
|
|
|
1919 exists("#BufReadPre#*.gz")
|
|
|
1920 < There must be no space between the symbol (&/$/*/#) and the
|
|
|
1921 name.
|
|
|
1922 Note that the argument must be a string, not the name of the
|
|
|
1923 variable itself! For example: >
|
|
|
1924 exists(bufcount)
|
|
|
1925 < This doesn't check for existence of the "bufcount" variable,
|
|
|
1926 but gets the contents of "bufcount", and checks if that
|
|
|
1927 exists.
|
|
|
1928
|
|
|
1929 expand({expr} [, {flag}]) *expand()*
|
|
|
1930 Expand wildcards and the following special keywords in {expr}.
|
|
|
1931 The result is a String.
|
|
|
1932
|
|
|
1933 When there are several matches, they are separated by <NL>
|
|
|
1934 characters. [Note: in version 5.0 a space was used, which
|
|
|
1935 caused problems when a file name contains a space]
|
|
|
1936
|
|
|
1937 If the expansion fails, the result is an empty string. A name
|
|
|
1938 for a non-existing file is not included.
|
|
|
1939
|
|
|
1940 When {expr} starts with '%', '#' or '<', the expansion is done
|
|
|
1941 like for the |cmdline-special| variables with their associated
|
|
|
1942 modifiers. Here is a short overview:
|
|
|
1943
|
|
|
1944 % current file name
|
|
|
1945 # alternate file name
|
|
|
1946 #n alternate file name n
|
|
|
1947 <cfile> file name under the cursor
|
|
|
1948 <afile> autocmd file name
|
|
|
1949 <abuf> autocmd buffer number (as a String!)
|
|
|
1950 <amatch> autocmd matched name
|
|
|
1951 <sfile> sourced script file name
|
|
|
1952 <cword> word under the cursor
|
|
|
1953 <cWORD> WORD under the cursor
|
|
|
1954 <client> the {clientid} of the last received
|
|
|
1955 message |server2client()|
|
|
|
1956 Modifiers:
|
|
|
1957 :p expand to full path
|
|
|
1958 :h head (last path component removed)
|
|
|
1959 :t tail (last path component only)
|
|
|
1960 :r root (one extension removed)
|
|
|
1961 :e extension only
|
|
|
1962
|
|
|
1963 Example: >
|
|
|
1964 :let &tags = expand("%:p:h") . "/tags"
|
|
|
1965 < Note that when expanding a string that starts with '%', '#' or
|
|
|
1966 '<', any following text is ignored. This does NOT work: >
|
|
|
1967 :let doesntwork = expand("%:h.bak")
|
|
|
1968 < Use this: >
|
|
|
1969 :let doeswork = expand("%:h") . ".bak"
|
|
|
1970 < Also note that expanding "<cfile>" and others only returns the
|
|
|
1971 referenced file name without further expansion. If "<cfile>"
|
|
|
1972 is "~/.cshrc", you need to do another expand() to have the
|
|
|
1973 "~/" expanded into the path of the home directory: >
|
|
|
1974 :echo expand(expand("<cfile>"))
|
|
|
1975 <
|
|
|
1976 There cannot be white space between the variables and the
|
|
|
1977 following modifier. The |fnamemodify()| function can be used
|
|
|
1978 to modify normal file names.
|
|
|
1979
|
|
|
1980 When using '%' or '#', and the current or alternate file name
|
|
|
1981 is not defined, an empty string is used. Using "%:p" in a
|
|
|
1982 buffer with no name, results in the current directory, with a
|
|
|
1983 '/' added.
|
|
|
1984
|
|
|
1985 When {expr} does not start with '%', '#' or '<', it is
|
|
|
1986 expanded like a file name is expanded on the command line.
|
|
|
1987 'suffixes' and 'wildignore' are used, unless the optional
|
|
|
1988 {flag} argument is given and it is non-zero. Names for
|
|
|
1989 non-existing files are included.
|
|
|
1990
|
|
|
1991 Expand() can also be used to expand variables and environment
|
|
|
1992 variables that are only known in a shell. But this can be
|
|
|
1993 slow, because a shell must be started. See |expr-env-expand|.
|
|
|
1994 The expanded variable is still handled like a list of file
|
|
|
1995 names. When an environment variable cannot be expanded, it is
|
|
|
1996 left unchanged. Thus ":echo expand('$FOOBAR')" results in
|
|
|
1997 "$FOOBAR".
|
|
|
1998
|
|
|
1999 See |glob()| for finding existing files. See |system()| for
|
|
|
2000 getting the raw output of an external command.
|
|
|
2001
|
|
79
|
2002 extend({list1}, {list2} [, {idx}]) *extend()*
|
|
|
2003 Append {list2} to {list1}.
|
|
|
2004 If {idx} is given insert the items of {list2} before item
|
|
|
2005 {idx} in {list1}. When {idx} is zero insert before the first
|
|
95
|
2006 item. When {idx} is equal to len({list1}) then {list2} is
|
|
79
|
2007 appended.
|
|
|
2008 {list1} is changed when {list2} is not empty.
|
|
|
2009 {list2} remains unchanged.
|
|
|
2010 {list1} and {list2} must be Lists.
|
|
|
2011 Returns {list1}.
|
|
|
2012 Examples: >
|
|
|
2013 :echo sort(extend(mylist, [7, 5]))
|
|
|
2014 :call extend(mylist, [2, 3], 1)
|
|
82
|
2015 < Use |add()| to concatenate one item to a list. To concatenate
|
|
|
2016 two lists into a new list use the + operator: >
|
|
79
|
2017 :let newlist = [1, 2, 3] + [4, 5]
|
|
|
2018
|
|
7
|
2019 filereadable({file}) *filereadable()*
|
|
|
2020 The result is a Number, which is TRUE when a file with the
|
|
|
2021 name {file} exists, and can be read. If {file} doesn't exist,
|
|
|
2022 or is a directory, the result is FALSE. {file} is any
|
|
|
2023 expression, which is used as a String.
|
|
|
2024 *file_readable()*
|
|
|
2025 Obsolete name: file_readable().
|
|
|
2026
|
|
95
|
2027
|
|
|
2028 filter({list}, {expr}) *filter()* *E712*
|
|
|
2029 For each item in {list} evaluate {expr} and when the result is
|
|
|
2030 zero remove the item from the List.
|
|
|
2031 Inside {expr} the symbol "&" stands for the existing
|
|
|
2032 item. Example: >
|
|
99
|
2033 :call filter(mylist, '& !~ "OLD"')
|
|
|
2034 < Removes the items where "OLD" appears. And this: >
|
|
|
2035 :call filter(mylist, 0)
|
|
|
2036 < Removes all the items, thus clears the List or Dictionary.
|
|
|
2037
|
|
95
|
2038 Note that {expr} is an expression that evaluates to an
|
|
99
|
2039 expression. Often it is good to use a |literal-string| to
|
|
|
2040 avoid having to double backslashes.
|
|
95
|
2041 The operation is done in-place. If you want a list to remain
|
|
|
2042 unmodified make a copy first: >
|
|
99
|
2043 :let l = filter(copy(mylist), '& =~ "KEEP"')
|
|
95
|
2044 < Returns {list}.
|
|
|
2045
|
|
|
2046
|
|
19
|
2047 finddir({name}[, {path}[, {count}]]) *finddir()*
|
|
|
2048 Find directory {name} in {path}.
|
|
|
2049 If {path} is omitted or empty then 'path' is used.
|
|
|
2050 If the optional {count} is given, find {count}'s occurrence of
|
|
|
2051 {name} in {path}.
|
|
|
2052 This is quite similar to the ex-command |:find|.
|
|
|
2053 When the found directory is below the current directory a
|
|
|
2054 relative path is returned. Otherwise a full path is returned.
|
|
|
2055 Example: >
|
|
|
2056 :echo findfile("tags.vim", ".;")
|
|
|
2057 < Searches from the current directory upwards until it finds
|
|
|
2058 the file "tags.vim".
|
|
|
2059 {only available when compiled with the +file_in_path feature}
|
|
|
2060
|
|
|
2061 findfile({name}[, {path}[, {count}]]) *findfile()*
|
|
|
2062 Just like |finddir()|, but find a file instead of a directory.
|
|
|
2063
|
|
7
|
2064 filewritable({file}) *filewritable()*
|
|
|
2065 The result is a Number, which is 1 when a file with the
|
|
|
2066 name {file} exists, and can be written. If {file} doesn't
|
|
|
2067 exist, or is not writable, the result is 0. If (file) is a
|
|
|
2068 directory, and we can write to it, the result is 2.
|
|
|
2069
|
|
|
2070 fnamemodify({fname}, {mods}) *fnamemodify()*
|
|
|
2071 Modify file name {fname} according to {mods}. {mods} is a
|
|
|
2072 string of characters like it is used for file names on the
|
|
|
2073 command line. See |filename-modifiers|.
|
|
|
2074 Example: >
|
|
|
2075 :echo fnamemodify("main.c", ":p:h")
|
|
|
2076 < results in: >
|
|
|
2077 /home/mool/vim/vim/src
|
|
|
2078 < Note: Environment variables and "~" don't work in {fname}, use
|
|
|
2079 |expand()| first then.
|
|
|
2080
|
|
|
2081 foldclosed({lnum}) *foldclosed()*
|
|
|
2082 The result is a Number. If the line {lnum} is in a closed
|
|
|
2083 fold, the result is the number of the first line in that fold.
|
|
|
2084 If the line {lnum} is not in a closed fold, -1 is returned.
|
|
|
2085
|
|
|
2086 foldclosedend({lnum}) *foldclosedend()*
|
|
|
2087 The result is a Number. If the line {lnum} is in a closed
|
|
|
2088 fold, the result is the number of the last line in that fold.
|
|
|
2089 If the line {lnum} is not in a closed fold, -1 is returned.
|
|
|
2090
|
|
|
2091 foldlevel({lnum}) *foldlevel()*
|
|
|
2092 The result is a Number, which is the foldlevel of line {lnum}
|
|
|
2093 in the current buffer. For nested folds the deepest level is
|
|
|
2094 returned. If there is no fold at line {lnum}, zero is
|
|
|
2095 returned. It doesn't matter if the folds are open or closed.
|
|
|
2096 When used while updating folds (from 'foldexpr') -1 is
|
|
|
2097 returned for lines where folds are still to be updated and the
|
|
|
2098 foldlevel is unknown. As a special case the level of the
|
|
|
2099 previous line is usually available.
|
|
|
2100
|
|
|
2101 *foldtext()*
|
|
|
2102 foldtext() Returns a String, to be displayed for a closed fold. This is
|
|
|
2103 the default function used for the 'foldtext' option and should
|
|
|
2104 only be called from evaluating 'foldtext'. It uses the
|
|
|
2105 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
|
|
|
2106 The returned string looks like this: >
|
|
|
2107 +-- 45 lines: abcdef
|
|
|
2108 < The number of dashes depends on the foldlevel. The "45" is
|
|
|
2109 the number of lines in the fold. "abcdef" is the text in the
|
|
|
2110 first non-blank line of the fold. Leading white space, "//"
|
|
|
2111 or "/*" and the text from the 'foldmarker' and 'commentstring'
|
|
|
2112 options is removed.
|
|
|
2113 {not available when compiled without the |+folding| feature}
|
|
|
2114
|
|
29
|
2115 foldtextresult({lnum}) *foldtextresult()*
|
|
|
2116 Returns the text that is displayed for the closed fold at line
|
|
|
2117 {lnum}. Evaluates 'foldtext' in the appropriate context.
|
|
|
2118 When there is no closed fold at {lnum} an empty string is
|
|
|
2119 returned.
|
|
|
2120 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
2121 line, "'m" mark m, etc.
|
|
|
2122 Useful when exporting folded text, e.g., to HTML.
|
|
|
2123 {not available when compiled without the |+folding| feature}
|
|
|
2124
|
|
7
|
2125 *foreground()*
|
|
|
2126 foreground() Move the Vim window to the foreground. Useful when sent from
|
|
|
2127 a client to a Vim server. |remote_send()|
|
|
|
2128 On Win32 systems this might not work, the OS does not always
|
|
|
2129 allow a window to bring itself to the foreground. Use
|
|
|
2130 |remote_foreground()| instead.
|
|
|
2131 {only in the Win32, Athena, Motif and GTK GUI versions and the
|
|
|
2132 Win32 console version}
|
|
|
2133
|
|
82
|
2134
|
|
85
|
2135 function({name}) *function()* *E700*
|
|
55
|
2136 Return a Funcref variable that refers to function {name}.
|
|
|
2137 {name} can be a user defined function or an internal function.
|
|
|
2138
|
|
82
|
2139
|
|
|
2140 get({list}, {idx} [, {default}]) *get*
|
|
|
2141 Get item {idx} from List {list}. When this item is not
|
|
|
2142 available return {default}. Return zero when {default} is
|
|
|
2143 omitted.
|
|
|
2144
|
|
|
2145 getbufvar({expr}, {varname}) *getbufvar()*
|
|
|
2146 The result is the value of option or local buffer variable
|
|
|
2147 {varname} in buffer {expr}. Note that the name without "b:"
|
|
|
2148 must be used.
|
|
|
2149 This also works for a global or local window option, but it
|
|
|
2150 doesn't work for a global or local window variable.
|
|
|
2151 For the use of {expr}, see |bufname()| above.
|
|
|
2152 When the buffer or variable doesn't exist an empty string is
|
|
|
2153 returned, there is no error message.
|
|
|
2154 Examples: >
|
|
|
2155 :let bufmodified = getbufvar(1, "&mod")
|
|
|
2156 :echo "todo myvar = " . getbufvar("todo", "myvar")
|
|
|
2157 <
|
|
7
|
2158 getchar([expr]) *getchar()*
|
|
|
2159 Get a single character from the user. If it is an 8-bit
|
|
|
2160 character, the result is a number. Otherwise a String is
|
|
|
2161 returned with the encoded character. For a special key it's a
|
|
|
2162 sequence of bytes starting with 0x80 (decimal: 128).
|
|
|
2163 If [expr] is omitted, wait until a character is available.
|
|
|
2164 If [expr] is 0, only get a character when one is available.
|
|
|
2165 If [expr] is 1, only check if a character is available, it is
|
|
|
2166 not consumed. If a normal character is
|
|
|
2167 available, it is returned, otherwise a
|
|
|
2168 non-zero value is returned.
|
|
|
2169 If a normal character available, it is returned as a Number.
|
|
|
2170 Use nr2char() to convert it to a String.
|
|
|
2171 The returned value is zero if no character is available.
|
|
|
2172 The returned value is a string of characters for special keys
|
|
|
2173 and when a modifier (shift, control, alt) was used.
|
|
|
2174 There is no prompt, you will somehow have to make clear to the
|
|
|
2175 user that a character has to be typed.
|
|
|
2176 There is no mapping for the character.
|
|
|
2177 Key codes are replaced, thus when the user presses the <Del>
|
|
|
2178 key you get the code for the <Del> key, not the raw character
|
|
|
2179 sequence. Examples: >
|
|
|
2180 getchar() == "\<Del>"
|
|
|
2181 getchar() == "\<S-Left>"
|
|
|
2182 < This example redefines "f" to ignore case: >
|
|
|
2183 :nmap f :call FindChar()<CR>
|
|
|
2184 :function FindChar()
|
|
|
2185 : let c = nr2char(getchar())
|
|
|
2186 : while col('.') < col('$') - 1
|
|
|
2187 : normal l
|
|
|
2188 : if getline('.')[col('.') - 1] ==? c
|
|
|
2189 : break
|
|
|
2190 : endif
|
|
|
2191 : endwhile
|
|
|
2192 :endfunction
|
|
|
2193
|
|
|
2194 getcharmod() *getcharmod()*
|
|
|
2195 The result is a Number which is the state of the modifiers for
|
|
|
2196 the last obtained character with getchar() or in another way.
|
|
|
2197 These values are added together:
|
|
|
2198 2 shift
|
|
|
2199 4 control
|
|
|
2200 8 alt (meta)
|
|
|
2201 16 mouse double click
|
|
|
2202 32 mouse triple click
|
|
|
2203 64 mouse quadruple click
|
|
|
2204 128 Macintosh only: command
|
|
|
2205 Only the modifiers that have not been included in the
|
|
|
2206 character itself are obtained. Thus Shift-a results in "A"
|
|
|
2207 with no modifier.
|
|
|
2208
|
|
|
2209 getcmdline() *getcmdline()*
|
|
|
2210 Return the current command-line. Only works when the command
|
|
|
2211 line is being edited, thus requires use of |c_CTRL-\_e| or
|
|
|
2212 |c_CTRL-R_=|.
|
|
|
2213 Example: >
|
|
|
2214 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
|
|
|
2215 < Also see |getcmdpos()| and |setcmdpos()|.
|
|
|
2216
|
|
95
|
2217 getcmdpos() *getcmdpos()*
|
|
7
|
2218 Return the position of the cursor in the command line as a
|
|
|
2219 byte count. The first column is 1.
|
|
|
2220 Only works when editing the command line, thus requires use of
|
|
|
2221 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
|
|
|
2222 Also see |setcmdpos()| and |getcmdline()|.
|
|
|
2223
|
|
|
2224 *getcwd()*
|
|
|
2225 getcwd() The result is a String, which is the name of the current
|
|
|
2226 working directory.
|
|
|
2227
|
|
|
2228 getfsize({fname}) *getfsize()*
|
|
|
2229 The result is a Number, which is the size in bytes of the
|
|
|
2230 given file {fname}.
|
|
|
2231 If {fname} is a directory, 0 is returned.
|
|
|
2232 If the file {fname} can't be found, -1 is returned.
|
|
|
2233
|
|
37
|
2234 getfontname([{name}]) *getfontname()*
|
|
|
2235 Without an argument returns the name of the normal font being
|
|
|
2236 used. Like what is used for the Normal highlight group
|
|
|
2237 |hl-Normal|.
|
|
|
2238 With an argument a check is done whether {name} is a valid
|
|
|
2239 font name. If not then an empty string is returned.
|
|
|
2240 Otherwise the actual font name is returned, or {name} if the
|
|
|
2241 GUI does not support obtaining the real name.
|
|
|
2242 Only works when the GUI is running, thus not you your vimrc or
|
|
|
2243 Note that the GTK 2 GUI accepts any font name, thus checking
|
|
|
2244 for a valid name does not work.
|
|
|
2245 gvimrc file. Use the |GUIEnter| autocommand to use this
|
|
|
2246 function just after the GUI has started.
|
|
|
2247
|
|
20
|
2248 getfperm({fname}) *getfperm()*
|
|
|
2249 The result is a String, which is the read, write, and execute
|
|
|
2250 permissions of the given file {fname}.
|
|
|
2251 If {fname} does not exist or its directory cannot be read, an
|
|
|
2252 empty string is returned.
|
|
|
2253 The result is of the form "rwxrwxrwx", where each group of
|
|
|
2254 "rwx" flags represent, in turn, the permissions of the owner
|
|
|
2255 of the file, the group the file belongs to, and other users.
|
|
|
2256 If a user does not have a given permission the flag for this
|
|
|
2257 is replaced with the string "-". Example: >
|
|
|
2258 :echo getfperm("/etc/passwd")
|
|
|
2259 < This will hopefully (from a security point of view) display
|
|
|
2260 the string "rw-r--r--" or even "rw-------".
|
|
|
2261
|
|
7
|
2262 getftime({fname}) *getftime()*
|
|
|
2263 The result is a Number, which is the last modification time of
|
|
|
2264 the given file {fname}. The value is measured as seconds
|
|
|
2265 since 1st Jan 1970, and may be passed to strftime(). See also
|
|
|
2266 |localtime()| and |strftime()|.
|
|
|
2267 If the file {fname} can't be found -1 is returned.
|
|
|
2268
|
|
20
|
2269 getftype({fname}) *getftype()*
|
|
|
2270 The result is a String, which is a description of the kind of
|
|
|
2271 file of the given file {fname}.
|
|
|
2272 If {fname} does not exist an empty string is returned.
|
|
|
2273 Here is a table over different kinds of files and their
|
|
|
2274 results:
|
|
|
2275 Normal file "file"
|
|
|
2276 Directory "dir"
|
|
|
2277 Symbolic link "link"
|
|
|
2278 Block device "bdev"
|
|
|
2279 Character device "cdev"
|
|
|
2280 Socket "socket"
|
|
|
2281 FIFO "fifo"
|
|
|
2282 All other "other"
|
|
|
2283 Example: >
|
|
|
2284 getftype("/home")
|
|
|
2285 < Note that a type such as "link" will only be returned on
|
|
|
2286 systems that support it. On some systems only "dir" and
|
|
|
2287 "file" are returned.
|
|
|
2288
|
|
7
|
2289 *getline()*
|
|
82
|
2290 getline({lnum} [, {end}])
|
|
|
2291 Without {end} the result is a String, which is line {lnum}
|
|
|
2292 from the current buffer. Example: >
|
|
7
|
2293 getline(1)
|
|
|
2294 < When {lnum} is a String that doesn't start with a
|
|
|
2295 digit, line() is called to translate the String into a Number.
|
|
|
2296 To get the line under the cursor: >
|
|
|
2297 getline(".")
|
|
|
2298 < When {lnum} is smaller than 1 or bigger than the number of
|
|
|
2299 lines in the buffer, an empty string is returned.
|
|
|
2300
|
|
82
|
2301 When {end} is given the result is a List where each item is a
|
|
|
2302 line from the current buffer in the range {lnum} to {end},
|
|
|
2303 including line {end}.
|
|
|
2304 {end} is used in the same way as {lnum}.
|
|
|
2305 Non-existing lines are silently omitted.
|
|
|
2306 When {end} is before {lnum} an error is given.
|
|
|
2307 Example: >
|
|
|
2308 :let start = line('.')
|
|
|
2309 :let end = search("^$") - 1
|
|
|
2310 :let lines = getline(start, end)
|
|
|
2311
|
|
|
2312
|
|
7
|
2313 getreg([{regname}]) *getreg()*
|
|
|
2314 The result is a String, which is the contents of register
|
|
|
2315 {regname}. Example: >
|
|
|
2316 :let cliptext = getreg('*')
|
|
|
2317 < getreg('=') returns the last evaluated value of the expression
|
|
|
2318 register. (For use in maps).
|
|
|
2319 If {regname} is not specified, |v:register| is used.
|
|
|
2320
|
|
82
|
2321
|
|
7
|
2322 getregtype([{regname}]) *getregtype()*
|
|
|
2323 The result is a String, which is type of register {regname}.
|
|
|
2324 The value will be one of:
|
|
|
2325 "v" for |characterwise| text
|
|
|
2326 "V" for |linewise| text
|
|
|
2327 "<CTRL-V>{width}" for |blockwise-visual| text
|
|
|
2328 0 for an empty or unknown register
|
|
|
2329 <CTRL-V> is one character with value 0x16.
|
|
|
2330 If {regname} is not specified, |v:register| is used.
|
|
|
2331
|
|
82
|
2332
|
|
7
|
2333 *getwinposx()*
|
|
|
2334 getwinposx() The result is a Number, which is the X coordinate in pixels of
|
|
|
2335 the left hand side of the GUI Vim window. The result will be
|
|
|
2336 -1 if the information is not available.
|
|
|
2337
|
|
|
2338 *getwinposy()*
|
|
|
2339 getwinposy() The result is a Number, which is the Y coordinate in pixels of
|
|
|
2340 the top of the GUI Vim window. The result will be -1 if the
|
|
|
2341 information is not available.
|
|
|
2342
|
|
|
2343 getwinvar({nr}, {varname}) *getwinvar()*
|
|
|
2344 The result is the value of option or local window variable
|
|
|
2345 {varname} in window {nr}.
|
|
|
2346 This also works for a global or local buffer option, but it
|
|
|
2347 doesn't work for a global or local buffer variable.
|
|
|
2348 Note that the name without "w:" must be used.
|
|
|
2349 Examples: >
|
|
|
2350 :let list_is_on = getwinvar(2, '&list')
|
|
|
2351 :echo "myvar = " . getwinvar(1, 'myvar')
|
|
|
2352 <
|
|
|
2353 *glob()*
|
|
|
2354 glob({expr}) Expand the file wildcards in {expr}. The result is a String.
|
|
|
2355 When there are several matches, they are separated by <NL>
|
|
|
2356 characters.
|
|
|
2357 If the expansion fails, the result is an empty string.
|
|
|
2358 A name for a non-existing file is not included.
|
|
|
2359
|
|
|
2360 For most systems backticks can be used to get files names from
|
|
|
2361 any external command. Example: >
|
|
|
2362 :let tagfiles = glob("`find . -name tags -print`")
|
|
|
2363 :let &tags = substitute(tagfiles, "\n", ",", "g")
|
|
|
2364 < The result of the program inside the backticks should be one
|
|
|
2365 item per line. Spaces inside an item are allowed.
|
|
|
2366
|
|
|
2367 See |expand()| for expanding special Vim variables. See
|
|
|
2368 |system()| for getting the raw output of an external command.
|
|
|
2369
|
|
|
2370 globpath({path}, {expr}) *globpath()*
|
|
|
2371 Perform glob() on all directories in {path} and concatenate
|
|
|
2372 the results. Example: >
|
|
|
2373 :echo globpath(&rtp, "syntax/c.vim")
|
|
|
2374 < {path} is a comma-separated list of directory names. Each
|
|
|
2375 directory name is prepended to {expr} and expanded like with
|
|
|
2376 glob(). A path separator is inserted when needed.
|
|
|
2377 To add a comma inside a directory name escape it with a
|
|
|
2378 backslash. Note that on MS-Windows a directory may have a
|
|
|
2379 trailing backslash, remove it if you put a comma after it.
|
|
|
2380 If the expansion fails for one of the directories, there is no
|
|
|
2381 error message.
|
|
|
2382 The 'wildignore' option applies: Names matching one of the
|
|
|
2383 patterns in 'wildignore' will be skipped.
|
|
|
2384
|
|
|
2385 *has()*
|
|
|
2386 has({feature}) The result is a Number, which is 1 if the feature {feature} is
|
|
|
2387 supported, zero otherwise. The {feature} argument is a
|
|
|
2388 string. See |feature-list| below.
|
|
|
2389 Also see |exists()|.
|
|
|
2390
|
|
|
2391 hasmapto({what} [, {mode}]) *hasmapto()*
|
|
|
2392 The result is a Number, which is 1 if there is a mapping that
|
|
|
2393 contains {what} in somewhere in the rhs (what it is mapped to)
|
|
|
2394 and this mapping exists in one of the modes indicated by
|
|
|
2395 {mode}.
|
|
|
2396 Both the global mappings and the mappings local to the current
|
|
|
2397 buffer are checked for a match.
|
|
|
2398 If no matching mapping is found 0 is returned.
|
|
|
2399 The following characters are recognized in {mode}:
|
|
|
2400 n Normal mode
|
|
|
2401 v Visual mode
|
|
|
2402 o Operator-pending mode
|
|
|
2403 i Insert mode
|
|
|
2404 l Language-Argument ("r", "f", "t", etc.)
|
|
|
2405 c Command-line mode
|
|
|
2406 When {mode} is omitted, "nvo" is used.
|
|
|
2407
|
|
|
2408 This function is useful to check if a mapping already exists
|
|
|
2409 to a function in a Vim script. Example: >
|
|
|
2410 :if !hasmapto('\ABCdoit')
|
|
|
2411 : map <Leader>d \ABCdoit
|
|
|
2412 :endif
|
|
|
2413 < This installs the mapping to "\ABCdoit" only if there isn't
|
|
|
2414 already a mapping to "\ABCdoit".
|
|
|
2415
|
|
|
2416 histadd({history}, {item}) *histadd()*
|
|
|
2417 Add the String {item} to the history {history} which can be
|
|
|
2418 one of: *hist-names*
|
|
|
2419 "cmd" or ":" command line history
|
|
|
2420 "search" or "/" search pattern history
|
|
|
2421 "expr" or "=" typed expression history
|
|
|
2422 "input" or "@" input line history
|
|
|
2423 If {item} does already exist in the history, it will be
|
|
|
2424 shifted to become the newest entry.
|
|
|
2425 The result is a Number: 1 if the operation was successful,
|
|
|
2426 otherwise 0 is returned.
|
|
|
2427
|
|
|
2428 Example: >
|
|
|
2429 :call histadd("input", strftime("%Y %b %d"))
|
|
|
2430 :let date=input("Enter date: ")
|
|
|
2431 < This function is not available in the |sandbox|.
|
|
|
2432
|
|
|
2433 histdel({history} [, {item}]) *histdel()*
|
|
|
2434 Clear {history}, ie. delete all its entries. See |hist-names|
|
|
|
2435 for the possible values of {history}.
|
|
|
2436
|
|
|
2437 If the parameter {item} is given as String, this is seen
|
|
|
2438 as regular expression. All entries matching that expression
|
|
|
2439 will be removed from the history (if there are any).
|
|
|
2440 Upper/lowercase must match, unless "\c" is used |/\c|.
|
|
|
2441 If {item} is a Number, it will be interpreted as index, see
|
|
|
2442 |:history-indexing|. The respective entry will be removed
|
|
|
2443 if it exists.
|
|
|
2444
|
|
|
2445 The result is a Number: 1 for a successful operation,
|
|
|
2446 otherwise 0 is returned.
|
|
|
2447
|
|
|
2448 Examples:
|
|
|
2449 Clear expression register history: >
|
|
|
2450 :call histdel("expr")
|
|
|
2451 <
|
|
|
2452 Remove all entries starting with "*" from the search history: >
|
|
|
2453 :call histdel("/", '^\*')
|
|
|
2454 <
|
|
|
2455 The following three are equivalent: >
|
|
|
2456 :call histdel("search", histnr("search"))
|
|
|
2457 :call histdel("search", -1)
|
|
|
2458 :call histdel("search", '^'.histget("search", -1).'$')
|
|
|
2459 <
|
|
|
2460 To delete the last search pattern and use the last-but-one for
|
|
|
2461 the "n" command and 'hlsearch': >
|
|
|
2462 :call histdel("search", -1)
|
|
|
2463 :let @/ = histget("search", -1)
|
|
|
2464
|
|
|
2465 histget({history} [, {index}]) *histget()*
|
|
|
2466 The result is a String, the entry with Number {index} from
|
|
|
2467 {history}. See |hist-names| for the possible values of
|
|
|
2468 {history}, and |:history-indexing| for {index}. If there is
|
|
|
2469 no such entry, an empty String is returned. When {index} is
|
|
|
2470 omitted, the most recent item from the history is used.
|
|
|
2471
|
|
|
2472 Examples:
|
|
|
2473 Redo the second last search from history. >
|
|
|
2474 :execute '/' . histget("search", -2)
|
|
|
2475
|
|
|
2476 < Define an Ex command ":H {num}" that supports re-execution of
|
|
|
2477 the {num}th entry from the output of |:history|. >
|
|
|
2478 :command -nargs=1 H execute histget("cmd", 0+<args>)
|
|
|
2479 <
|
|
|
2480 histnr({history}) *histnr()*
|
|
|
2481 The result is the Number of the current entry in {history}.
|
|
|
2482 See |hist-names| for the possible values of {history}.
|
|
|
2483 If an error occurred, -1 is returned.
|
|
|
2484
|
|
|
2485 Example: >
|
|
|
2486 :let inp_index = histnr("expr")
|
|
|
2487 <
|
|
|
2488 hlexists({name}) *hlexists()*
|
|
|
2489 The result is a Number, which is non-zero if a highlight group
|
|
|
2490 called {name} exists. This is when the group has been
|
|
|
2491 defined in some way. Not necessarily when highlighting has
|
|
|
2492 been defined for it, it may also have been used for a syntax
|
|
|
2493 item.
|
|
|
2494 *highlight_exists()*
|
|
|
2495 Obsolete name: highlight_exists().
|
|
|
2496
|
|
|
2497 *hlID()*
|
|
|
2498 hlID({name}) The result is a Number, which is the ID of the highlight group
|
|
|
2499 with name {name}. When the highlight group doesn't exist,
|
|
|
2500 zero is returned.
|
|
|
2501 This can be used to retrieve information about the highlight
|
|
|
2502 group. For example, to get the background color of the
|
|
|
2503 "Comment" group: >
|
|
|
2504 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
|
|
|
2505 < *highlightID()*
|
|
|
2506 Obsolete name: highlightID().
|
|
|
2507
|
|
|
2508 hostname() *hostname()*
|
|
|
2509 The result is a String, which is the name of the machine on
|
|
|
2510 which Vim is currently running. Machine names greater than
|
|
|
2511 256 characters long are truncated.
|
|
|
2512
|
|
|
2513 iconv({expr}, {from}, {to}) *iconv()*
|
|
|
2514 The result is a String, which is the text {expr} converted
|
|
|
2515 from encoding {from} to encoding {to}.
|
|
|
2516 When the conversion fails an empty string is returned.
|
|
|
2517 The encoding names are whatever the iconv() library function
|
|
|
2518 can accept, see ":!man 3 iconv".
|
|
|
2519 Most conversions require Vim to be compiled with the |+iconv|
|
|
|
2520 feature. Otherwise only UTF-8 to latin1 conversion and back
|
|
|
2521 can be done.
|
|
|
2522 This can be used to display messages with special characters,
|
|
|
2523 no matter what 'encoding' is set to. Write the message in
|
|
|
2524 UTF-8 and use: >
|
|
|
2525 echo iconv(utf8_str, "utf-8", &enc)
|
|
|
2526 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
|
|
|
2527 from/to UCS-2 is automatically changed to use UTF-8. You
|
|
|
2528 cannot use UCS-2 in a string anyway, because of the NUL bytes.
|
|
|
2529 {only available when compiled with the +multi_byte feature}
|
|
|
2530
|
|
|
2531 *indent()*
|
|
|
2532 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
|
|
|
2533 current buffer. The indent is counted in spaces, the value
|
|
|
2534 of 'tabstop' is relevant. {lnum} is used just like in
|
|
|
2535 |getline()|.
|
|
|
2536 When {lnum} is invalid -1 is returned.
|
|
|
2537
|
|
79
|
2538
|
|
95
|
2539 index({list}, {expr} [, {start} [, {ic}]]) *index()*
|
|
79
|
2540 Return the lowest index in List {list} where the item has a
|
|
|
2541 value equal to {expr}.
|
|
95
|
2542 If {start} is given then skip items with a lower index.
|
|
79
|
2543 When {ic} is given and it is non-zero, ignore case. Otherwise
|
|
|
2544 case must match.
|
|
|
2545 -1 is returned when {expr} is not found in {list}.
|
|
|
2546 Example: >
|
|
|
2547 :let idx = index(words, "the")
|
|
87
|
2548 :if index(numbers, 123) >= 0
|
|
79
|
2549
|
|
|
2550
|
|
7
|
2551 input({prompt} [, {text}]) *input()*
|
|
|
2552 The result is a String, which is whatever the user typed on
|
|
|
2553 the command-line. The parameter is either a prompt string, or
|
|
|
2554 a blank string (for no prompt). A '\n' can be used in the
|
|
|
2555 prompt to start a new line. The highlighting set with
|
|
|
2556 |:echohl| is used for the prompt. The input is entered just
|
|
|
2557 like a command-line, with the same editing commands and
|
|
|
2558 mappings. There is a separate history for lines typed for
|
|
|
2559 input().
|
|
|
2560 If the optional {text} is present, this is used for the
|
|
|
2561 default reply, as if the user typed this.
|
|
|
2562 NOTE: This must not be used in a startup file, for the
|
|
|
2563 versions that only run in GUI mode (e.g., the Win32 GUI).
|
|
|
2564 Note: When input() is called from within a mapping it will
|
|
|
2565 consume remaining characters from that mapping, because a
|
|
|
2566 mapping is handled like the characters were typed.
|
|
|
2567 Use |inputsave()| before input() and |inputrestore()|
|
|
|
2568 after input() to avoid that. Another solution is to avoid
|
|
|
2569 that further characters follow in the mapping, e.g., by using
|
|
|
2570 |:execute| or |:normal|.
|
|
|
2571
|
|
|
2572 Example: >
|
|
|
2573 :if input("Coffee or beer? ") == "beer"
|
|
|
2574 : echo "Cheers!"
|
|
|
2575 :endif
|
|
|
2576 < Example with default text: >
|
|
|
2577 :let color = input("Color? ", "white")
|
|
|
2578 < Example with a mapping: >
|
|
|
2579 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
|
|
|
2580 :function GetFoo()
|
|
|
2581 : call inputsave()
|
|
|
2582 : let g:Foo = input("enter search pattern: ")
|
|
|
2583 : call inputrestore()
|
|
|
2584 :endfunction
|
|
|
2585
|
|
|
2586 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
|
|
|
2587 Like input(), but when the GUI is running and text dialogs are
|
|
|
2588 supported, a dialog window pops up to input the text.
|
|
|
2589 Example: >
|
|
|
2590 :let n = inputdialog("value for shiftwidth", &sw)
|
|
|
2591 :if n != ""
|
|
|
2592 : let &sw = n
|
|
|
2593 :endif
|
|
|
2594 < When the dialog is cancelled {cancelreturn} is returned. When
|
|
|
2595 omitted an empty string is returned.
|
|
|
2596 Hitting <Enter> works like pressing the OK button. Hitting
|
|
|
2597 <Esc> works like pressing the Cancel button.
|
|
|
2598
|
|
|
2599 inputrestore() *inputrestore()*
|
|
|
2600 Restore typeahead that was saved with a previous inputsave().
|
|
|
2601 Should be called the same number of times inputsave() is
|
|
|
2602 called. Calling it more often is harmless though.
|
|
|
2603 Returns 1 when there is nothing to restore, 0 otherwise.
|
|
|
2604
|
|
|
2605 inputsave() *inputsave()*
|
|
|
2606 Preserve typeahead (also from mappings) and clear it, so that
|
|
|
2607 a following prompt gets input from the user. Should be
|
|
|
2608 followed by a matching inputrestore() after the prompt. Can
|
|
|
2609 be used several times, in which case there must be just as
|
|
|
2610 many inputrestore() calls.
|
|
|
2611 Returns 1 when out of memory, 0 otherwise.
|
|
|
2612
|
|
|
2613 inputsecret({prompt} [, {text}]) *inputsecret()*
|
|
|
2614 This function acts much like the |input()| function with but
|
|
|
2615 two exceptions:
|
|
|
2616 a) the user's response will be displayed as a sequence of
|
|
|
2617 asterisks ("*") thereby keeping the entry secret, and
|
|
|
2618 b) the user's response will not be recorded on the input
|
|
|
2619 |history| stack.
|
|
|
2620 The result is a String, which is whatever the user actually
|
|
|
2621 typed on the command-line in response to the issued prompt.
|
|
|
2622
|
|
55
|
2623 insert({list}, {item} [, {idx}]) *insert()*
|
|
|
2624 Insert {item} at the start of List {list}.
|
|
|
2625 If {idx} is specified insert {item} before the item with index
|
|
|
2626 {idx}. If {idx} is zero it goes before the first item, just
|
|
|
2627 like omitting {idx}. A negative {idx} is also possible, see
|
|
|
2628 |list-index|. -1 inserts just before the last item.
|
|
|
2629 Returns the resulting List. Examples: >
|
|
|
2630 :let mylist = insert([2, 3, 5], 1)
|
|
|
2631 :call insert(mylist, 4, -1)
|
|
|
2632 :call insert(mylist, 6, len(mylist))
|
|
82
|
2633 < The last example can be done simpler with |add()|.
|
|
55
|
2634 Note that when {item} is a List it is inserted as a single
|
|
|
2635 item. Use |extend()| to concatenate Lists.
|
|
|
2636
|
|
7
|
2637 isdirectory({directory}) *isdirectory()*
|
|
|
2638 The result is a Number, which is non-zero when a directory
|
|
|
2639 with the name {directory} exists. If {directory} doesn't
|
|
|
2640 exist, or isn't a directory, the result is FALSE. {directory}
|
|
|
2641 is any expression, which is used as a String.
|
|
|
2642
|
|
95
|
2643
|
|
|
2644 join({list} [, {sep}]) *join()*
|
|
|
2645 Join the items in {list} together into one String.
|
|
|
2646 When {sep} is specified it is put in between the items. If
|
|
|
2647 {sep} is omitted a single space is used.
|
|
|
2648 Note that {sep} is not added at the end. You might want to
|
|
|
2649 add it there too: >
|
|
|
2650 let lines = join(mylist, "\n") . "\n"
|
|
|
2651 < String items are used as-is. Lists and Dictionaries are
|
|
|
2652 converted into a string like with |string()|.
|
|
|
2653 The opposite function is |split()|.
|
|
|
2654
|
|
99
|
2655 keys({dict}) *keys()*
|
|
|
2656 Return a List with all the keys of {dict}. The List is in
|
|
|
2657 arbitrary order.
|
|
|
2658
|
|
85
|
2659 *len()* *E701*
|
|
55
|
2660 len({expr}) The result is a Number, which is the length of the argument.
|
|
|
2661 When {expr} is a String or a Number the length in bytes is
|
|
|
2662 used, as with |strlen()|.
|
|
|
2663 When {expr} is a List the number of items in the List is
|
|
|
2664 returned.
|
|
|
2665 Otherwise an error is given.
|
|
|
2666
|
|
7
|
2667 *libcall()* *E364* *E368*
|
|
|
2668 libcall({libname}, {funcname}, {argument})
|
|
|
2669 Call function {funcname} in the run-time library {libname}
|
|
|
2670 with single argument {argument}.
|
|
|
2671 This is useful to call functions in a library that you
|
|
|
2672 especially made to be used with Vim. Since only one argument
|
|
|
2673 is possible, calling standard library functions is rather
|
|
|
2674 limited.
|
|
|
2675 The result is the String returned by the function. If the
|
|
|
2676 function returns NULL, this will appear as an empty string ""
|
|
|
2677 to Vim.
|
|
|
2678 If the function returns a number, use libcallnr()!
|
|
|
2679 If {argument} is a number, it is passed to the function as an
|
|
|
2680 int; if {argument} is a string, it is passed as a
|
|
|
2681 null-terminated string.
|
|
|
2682 This function will fail in |restricted-mode|.
|
|
|
2683
|
|
|
2684 libcall() allows you to write your own 'plug-in' extensions to
|
|
|
2685 Vim without having to recompile the program. It is NOT a
|
|
|
2686 means to call system functions! If you try to do so Vim will
|
|
|
2687 very probably crash.
|
|
|
2688
|
|
|
2689 For Win32, the functions you write must be placed in a DLL
|
|
|
2690 and use the normal C calling convention (NOT Pascal which is
|
|
|
2691 used in Windows System DLLs). The function must take exactly
|
|
|
2692 one parameter, either a character pointer or a long integer,
|
|
|
2693 and must return a character pointer or NULL. The character
|
|
|
2694 pointer returned must point to memory that will remain valid
|
|
|
2695 after the function has returned (e.g. in static data in the
|
|
|
2696 DLL). If it points to allocated memory, that memory will
|
|
|
2697 leak away. Using a static buffer in the function should work,
|
|
|
2698 it's then freed when the DLL is unloaded.
|
|
|
2699
|
|
|
2700 WARNING: If the function returns a non-valid pointer, Vim may
|
|
|
2701 crash! This also happens if the function returns a number,
|
|
|
2702 because Vim thinks it's a pointer.
|
|
|
2703 For Win32 systems, {libname} should be the filename of the DLL
|
|
|
2704 without the ".DLL" suffix. A full path is only required if
|
|
|
2705 the DLL is not in the usual places.
|
|
|
2706 For Unix: When compiling your own plugins, remember that the
|
|
|
2707 object code must be compiled as position-independent ('PIC').
|
|
|
2708 {only in Win32 on some Unix versions, when the |+libcall|
|
|
|
2709 feature is present}
|
|
|
2710 Examples: >
|
|
|
2711 :echo libcall("libc.so", "getenv", "HOME")
|
|
|
2712 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
|
|
|
2713 <
|
|
|
2714 *libcallnr()*
|
|
|
2715 libcallnr({libname}, {funcname}, {argument})
|
|
|
2716 Just like libcall(), but used for a function that returns an
|
|
|
2717 int instead of a string.
|
|
|
2718 {only in Win32 on some Unix versions, when the |+libcall|
|
|
|
2719 feature is present}
|
|
|
2720 Example (not very useful...): >
|
|
|
2721 :call libcallnr("libc.so", "printf", "Hello World!\n")
|
|
|
2722 :call libcallnr("libc.so", "sleep", 10)
|
|
|
2723 <
|
|
|
2724 *line()*
|
|
|
2725 line({expr}) The result is a Number, which is the line number of the file
|
|
|
2726 position given with {expr}. The accepted positions are:
|
|
|
2727 . the cursor position
|
|
|
2728 $ the last line in the current buffer
|
|
|
2729 'x position of mark x (if the mark is not set, 0 is
|
|
|
2730 returned)
|
|
|
2731 Note that only marks in the current file can be used.
|
|
|
2732 Examples: >
|
|
|
2733 line(".") line number of the cursor
|
|
|
2734 line("'t") line number of mark t
|
|
|
2735 line("'" . marker) line number of mark marker
|
|
|
2736 < *last-position-jump*
|
|
|
2737 This autocommand jumps to the last known position in a file
|
|
|
2738 just after opening it, if the '" mark is set: >
|
|
|
2739 :au BufReadPost * if line("'\"") > 0 && line("'\"") <= line("$") | exe "normal g'\"" | endif
|
|
9
|
2740
|
|
7
|
2741 line2byte({lnum}) *line2byte()*
|
|
|
2742 Return the byte count from the start of the buffer for line
|
|
|
2743 {lnum}. This includes the end-of-line character, depending on
|
|
|
2744 the 'fileformat' option for the current buffer. The first
|
|
|
2745 line returns 1.
|
|
|
2746 This can also be used to get the byte count for the line just
|
|
|
2747 below the last line: >
|
|
|
2748 line2byte(line("$") + 1)
|
|
|
2749 < This is the file size plus one.
|
|
|
2750 When {lnum} is invalid, or the |+byte_offset| feature has been
|
|
|
2751 disabled at compile time, -1 is returned.
|
|
|
2752 Also see |byte2line()|, |go| and |:goto|.
|
|
|
2753
|
|
|
2754 lispindent({lnum}) *lispindent()*
|
|
|
2755 Get the amount of indent for line {lnum} according the lisp
|
|
|
2756 indenting rules, as with 'lisp'.
|
|
|
2757 The indent is counted in spaces, the value of 'tabstop' is
|
|
|
2758 relevant. {lnum} is used just like in |getline()|.
|
|
|
2759 When {lnum} is invalid or Vim was not compiled the
|
|
|
2760 |+lispindent| feature, -1 is returned.
|
|
|
2761
|
|
|
2762 localtime() *localtime()*
|
|
|
2763 Return the current time, measured as seconds since 1st Jan
|
|
|
2764 1970. See also |strftime()| and |getftime()|.
|
|
|
2765
|
|
95
|
2766
|
|
|
2767 map({list}, {expr}) *map()*
|
|
|
2768 Replace each item in {list} with the result of evaluating
|
|
|
2769 {expr}.
|
|
|
2770 Inside {expr} the symbol "&" stands for the existing
|
|
|
2771 item. Example: >
|
|
99
|
2772 :call map(mylist, '"> " . & . " <"')
|
|
95
|
2773 < This puts "> " before and " <" after each item in "mylist".
|
|
|
2774 Note that {expr} is an expression that evaluates to an
|
|
99
|
2775 expression. Often it is good to use a |literal-string| to
|
|
|
2776 avoid having to double backslashes.
|
|
95
|
2777 The operation is done in-place. If you want a list to remain
|
|
|
2778 unmodified make a copy first: >
|
|
99
|
2779 :let tlist = map(copy(mylist), ' & . "\t"')
|
|
95
|
2780 < Returns {list}.
|
|
|
2781
|
|
|
2782
|
|
7
|
2783 maparg({name}[, {mode}]) *maparg()*
|
|
|
2784 Return the rhs of mapping {name} in mode {mode}. When there
|
|
|
2785 is no mapping for {name}, an empty String is returned.
|
|
|
2786 These characters can be used for {mode}:
|
|
|
2787 "n" Normal
|
|
|
2788 "v" Visual
|
|
|
2789 "o" Operator-pending
|
|
|
2790 "i" Insert
|
|
|
2791 "c" Cmd-line
|
|
|
2792 "l" langmap |language-mapping|
|
|
|
2793 "" Normal, Visual and Operator-pending
|
|
|
2794 When {mode} is omitted, the modes from "" are used.
|
|
|
2795 The {name} can have special key names, like in the ":map"
|
|
|
2796 command. The returned String has special characters
|
|
|
2797 translated like in the output of the ":map" command listing.
|
|
|
2798 The mappings local to the current buffer are checked first,
|
|
|
2799 then the global mappings.
|
|
|
2800
|
|
|
2801 mapcheck({name}[, {mode}]) *mapcheck()*
|
|
|
2802 Check if there is a mapping that matches with {name} in mode
|
|
|
2803 {mode}. See |maparg()| for {mode} and special names in
|
|
|
2804 {name}.
|
|
|
2805 A match happens with a mapping that starts with {name} and
|
|
|
2806 with a mapping which is equal to the start of {name}.
|
|
|
2807
|
|
|
2808 matches mapping "a" "ab" "abc" ~
|
|
|
2809 mapcheck("a") yes yes yes
|
|
|
2810 mapcheck("abc") yes yes yes
|
|
|
2811 mapcheck("ax") yes no no
|
|
|
2812 mapcheck("b") no no no
|
|
|
2813
|
|
|
2814 The difference with maparg() is that mapcheck() finds a
|
|
|
2815 mapping that matches with {name}, while maparg() only finds a
|
|
|
2816 mapping for {name} exactly.
|
|
|
2817 When there is no mapping that starts with {name}, an empty
|
|
|
2818 String is returned. If there is one, the rhs of that mapping
|
|
|
2819 is returned. If there are several mappings that start with
|
|
|
2820 {name}, the rhs of one of them is returned.
|
|
|
2821 The mappings local to the current buffer are checked first,
|
|
|
2822 then the global mappings.
|
|
|
2823 This function can be used to check if a mapping can be added
|
|
|
2824 without being ambiguous. Example: >
|
|
|
2825 :if mapcheck("_vv") == ""
|
|
|
2826 : map _vv :set guifont=7x13<CR>
|
|
|
2827 :endif
|
|
|
2828 < This avoids adding the "_vv" mapping when there already is a
|
|
|
2829 mapping for "_v" or for "_vvv".
|
|
|
2830
|
|
19
|
2831 match({expr}, {pat}[, {start}[, {count}]]) *match()*
|
|
95
|
2832 When {expr} is a List then this returns the index of the first
|
|
|
2833 item where {pat} matches. Each item is used as a String,
|
|
|
2834 Lists and Dictionaries are used as echoed.
|
|
|
2835 Otherwise, {expr} is used as a String. The result is a
|
|
|
2836 Number, which gives the index (byte offset) in {expr} where
|
|
|
2837 {pat} matches.
|
|
|
2838 A match at the first character or List item returns zero.
|
|
19
|
2839 If there is no match -1 is returned.
|
|
|
2840 Example: >
|
|
95
|
2841 :echo match("testing", "ing") " results in 4
|
|
|
2842 :echo match([1, 'x'], '\a') " results in 2
|
|
|
2843 < See |string-match| for how {pat} is used.
|
|
|
2844
|
|
19
|
2845 When {count} is given use the {count}'th match. When a match
|
|
95
|
2846 is found in a String the search for the next one starts on
|
|
|
2847 character further. Thus this example results in 1: >
|
|
19
|
2848 echo match("testing", "..", 0, 2)
|
|
95
|
2849 < In a List the search continues in the next item.
|
|
|
2850
|
|
|
2851 If {start} is given, the search starts from byte index
|
|
|
2852 {start} in a String or item {start} in a List.
|
|
7
|
2853 The result, however, is still the index counted from the
|
|
95
|
2854 first character/item. Example: >
|
|
7
|
2855 :echo match("testing", "ing", 2)
|
|
|
2856 < result is again "4". >
|
|
|
2857 :echo match("testing", "ing", 4)
|
|
|
2858 < result is again "4". >
|
|
|
2859 :echo match("testing", "t", 2)
|
|
|
2860 < result is "3".
|
|
95
|
2861 For a String, if {start} < 0, it will be set to 0. For a list
|
|
|
2862 the index is counted from the end.
|
|
|
2863 If {start} is out of range (> strlen({expr} for a String or
|
|
|
2864 > len({expr} for a List) -1 is returned.
|
|
|
2865
|
|
7
|
2866 See |pattern| for the patterns that are accepted.
|
|
|
2867 The 'ignorecase' option is used to set the ignore-caseness of
|
|
|
2868 the pattern. 'smartcase' is NOT used. The matching is always
|
|
|
2869 done like 'magic' is set and 'cpoptions' is empty.
|
|
|
2870
|
|
19
|
2871 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
|
|
7
|
2872 Same as match(), but return the index of first character after
|
|
|
2873 the match. Example: >
|
|
|
2874 :echo matchend("testing", "ing")
|
|
|
2875 < results in "7".
|
|
|
2876 The {start}, if given, has the same meaning as for match(). >
|
|
|
2877 :echo matchend("testing", "ing", 2)
|
|
|
2878 < results in "7". >
|
|
|
2879 :echo matchend("testing", "ing", 5)
|
|
|
2880 < result is "-1".
|
|
95
|
2881 When {expr} is a List the result is equal to match().
|
|
7
|
2882
|
|
19
|
2883 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
|
|
7
|
2884 Same as match(), but return the matched string. Example: >
|
|
|
2885 :echo matchstr("testing", "ing")
|
|
|
2886 < results in "ing".
|
|
|
2887 When there is no match "" is returned.
|
|
|
2888 The {start}, if given, has the same meaning as for match(). >
|
|
|
2889 :echo matchstr("testing", "ing", 2)
|
|
|
2890 < results in "ing". >
|
|
|
2891 :echo matchstr("testing", "ing", 5)
|
|
|
2892 < result is "".
|
|
95
|
2893 When {expr} is a List then the matching item is returned.
|
|
|
2894 The type isn't changed, it's not necessarily a String.
|
|
7
|
2895
|
|
87
|
2896 *max()*
|
|
|
2897 max({list}) Return the maximum value of all items in {list}.
|
|
|
2898 If {list} is not a list or one of the items in {list} cannot
|
|
|
2899 be used as a Number this results in an error.
|
|
|
2900 An empty List results in zero.
|
|
|
2901
|
|
|
2902 *min()*
|
|
|
2903 min({list}) Return the minumum value of all items in {list}.
|
|
|
2904 If {list} is not a list or one of the items in {list} cannot
|
|
|
2905 be used as a Number this results in an error.
|
|
|
2906 An empty List results in zero.
|
|
|
2907
|
|
7
|
2908 *mode()*
|
|
|
2909 mode() Return a string that indicates the current mode:
|
|
|
2910 n Normal
|
|
|
2911 v Visual by character
|
|
|
2912 V Visual by line
|
|
|
2913 CTRL-V Visual blockwise
|
|
|
2914 s Select by character
|
|
|
2915 S Select by line
|
|
|
2916 CTRL-S Select blockwise
|
|
|
2917 i Insert
|
|
|
2918 R Replace
|
|
|
2919 c Command-line
|
|
|
2920 r Hit-enter prompt
|
|
|
2921 This is useful in the 'statusline' option. In most other
|
|
|
2922 places it always returns "c" or "n".
|
|
|
2923
|
|
|
2924 nextnonblank({lnum}) *nextnonblank()*
|
|
|
2925 Return the line number of the first line at or below {lnum}
|
|
|
2926 that is not blank. Example: >
|
|
|
2927 if getline(nextnonblank(1)) =~ "Java"
|
|
|
2928 < When {lnum} is invalid or there is no non-blank line at or
|
|
|
2929 below it, zero is returned.
|
|
|
2930 See also |prevnonblank()|.
|
|
|
2931
|
|
|
2932 nr2char({expr}) *nr2char()*
|
|
|
2933 Return a string with a single character, which has the number
|
|
|
2934 value {expr}. Examples: >
|
|
|
2935 nr2char(64) returns "@"
|
|
|
2936 nr2char(32) returns " "
|
|
|
2937 < The current 'encoding' is used. Example for "utf-8": >
|
|
|
2938 nr2char(300) returns I with bow character
|
|
|
2939 < Note that a NUL character in the file is specified with
|
|
|
2940 nr2char(10), because NULs are represented with newline
|
|
|
2941 characters. nr2char(0) is a real NUL and terminates the
|
|
|
2942 string, thus isn't very useful.
|
|
|
2943
|
|
|
2944 prevnonblank({lnum}) *prevnonblank()*
|
|
|
2945 Return the line number of the first line at or above {lnum}
|
|
|
2946 that is not blank. Example: >
|
|
|
2947 let ind = indent(prevnonblank(v:lnum - 1))
|
|
|
2948 < When {lnum} is invalid or there is no non-blank line at or
|
|
|
2949 above it, zero is returned.
|
|
|
2950 Also see |nextnonblank()|.
|
|
|
2951
|
|
99
|
2952 range({expr} [, {max} [, {stride}]]) *range()*
|
|
|
2953 Returns a List with Numbers:
|
|
|
2954 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
|
|
|
2955 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
|
|
|
2956 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
|
|
|
2957 {max}] (increasing {expr} with {stride} each time, not
|
|
|
2958 producing a value past {max}).
|
|
|
2959 Examples: >
|
|
|
2960 range(4) " [0, 1, 2, 3]
|
|
|
2961 range(2, 4) " [2, 3, 4]
|
|
|
2962 range(2, 9, 3) " [2, 5, 8]
|
|
|
2963 range(2, -2, -1) " [2, 1, 0, -1, -2]
|
|
|
2964 <
|
|
7
|
2965 *remote_expr()* *E449*
|
|
|
2966 remote_expr({server}, {string} [, {idvar}])
|
|
|
2967 Send the {string} to {server}. The string is sent as an
|
|
|
2968 expression and the result is returned after evaluation.
|
|
|
2969 If {idvar} is present, it is taken as the name of a
|
|
|
2970 variable and a {serverid} for later use with
|
|
|
2971 remote_read() is stored there.
|
|
|
2972 See also |clientserver| |RemoteReply|.
|
|
|
2973 This function is not available in the |sandbox|.
|
|
|
2974 {only available when compiled with the |+clientserver| feature}
|
|
|
2975 Note: Any errors will cause a local error message to be issued
|
|
|
2976 and the result will be the empty string.
|
|
|
2977 Examples: >
|
|
|
2978 :echo remote_expr("gvim", "2+2")
|
|
|
2979 :echo remote_expr("gvim1", "b:current_syntax")
|
|
|
2980 <
|
|
|
2981
|
|
|
2982 remote_foreground({server}) *remote_foreground()*
|
|
|
2983 Move the Vim server with the name {server} to the foreground.
|
|
|
2984 This works like: >
|
|
|
2985 remote_expr({server}, "foreground()")
|
|
|
2986 < Except that on Win32 systems the client does the work, to work
|
|
|
2987 around the problem that the OS doesn't always allow the server
|
|
|
2988 to bring itself to the foreground.
|
|
|
2989 This function is not available in the |sandbox|.
|
|
|
2990 {only in the Win32, Athena, Motif and GTK GUI versions and the
|
|
|
2991 Win32 console version}
|
|
|
2992
|
|
|
2993
|
|
|
2994 remote_peek({serverid} [, {retvar}]) *remote_peek()*
|
|
|
2995 Returns a positive number if there are available strings
|
|
|
2996 from {serverid}. Copies any reply string into the variable
|
|
|
2997 {retvar} if specified. {retvar} must be a string with the
|
|
|
2998 name of a variable.
|
|
|
2999 Returns zero if none are available.
|
|
|
3000 Returns -1 if something is wrong.
|
|
|
3001 See also |clientserver|.
|
|
|
3002 This function is not available in the |sandbox|.
|
|
|
3003 {only available when compiled with the |+clientserver| feature}
|
|
|
3004 Examples: >
|
|
|
3005 :let repl = ""
|
|
|
3006 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
|
|
|
3007
|
|
|
3008 remote_read({serverid}) *remote_read()*
|
|
|
3009 Return the oldest available reply from {serverid} and consume
|
|
|
3010 it. It blocks until a reply is available.
|
|
|
3011 See also |clientserver|.
|
|
|
3012 This function is not available in the |sandbox|.
|
|
|
3013 {only available when compiled with the |+clientserver| feature}
|
|
|
3014 Example: >
|
|
|
3015 :echo remote_read(id)
|
|
|
3016 <
|
|
|
3017 *remote_send()* *E241*
|
|
|
3018 remote_send({server}, {string} [, {idvar}])
|
|
22
|
3019 Send the {string} to {server}. The string is sent as input
|
|
|
3020 keys and the function returns immediately. At the Vim server
|
|
|
3021 the keys are not mapped |:map|.
|
|
7
|
3022 If {idvar} is present, it is taken as the name of a
|
|
|
3023 variable and a {serverid} for later use with
|
|
|
3024 remote_read() is stored there.
|
|
|
3025 See also |clientserver| |RemoteReply|.
|
|
|
3026 This function is not available in the |sandbox|.
|
|
|
3027 {only available when compiled with the |+clientserver| feature}
|
|
|
3028 Note: Any errors will be reported in the server and may mess
|
|
|
3029 up the display.
|
|
|
3030 Examples: >
|
|
|
3031 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
|
|
|
3032 \ remote_read(serverid)
|
|
|
3033
|
|
|
3034 :autocmd NONE RemoteReply *
|
|
|
3035 \ echo remote_read(expand("<amatch>"))
|
|
|
3036 :echo remote_send("gvim", ":sleep 10 | echo ".
|
|
|
3037 \ 'server2client(expand("<client>"), "HELLO")<CR>')
|
|
82
|
3038 <
|
|
79
|
3039 remove({list}, {idx} [, {end}]) *remove()*
|
|
|
3040 Without {end}: Remove the item at {idx} from List {list} and
|
|
|
3041 return it.
|
|
|
3042 With {end}: Remove items from {idx} to {end} (inclusive) and
|
|
|
3043 return a list with these items. When {idx} points to the same
|
|
|
3044 item as {end} a list with one item is returned. When {end}
|
|
|
3045 points to an item before {idx} this is an error.
|
|
|
3046 See |list-index| for possible values of {idx} and {end}.
|
|
55
|
3047 Example: >
|
|
|
3048 :echo "last item: " . remove(mylist, -1)
|
|
79
|
3049 :call remove(mylist, 0, 9)
|
|
99
|
3050 remove({dict}, {key})
|
|
|
3051 Remove the entry from {dict} with key {key}. Example: >
|
|
|
3052 :echo "removed " . remove(dict, "one")
|
|
|
3053 < If there is no {key} in {dict} this is an error.
|
|
|
3054
|
|
|
3055 Use |delete()| to remove a file.
|
|
55
|
3056
|
|
7
|
3057 rename({from}, {to}) *rename()*
|
|
|
3058 Rename the file by the name {from} to the name {to}. This
|
|
|
3059 should also work to move files across file systems. The
|
|
|
3060 result is a Number, which is 0 if the file was renamed
|
|
|
3061 successfully, and non-zero when the renaming failed.
|
|
|
3062 This function is not available in the |sandbox|.
|
|
|
3063
|
|
18
|
3064 repeat({expr}, {count}) *repeat()*
|
|
|
3065 Repeat {expr} {count} times and return the concatenated
|
|
|
3066 result. Example: >
|
|
|
3067 :let seperator = repeat('-', 80)
|
|
|
3068 < When {count} is zero or negative the result is empty.
|
|
87
|
3069 When {expr} is a List the result is {expr} concatenated
|
|
79
|
3070 {count} times. Example: >
|
|
|
3071 :let longlist = repeat(['a', 'b'], 3)
|
|
|
3072 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
|
|
18
|
3073
|
|
82
|
3074
|
|
7
|
3075 resolve({filename}) *resolve()* *E655*
|
|
|
3076 On MS-Windows, when {filename} is a shortcut (a .lnk file),
|
|
|
3077 returns the path the shortcut points to in a simplified form.
|
|
|
3078 On Unix, repeat resolving symbolic links in all path
|
|
|
3079 components of {filename} and return the simplified result.
|
|
|
3080 To cope with link cycles, resolving of symbolic links is
|
|
|
3081 stopped after 100 iterations.
|
|
|
3082 On other systems, return the simplified {filename}.
|
|
|
3083 The simplification step is done as by |simplify()|.
|
|
|
3084 resolve() keeps a leading path component specifying the
|
|
|
3085 current directory (provided the result is still a relative
|
|
|
3086 path name) and also keeps a trailing path separator.
|
|
|
3087
|
|
82
|
3088 *reverse()*
|
|
|
3089 reverse({list}) Reverse the order of items in {list} in-place. Returns
|
|
|
3090 {list}.
|
|
|
3091 If you want a list to remain unmodified make a copy first: >
|
|
|
3092 :let revlist = reverse(copy(mylist))
|
|
|
3093
|
|
7
|
3094 search({pattern} [, {flags}]) *search()*
|
|
|
3095 Search for regexp pattern {pattern}. The search starts at the
|
|
|
3096 cursor position.
|
|
|
3097 {flags} is a String, which can contain these character flags:
|
|
|
3098 'b' search backward instead of forward
|
|
20
|
3099 'n' do Not move the cursor
|
|
7
|
3100 'w' wrap around the end of the file
|
|
|
3101 'W' don't wrap around the end of the file
|
|
|
3102 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
|
|
|
3103
|
|
20
|
3104 When a match has been found its line number is returned.
|
|
|
3105 The cursor will be positioned at the match, unless the 'n'
|
|
|
3106 flag is used).
|
|
|
3107 If there is no match a 0 is returned and the cursor doesn't
|
|
|
3108 move. No error message is given.
|
|
7
|
3109
|
|
|
3110 Example (goes over all files in the argument list): >
|
|
|
3111 :let n = 1
|
|
|
3112 :while n <= argc() " loop over all files in arglist
|
|
|
3113 : exe "argument " . n
|
|
|
3114 : " start at the last char in the file and wrap for the
|
|
|
3115 : " first search to find match at start of file
|
|
|
3116 : normal G$
|
|
|
3117 : let flags = "w"
|
|
|
3118 : while search("foo", flags) > 0
|
|
|
3119 : s/foo/bar/g
|
|
|
3120 : let flags = "W"
|
|
|
3121 : endwhile
|
|
|
3122 : update " write the file if modified
|
|
|
3123 : let n = n + 1
|
|
|
3124 :endwhile
|
|
|
3125 <
|
|
|
3126 *searchpair()*
|
|
|
3127 searchpair({start}, {middle}, {end} [, {flags} [, {skip}]])
|
|
|
3128 Search for the match of a nested start-end pair. This can be
|
|
|
3129 used to find the "endif" that matches an "if", while other
|
|
|
3130 if/endif pairs in between are ignored.
|
|
|
3131 The search starts at the cursor. If a match is found, the
|
|
|
3132 cursor is positioned at it and the line number is returned.
|
|
|
3133 If no match is found 0 or -1 is returned and the cursor
|
|
|
3134 doesn't move. No error message is given.
|
|
|
3135
|
|
|
3136 {start}, {middle} and {end} are patterns, see |pattern|. They
|
|
|
3137 must not contain \( \) pairs. Use of \%( \) is allowed. When
|
|
|
3138 {middle} is not empty, it is found when searching from either
|
|
|
3139 direction, but only when not in a nested start-end pair. A
|
|
|
3140 typical use is: >
|
|
|
3141 searchpair('\<if\>', '\<else\>', '\<endif\>')
|
|
|
3142 < By leaving {middle} empty the "else" is skipped.
|
|
|
3143
|
|
|
3144 {flags} are used like with |search()|. Additionally:
|
|
|
3145 'n' do Not move the cursor
|
|
|
3146 'r' Repeat until no more matches found; will find the
|
|
|
3147 outer pair
|
|
|
3148 'm' return number of Matches instead of line number with
|
|
|
3149 the match; will only be > 1 when 'r' is used.
|
|
|
3150
|
|
|
3151 When a match for {start}, {middle} or {end} is found, the
|
|
|
3152 {skip} expression is evaluated with the cursor positioned on
|
|
|
3153 the start of the match. It should return non-zero if this
|
|
|
3154 match is to be skipped. E.g., because it is inside a comment
|
|
|
3155 or a string.
|
|
|
3156 When {skip} is omitted or empty, every match is accepted.
|
|
|
3157 When evaluating {skip} causes an error the search is aborted
|
|
|
3158 and -1 returned.
|
|
|
3159
|
|
|
3160 The value of 'ignorecase' is used. 'magic' is ignored, the
|
|
|
3161 patterns are used like it's on.
|
|
|
3162
|
|
|
3163 The search starts exactly at the cursor. A match with
|
|
|
3164 {start}, {middle} or {end} at the next character, in the
|
|
|
3165 direction of searching, is the first one found. Example: >
|
|
|
3166 if 1
|
|
|
3167 if 2
|
|
|
3168 endif 2
|
|
|
3169 endif 1
|
|
|
3170 < When starting at the "if 2", with the cursor on the "i", and
|
|
|
3171 searching forwards, the "endif 2" is found. When starting on
|
|
|
3172 the character just before the "if 2", the "endif 1" will be
|
|
|
3173 found. That's because the "if 2" will be found first, and
|
|
|
3174 then this is considered to be a nested if/endif from "if 2" to
|
|
|
3175 "endif 2".
|
|
|
3176 When searching backwards and {end} is more than one character,
|
|
|
3177 it may be useful to put "\zs" at the end of the pattern, so
|
|
|
3178 that when the cursor is inside a match with the end it finds
|
|
|
3179 the matching start.
|
|
|
3180
|
|
|
3181 Example, to find the "endif" command in a Vim script: >
|
|
|
3182
|
|
|
3183 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
|
|
|
3184 \ 'getline(".") =~ "^\\s*\""')
|
|
|
3185
|
|
|
3186 < The cursor must be at or after the "if" for which a match is
|
|
|
3187 to be found. Note that single-quote strings are used to avoid
|
|
|
3188 having to double the backslashes. The skip expression only
|
|
|
3189 catches comments at the start of a line, not after a command.
|
|
|
3190 Also, a word "en" or "if" halfway a line is considered a
|
|
|
3191 match.
|
|
|
3192 Another example, to search for the matching "{" of a "}": >
|
|
|
3193
|
|
|
3194 :echo searchpair('{', '', '}', 'bW')
|
|
|
3195
|
|
|
3196 < This works when the cursor is at or before the "}" for which a
|
|
|
3197 match is to be found. To reject matches that syntax
|
|
|
3198 highlighting recognized as strings: >
|
|
|
3199
|
|
|
3200 :echo searchpair('{', '', '}', 'bW',
|
|
|
3201 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
|
|
|
3202 <
|
|
|
3203 server2client( {clientid}, {string}) *server2client()*
|
|
|
3204 Send a reply string to {clientid}. The most recent {clientid}
|
|
|
3205 that sent a string can be retrieved with expand("<client>").
|
|
|
3206 {only available when compiled with the |+clientserver| feature}
|
|
|
3207 Note:
|
|
|
3208 This id has to be stored before the next command can be
|
|
|
3209 received. Ie. before returning from the received command and
|
|
|
3210 before calling any commands that waits for input.
|
|
|
3211 See also |clientserver|.
|
|
|
3212 Example: >
|
|
|
3213 :echo server2client(expand("<client>"), "HELLO")
|
|
|
3214 <
|
|
|
3215 serverlist() *serverlist()*
|
|
|
3216 Return a list of available server names, one per line.
|
|
|
3217 When there are no servers or the information is not available
|
|
|
3218 an empty string is returned. See also |clientserver|.
|
|
|
3219 {only available when compiled with the |+clientserver| feature}
|
|
|
3220 Example: >
|
|
|
3221 :echo serverlist()
|
|
|
3222 <
|
|
|
3223 setbufvar({expr}, {varname}, {val}) *setbufvar()*
|
|
|
3224 Set option or local variable {varname} in buffer {expr} to
|
|
|
3225 {val}.
|
|
|
3226 This also works for a global or local window option, but it
|
|
|
3227 doesn't work for a global or local window variable.
|
|
|
3228 For a local window option the global value is unchanged.
|
|
|
3229 For the use of {expr}, see |bufname()| above.
|
|
|
3230 Note that the variable name without "b:" must be used.
|
|
|
3231 Examples: >
|
|
|
3232 :call setbufvar(1, "&mod", 1)
|
|
|
3233 :call setbufvar("todo", "myvar", "foobar")
|
|
|
3234 < This function is not available in the |sandbox|.
|
|
|
3235
|
|
|
3236 setcmdpos({pos}) *setcmdpos()*
|
|
|
3237 Set the cursor position in the command line to byte position
|
|
|
3238 {pos}. The first position is 1.
|
|
|
3239 Use |getcmdpos()| to obtain the current position.
|
|
|
3240 Only works while editing the command line, thus you must use
|
|
99
|
3241 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
|
|
|
3242 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
|
|
|
3243 set after the command line is set to the expression. For
|
|
|
3244 |c_CTRL-R_=| it is set after evaluating the expression but
|
|
|
3245 before inserting the resulting text.
|
|
7
|
3246 When the number is too big the cursor is put at the end of the
|
|
|
3247 line. A number smaller than one has undefined results.
|
|
|
3248 Returns 0 when successful, 1 when not editing the command
|
|
|
3249 line.
|
|
|
3250
|
|
|
3251 setline({lnum}, {line}) *setline()*
|
|
|
3252 Set line {lnum} of the current buffer to {line}. If this
|
|
|
3253 succeeds, 0 is returned. If this fails (most likely because
|
|
|
3254 {lnum} is invalid) 1 is returned. Example: >
|
|
|
3255 :call setline(5, strftime("%c"))
|
|
|
3256 < Note: The '[ and '] marks are not set.
|
|
|
3257
|
|
|
3258 *setreg()*
|
|
|
3259 setreg({regname}, {value} [,{options}])
|
|
|
3260 Set the register {regname} to {value}.
|
|
|
3261 If {options} contains "a" or {regname} is upper case,
|
|
|
3262 then the value is appended.
|
|
|
3263 {options} can also contains a register type specification:
|
|
|
3264 "c" or "v" |characterwise| mode
|
|
|
3265 "l" or "V" |linewise| mode
|
|
|
3266 "b" or "<CTRL-V>" |blockwise-visual| mode
|
|
|
3267 If a number immediately follows "b" or "<CTRL-V>" then this is
|
|
|
3268 used as the width of the selection - if it is not specified
|
|
|
3269 then the width of the block is set to the number of characters
|
|
|
3270 in the longest line (counting a <TAB> as 1 character).
|
|
|
3271
|
|
|
3272 If {options} contains no register settings, then the default
|
|
|
3273 is to use character mode unless {value} ends in a <NL>.
|
|
|
3274 Setting the '=' register is not possible.
|
|
|
3275 Returns zero for success, non-zero for failure.
|
|
|
3276
|
|
|
3277 Examples: >
|
|
|
3278 :call setreg(v:register, @*)
|
|
|
3279 :call setreg('*', @%, 'ac')
|
|
|
3280 :call setreg('a', "1\n2\n3", 'b5')
|
|
|
3281
|
|
|
3282 < This example shows using the functions to save and restore a
|
|
|
3283 register. >
|
|
|
3284 :let var_a = getreg('a')
|
|
|
3285 :let var_amode = getregtype('a')
|
|
|
3286 ....
|
|
|
3287 :call setreg('a', var_a, var_amode)
|
|
|
3288
|
|
|
3289 < You can also change the type of a register by appending
|
|
|
3290 nothing: >
|
|
|
3291 :call setreg('a', '', 'al')
|
|
|
3292
|
|
|
3293 setwinvar({nr}, {varname}, {val}) *setwinvar()*
|
|
|
3294 Set option or local variable {varname} in window {nr} to
|
|
|
3295 {val}.
|
|
|
3296 This also works for a global or local buffer option, but it
|
|
|
3297 doesn't work for a global or local buffer variable.
|
|
|
3298 For a local buffer option the global value is unchanged.
|
|
|
3299 Note that the variable name without "w:" must be used.
|
|
|
3300 Examples: >
|
|
|
3301 :call setwinvar(1, "&list", 0)
|
|
|
3302 :call setwinvar(2, "myvar", "foobar")
|
|
|
3303 < This function is not available in the |sandbox|.
|
|
|
3304
|
|
|
3305 simplify({filename}) *simplify()*
|
|
|
3306 Simplify the file name as much as possible without changing
|
|
|
3307 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
|
|
|
3308 Unix) are not resolved. If the first path component in
|
|
|
3309 {filename} designates the current directory, this will be
|
|
|
3310 valid for the result as well. A trailing path separator is
|
|
|
3311 not removed either.
|
|
|
3312 Example: >
|
|
|
3313 simplify("./dir/.././/file/") == "./file/"
|
|
|
3314 < Note: The combination "dir/.." is only removed if "dir" is
|
|
|
3315 a searchable directory or does not exist. On Unix, it is also
|
|
|
3316 removed when "dir" is a symbolic link within the same
|
|
|
3317 directory. In order to resolve all the involved symbolic
|
|
|
3318 links before simplifying the path name, use |resolve()|.
|
|
|
3319
|
|
82
|
3320
|
|
85
|
3321 sort({list} [, {func}]) *sort()* *E702*
|
|
82
|
3322 Sort the items in {list} in-place. Returns {list}. If you
|
|
|
3323 want a list to remain unmodified make a copy first: >
|
|
|
3324 :let sortedlist = sort(copy(mylist))
|
|
|
3325 < Uses the string representation of each item to sort on.
|
|
95
|
3326 Numbers sort after Strings, Lists after Numbers.
|
|
82
|
3327 When {func} is given and it is one then case is ignored.
|
|
|
3328 When {func} is a Funcref or a function name, this function is
|
|
|
3329 called to compare items. The function is invoked with two
|
|
|
3330 items as argument and must return zero if they are equal, 1 if
|
|
|
3331 the first one sorts after the second one, -1 if the first one
|
|
|
3332 sorts before the second one. Example: >
|
|
|
3333 func MyCompare(i1, i2)
|
|
|
3334 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
|
|
|
3335 endfunc
|
|
|
3336 let sortedlist = sort(mylist, "MyCompare")
|
|
|
3337
|
|
95
|
3338 split({expr} [, {pattern}]) *split()*
|
|
82
|
3339 Make a List out of {expr}. When {pattern} is omitted each
|
|
|
3340 white-separated sequence of characters becomes an item.
|
|
|
3341 Otherwise the string is split where {pattern} matches,
|
|
|
3342 removing the matched characters. Empty strings are omitted.
|
|
|
3343 Example: >
|
|
95
|
3344 :let words = split(getline('.'), '\W\+')
|
|
82
|
3345 < Since empty strings are not added the "\+" isn't required but
|
|
|
3346 it makes the function work a bit faster.
|
|
95
|
3347 The opposite function is |join()|.
|
|
82
|
3348
|
|
|
3349
|
|
7
|
3350 strftime({format} [, {time}]) *strftime()*
|
|
|
3351 The result is a String, which is a formatted date and time, as
|
|
|
3352 specified by the {format} string. The given {time} is used,
|
|
|
3353 or the current time if no time is given. The accepted
|
|
|
3354 {format} depends on your system, thus this is not portable!
|
|
|
3355 See the manual page of the C function strftime() for the
|
|
|
3356 format. The maximum length of the result is 80 characters.
|
|
|
3357 See also |localtime()| and |getftime()|.
|
|
|
3358 The language can be changed with the |:language| command.
|
|
|
3359 Examples: >
|
|
|
3360 :echo strftime("%c") Sun Apr 27 11:49:23 1997
|
|
|
3361 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
|
|
|
3362 :echo strftime("%y%m%d %T") 970427 11:53:55
|
|
|
3363 :echo strftime("%H:%M") 11:55
|
|
|
3364 :echo strftime("%c", getftime("file.c"))
|
|
|
3365 Show mod time of file.c.
|
|
82
|
3366 < Not available on all systems. To check use: >
|
|
|
3367 :if exists("*strftime")
|
|
|
3368
|
|
7
|
3369 stridx({haystack}, {needle}) *stridx()*
|
|
|
3370 The result is a Number, which gives the index in {haystack} of
|
|
|
3371 the first occurrence of the String {needle} in the String
|
|
|
3372 {haystack}. The search is done case-sensitive. For advanced
|
|
|
3373 searches use |match()|.
|
|
|
3374 If the {needle} does not occur in {haystack} it returns -1.
|
|
|
3375 See also |strridx()|. Examples: >
|
|
|
3376 :echo stridx("An Example", "Example") 3
|
|
|
3377 :echo stridx("Starting point", "Start") 0
|
|
|
3378 :echo stridx("Starting point", "start") -1
|
|
|
3379 <
|
|
55
|
3380 *string()*
|
|
95
|
3381 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
|
|
|
3382 String or a composition of them, then the result can be parsed
|
|
|
3383 back with |eval()|.
|
|
55
|
3384 {expr} type result ~
|
|
99
|
3385 String 'string'
|
|
95
|
3386 Number 123
|
|
99
|
3387 Funcref function('name')
|
|
95
|
3388 List [item, item]
|
|
99
|
3389 Note that in String values the ' character is doubled.
|
|
55
|
3390
|
|
7
|
3391 *strlen()*
|
|
|
3392 strlen({expr}) The result is a Number, which is the length of the String
|
|
|
3393 {expr} in bytes. If you want to count the number of
|
|
|
3394 multi-byte characters use something like this: >
|
|
|
3395
|
|
|
3396 :let len = strlen(substitute(str, ".", "x", "g"))
|
|
|
3397
|
|
|
3398 < Composing characters are not counted.
|
|
55
|
3399 If the argument is a Number it is first converted to a String.
|
|
|
3400 For other types an error is given.
|
|
|
3401 Also see |len()|.
|
|
7
|
3402
|
|
|
3403 strpart({src}, {start}[, {len}]) *strpart()*
|
|
|
3404 The result is a String, which is part of {src}, starting from
|
|
|
3405 byte {start}, with the length {len}.
|
|
|
3406 When non-existing bytes are included, this doesn't result in
|
|
|
3407 an error, the bytes are simply omitted.
|
|
|
3408 If {len} is missing, the copy continues from {start} till the
|
|
|
3409 end of the {src}. >
|
|
|
3410 strpart("abcdefg", 3, 2) == "de"
|
|
|
3411 strpart("abcdefg", -2, 4) == "ab"
|
|
|
3412 strpart("abcdefg", 5, 4) == "fg"
|
|
|
3413 strpart("abcdefg", 3) == "defg"
|
|
|
3414 < Note: To get the first character, {start} must be 0. For
|
|
|
3415 example, to get three bytes under and after the cursor: >
|
|
|
3416 strpart(getline(line(".")), col(".") - 1, 3)
|
|
|
3417 <
|
|
|
3418 strridx({haystack}, {needle}) *strridx()*
|
|
|
3419 The result is a Number, which gives the index in {haystack} of
|
|
|
3420 the last occurrence of the String {needle} in the String
|
|
|
3421 {haystack}. The search is done case-sensitive. For advanced
|
|
|
3422 searches use |match()|.
|
|
|
3423 If the {needle} does not occur in {haystack} it returns -1.
|
|
22
|
3424 If the {needle} is empty the length of {haystack} is returned.
|
|
7
|
3425 See also |stridx()|. Examples: >
|
|
|
3426 :echo strridx("an angry armadillo", "an") 3
|
|
|
3427 <
|
|
|
3428 strtrans({expr}) *strtrans()*
|
|
|
3429 The result is a String, which is {expr} with all unprintable
|
|
|
3430 characters translated into printable characters |'isprint'|.
|
|
|
3431 Like they are shown in a window. Example: >
|
|
|
3432 echo strtrans(@a)
|
|
|
3433 < This displays a newline in register a as "^@" instead of
|
|
|
3434 starting a new line.
|
|
|
3435
|
|
|
3436 submatch({nr}) *submatch()*
|
|
|
3437 Only for an expression in a |:substitute| command. Returns
|
|
|
3438 the {nr}'th submatch of the matched text. When {nr} is 0
|
|
|
3439 the whole matched text is returned.
|
|
|
3440 Example: >
|
|
|
3441 :s/\d\+/\=submatch(0) + 1/
|
|
|
3442 < This finds the first number in the line and adds one to it.
|
|
|
3443 A line break is included as a newline character.
|
|
|
3444
|
|
|
3445 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
|
|
|
3446 The result is a String, which is a copy of {expr}, in which
|
|
|
3447 the first match of {pat} is replaced with {sub}. This works
|
|
|
3448 like the ":substitute" command (without any flags). But the
|
|
|
3449 matching with {pat} is always done like the 'magic' option is
|
|
|
3450 set and 'cpoptions' is empty (to make scripts portable).
|
|
|
3451 See |string-match| for how {pat} is used.
|
|
|
3452 And a "~" in {sub} is not replaced with the previous {sub}.
|
|
|
3453 Note that some codes in {sub} have a special meaning
|
|
|
3454 |sub-replace-special|. For example, to replace something with
|
|
|
3455 "\n" (two characters), use "\\\\n" or '\\n'.
|
|
|
3456 When {pat} does not match in {expr}, {expr} is returned
|
|
|
3457 unmodified.
|
|
|
3458 When {flags} is "g", all matches of {pat} in {expr} are
|
|
|
3459 replaced. Otherwise {flags} should be "".
|
|
|
3460 Example: >
|
|
|
3461 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
|
|
|
3462 < This removes the last component of the 'path' option. >
|
|
|
3463 :echo substitute("testing", ".*", "\\U\\0", "")
|
|
|
3464 < results in "TESTING".
|
|
|
3465
|
|
32
|
3466 synID({lnum}, {col}, {trans}) *synID()*
|
|
7
|
3467 The result is a Number, which is the syntax ID at the position
|
|
32
|
3468 {lnum} and {col} in the current window.
|
|
7
|
3469 The syntax ID can be used with |synIDattr()| and
|
|
|
3470 |synIDtrans()| to obtain syntax information about text.
|
|
32
|
3471 {col} is 1 for the leftmost column, {lnum} is 1 for the first
|
|
7
|
3472 line.
|
|
|
3473 When {trans} is non-zero, transparent items are reduced to the
|
|
|
3474 item that they reveal. This is useful when wanting to know
|
|
|
3475 the effective color. When {trans} is zero, the transparent
|
|
|
3476 item is returned. This is useful when wanting to know which
|
|
|
3477 syntax item is effective (e.g. inside parens).
|
|
|
3478 Warning: This function can be very slow. Best speed is
|
|
|
3479 obtained by going through the file in forward direction.
|
|
|
3480
|
|
|
3481 Example (echoes the name of the syntax item under the cursor): >
|
|
|
3482 :echo synIDattr(synID(line("."), col("."), 1), "name")
|
|
|
3483 <
|
|
|
3484 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
|
|
|
3485 The result is a String, which is the {what} attribute of
|
|
|
3486 syntax ID {synID}. This can be used to obtain information
|
|
|
3487 about a syntax item.
|
|
|
3488 {mode} can be "gui", "cterm" or "term", to get the attributes
|
|
|
3489 for that mode. When {mode} is omitted, or an invalid value is
|
|
|
3490 used, the attributes for the currently active highlighting are
|
|
|
3491 used (GUI, cterm or term).
|
|
|
3492 Use synIDtrans() to follow linked highlight groups.
|
|
|
3493 {what} result
|
|
|
3494 "name" the name of the syntax item
|
|
|
3495 "fg" foreground color (GUI: color name used to set
|
|
|
3496 the color, cterm: color number as a string,
|
|
|
3497 term: empty string)
|
|
|
3498 "bg" background color (like "fg")
|
|
|
3499 "fg#" like "fg", but for the GUI and the GUI is
|
|
|
3500 running the name in "#RRGGBB" form
|
|
|
3501 "bg#" like "fg#" for "bg"
|
|
|
3502 "bold" "1" if bold
|
|
|
3503 "italic" "1" if italic
|
|
|
3504 "reverse" "1" if reverse
|
|
|
3505 "inverse" "1" if inverse (= reverse)
|
|
|
3506 "underline" "1" if underlined
|
|
|
3507
|
|
|
3508 Example (echoes the color of the syntax item under the
|
|
|
3509 cursor): >
|
|
|
3510 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
|
|
|
3511 <
|
|
|
3512 synIDtrans({synID}) *synIDtrans()*
|
|
|
3513 The result is a Number, which is the translated syntax ID of
|
|
|
3514 {synID}. This is the syntax group ID of what is being used to
|
|
|
3515 highlight the character. Highlight links given with
|
|
|
3516 ":highlight link" are followed.
|
|
|
3517
|
|
24
|
3518 system({expr} [, {input}]) *system()* *E677*
|
|
|
3519 Get the output of the shell command {expr}.
|
|
|
3520 When {input} is given, this string is written to a file and
|
|
|
3521 passed as stdin to the command. The string is written as-is,
|
|
|
3522 you need to take care of using the correct line separators
|
|
|
3523 yourself.
|
|
|
3524 Note: newlines in {expr} may cause the command to fail. The
|
|
|
3525 characters in 'shellquote' and 'shellxquote' may also cause
|
|
|
3526 trouble.
|
|
7
|
3527 This is not to be used for interactive commands.
|
|
|
3528 The result is a String. Example: >
|
|
|
3529
|
|
|
3530 :let files = system("ls")
|
|
|
3531
|
|
|
3532 < To make the result more system-independent, the shell output
|
|
|
3533 is filtered to replace <CR> with <NL> for Macintosh, and
|
|
|
3534 <CR><NL> with <NL> for DOS-like systems.
|
|
|
3535 The command executed is constructed using several options:
|
|
|
3536 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
|
|
|
3537 ({tmp} is an automatically generated file name).
|
|
|
3538 For Unix and OS/2 braces are put around {expr} to allow for
|
|
|
3539 concatenated commands.
|
|
|
3540
|
|
|
3541 The resulting error code can be found in |v:shell_error|.
|
|
|
3542 This function will fail in |restricted-mode|.
|
|
|
3543 Unlike ":!cmd" there is no automatic check for changed files.
|
|
|
3544 Use |:checktime| to force a check.
|
|
|
3545
|
|
|
3546 tempname() *tempname()* *temp-file-name*
|
|
|
3547 The result is a String, which is the name of a file that
|
|
|
3548 doesn't exist. It can be used for a temporary file. The name
|
|
|
3549 is different for at least 26 consecutive calls. Example: >
|
|
|
3550 :let tmpfile = tempname()
|
|
|
3551 :exe "redir > " . tmpfile
|
|
|
3552 < For Unix, the file will be in a private directory (only
|
|
|
3553 accessible by the current user) to avoid security problems
|
|
|
3554 (e.g., a symlink attack or other people reading your file).
|
|
|
3555 When Vim exits the directory and all files in it are deleted.
|
|
|
3556 For MS-Windows forward slashes are used when the 'shellslash'
|
|
|
3557 option is set or when 'shellcmdflag' starts with '-'.
|
|
|
3558
|
|
|
3559 tolower({expr}) *tolower()*
|
|
|
3560 The result is a copy of the String given, with all uppercase
|
|
|
3561 characters turned into lowercase (just like applying |gu| to
|
|
|
3562 the string).
|
|
|
3563
|
|
|
3564 toupper({expr}) *toupper()*
|
|
|
3565 The result is a copy of the String given, with all lowercase
|
|
|
3566 characters turned into uppercase (just like applying |gU| to
|
|
|
3567 the string).
|
|
|
3568
|
|
15
|
3569 tr({src}, {fromstr}, {tostr}) *tr()*
|
|
|
3570 The result is a copy of the {src} string with all characters
|
|
|
3571 which appear in {fromstr} replaced by the character in that
|
|
|
3572 position in the {tostr} string. Thus the first character in
|
|
|
3573 {fromstr} is translated into the first character in {tostr}
|
|
|
3574 and so on. Exactly like the unix "tr" command.
|
|
|
3575 This code also deals with multibyte characters properly.
|
|
|
3576
|
|
|
3577 Examples: >
|
|
|
3578 echo tr("hello there", "ht", "HT")
|
|
|
3579 < returns "Hello THere" >
|
|
|
3580 echo tr("<blob>", "<>", "{}")
|
|
|
3581 < returns "{blob}"
|
|
|
3582
|
|
87
|
3583 *type()*
|
|
|
3584 type({expr}) The result is a Number, depending on the type of {expr}:
|
|
|
3585 Number: 0
|
|
|
3586 String: 1
|
|
|
3587 Funcref: 2
|
|
|
3588 List: 3
|
|
|
3589 To avoid the magic numbers it can be used this way: >
|
|
|
3590 :if type(myvar) == type(0)
|
|
|
3591 :if type(myvar) == type("")
|
|
|
3592 :if type(myvar) == type(function("tr"))
|
|
|
3593 :if type(myvar) == type([])
|
|
7
|
3594
|
|
|
3595 virtcol({expr}) *virtcol()*
|
|
|
3596 The result is a Number, which is the screen column of the file
|
|
|
3597 position given with {expr}. That is, the last screen position
|
|
|
3598 occupied by the character at that position, when the screen
|
|
|
3599 would be of unlimited width. When there is a <Tab> at the
|
|
|
3600 position, the returned Number will be the column at the end of
|
|
|
3601 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
|
|
|
3602 set to 8, it returns 8.
|
|
|
3603 For the byte position use |col()|.
|
|
|
3604 When Virtual editing is active in the current mode, a position
|
|
|
3605 beyond the end of the line can be returned. |'virtualedit'|
|
|
|
3606 The accepted positions are:
|
|
|
3607 . the cursor position
|
|
|
3608 $ the end of the cursor line (the result is the
|
|
|
3609 number of displayed characters in the cursor line
|
|
|
3610 plus one)
|
|
|
3611 'x position of mark x (if the mark is not set, 0 is
|
|
|
3612 returned)
|
|
|
3613 Note that only marks in the current file can be used.
|
|
|
3614 Examples: >
|
|
|
3615 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
|
|
|
3616 virtcol("$") with text "foo^Lbar", returns 9
|
|
|
3617 virtcol("'t") with text " there", with 't at 'h', returns 6
|
|
|
3618 < The first column is 1. 0 is returned for an error.
|
|
|
3619
|
|
|
3620 visualmode([expr]) *visualmode()*
|
|
|
3621 The result is a String, which describes the last Visual mode
|
|
|
3622 used. Initially it returns an empty string, but once Visual
|
|
|
3623 mode has been used, it returns "v", "V", or "<CTRL-V>" (a
|
|
|
3624 single CTRL-V character) for character-wise, line-wise, or
|
|
|
3625 block-wise Visual mode respectively.
|
|
|
3626 Example: >
|
|
|
3627 :exe "normal " . visualmode()
|
|
|
3628 < This enters the same Visual mode as before. It is also useful
|
|
|
3629 in scripts if you wish to act differently depending on the
|
|
|
3630 Visual mode that was used.
|
|
|
3631
|
|
|
3632 If an expression is supplied that results in a non-zero number
|
|
|
3633 or a non-empty string, then the Visual mode will be cleared
|
|
|
3634 and the old value is returned. Note that " " and "0" are also
|
|
|
3635 non-empty strings, thus cause the mode to be cleared.
|
|
|
3636
|
|
|
3637 *winbufnr()*
|
|
|
3638 winbufnr({nr}) The result is a Number, which is the number of the buffer
|
|
|
3639 associated with window {nr}. When {nr} is zero, the number of
|
|
|
3640 the buffer in the current window is returned. When window
|
|
|
3641 {nr} doesn't exist, -1 is returned.
|
|
|
3642 Example: >
|
|
|
3643 :echo "The file in the current window is " . bufname(winbufnr(0))
|
|
|
3644 <
|
|
|
3645 *wincol()*
|
|
|
3646 wincol() The result is a Number, which is the virtual column of the
|
|
|
3647 cursor in the window. This is counting screen cells from the
|
|
|
3648 left side of the window. The leftmost column is one.
|
|
|
3649
|
|
|
3650 winheight({nr}) *winheight()*
|
|
|
3651 The result is a Number, which is the height of window {nr}.
|
|
|
3652 When {nr} is zero, the height of the current window is
|
|
|
3653 returned. When window {nr} doesn't exist, -1 is returned.
|
|
|
3654 An existing window always has a height of zero or more.
|
|
|
3655 Examples: >
|
|
|
3656 :echo "The current window has " . winheight(0) . " lines."
|
|
|
3657 <
|
|
|
3658 *winline()*
|
|
|
3659 winline() The result is a Number, which is the screen line of the cursor
|
|
|
3660 in the window. This is counting screen lines from the top of
|
|
|
3661 the window. The first line is one.
|
|
|
3662
|
|
|
3663 *winnr()*
|
|
20
|
3664 winnr([{arg}]) The result is a Number, which is the number of the current
|
|
|
3665 window. The top window has number 1.
|
|
|
3666 When the optional argument is "$", the number of the
|
|
|
3667 last window is returnd (the window count).
|
|
|
3668 When the optional argument is "#", the number of the last
|
|
|
3669 accessed window is returned (where |CTRL-W_p| goes to).
|
|
|
3670 If there is no previous window 0 is returned.
|
|
|
3671 The number can be used with |CTRL-W_w| and ":wincmd w"
|
|
|
3672 |:wincmd|.
|
|
7
|
3673
|
|
|
3674 *winrestcmd()*
|
|
|
3675 winrestcmd() Returns a sequence of |:resize| commands that should restore
|
|
|
3676 the current window sizes. Only works properly when no windows
|
|
|
3677 are opened or closed and the current window is unchanged.
|
|
|
3678 Example: >
|
|
|
3679 :let cmd = winrestcmd()
|
|
|
3680 :call MessWithWindowSizes()
|
|
|
3681 :exe cmd
|
|
|
3682
|
|
|
3683 winwidth({nr}) *winwidth()*
|
|
|
3684 The result is a Number, which is the width of window {nr}.
|
|
|
3685 When {nr} is zero, the width of the current window is
|
|
|
3686 returned. When window {nr} doesn't exist, -1 is returned.
|
|
|
3687 An existing window always has a width of zero or more.
|
|
|
3688 Examples: >
|
|
|
3689 :echo "The current window has " . winwidth(0) . " columns."
|
|
|
3690 :if winwidth(0) <= 50
|
|
|
3691 : exe "normal 50\<C-W>|"
|
|
|
3692 :endif
|
|
|
3693 <
|
|
|
3694
|
|
|
3695 *feature-list*
|
|
|
3696 There are three types of features:
|
|
|
3697 1. Features that are only supported when they have been enabled when Vim
|
|
|
3698 was compiled |+feature-list|. Example: >
|
|
|
3699 :if has("cindent")
|
|
|
3700 2. Features that are only supported when certain conditions have been met.
|
|
|
3701 Example: >
|
|
|
3702 :if has("gui_running")
|
|
|
3703 < *has-patch*
|
|
|
3704 3. Included patches. First check |v:version| for the version of Vim.
|
|
|
3705 Then the "patch123" feature means that patch 123 has been included for
|
|
|
3706 this version. Example (checking version 6.2.148 or later): >
|
|
|
3707 :if v:version > 602 || v:version == 602 && has("patch148")
|
|
|
3708
|
|
|
3709 all_builtin_terms Compiled with all builtin terminals enabled.
|
|
|
3710 amiga Amiga version of Vim.
|
|
|
3711 arabic Compiled with Arabic support |Arabic|.
|
|
|
3712 arp Compiled with ARP support (Amiga).
|
|
|
3713 autocmd Compiled with autocommands support.
|
|
|
3714 balloon_eval Compiled with |balloon-eval| support.
|
|
|
3715 beos BeOS version of Vim.
|
|
|
3716 browse Compiled with |:browse| support, and browse() will
|
|
|
3717 work.
|
|
|
3718 builtin_terms Compiled with some builtin terminals.
|
|
|
3719 byte_offset Compiled with support for 'o' in 'statusline'
|
|
|
3720 cindent Compiled with 'cindent' support.
|
|
|
3721 clientserver Compiled with remote invocation support |clientserver|.
|
|
|
3722 clipboard Compiled with 'clipboard' support.
|
|
|
3723 cmdline_compl Compiled with |cmdline-completion| support.
|
|
|
3724 cmdline_hist Compiled with |cmdline-history| support.
|
|
|
3725 cmdline_info Compiled with 'showcmd' and 'ruler' support.
|
|
|
3726 comments Compiled with |'comments'| support.
|
|
|
3727 cryptv Compiled with encryption support |encryption|.
|
|
|
3728 cscope Compiled with |cscope| support.
|
|
|
3729 compatible Compiled to be very Vi compatible.
|
|
|
3730 debug Compiled with "DEBUG" defined.
|
|
|
3731 dialog_con Compiled with console dialog support.
|
|
|
3732 dialog_gui Compiled with GUI dialog support.
|
|
|
3733 diff Compiled with |vimdiff| and 'diff' support.
|
|
|
3734 digraphs Compiled with support for digraphs.
|
|
|
3735 dnd Compiled with support for the "~ register |quote_~|.
|
|
|
3736 dos32 32 bits DOS (DJGPP) version of Vim.
|
|
|
3737 dos16 16 bits DOS version of Vim.
|
|
|
3738 ebcdic Compiled on a machine with ebcdic character set.
|
|
|
3739 emacs_tags Compiled with support for Emacs tags.
|
|
|
3740 eval Compiled with expression evaluation support. Always
|
|
|
3741 true, of course!
|
|
|
3742 ex_extra Compiled with extra Ex commands |+ex_extra|.
|
|
|
3743 extra_search Compiled with support for |'incsearch'| and
|
|
|
3744 |'hlsearch'|
|
|
|
3745 farsi Compiled with Farsi support |farsi|.
|
|
|
3746 file_in_path Compiled with support for |gf| and |<cfile>|
|
|
|
3747 find_in_path Compiled with support for include file searches
|
|
|
3748 |+find_in_path|.
|
|
|
3749 fname_case Case in file names matters (for Amiga, MS-DOS, and
|
|
|
3750 Windows this is not present).
|
|
|
3751 folding Compiled with |folding| support.
|
|
|
3752 footer Compiled with GUI footer support. |gui-footer|
|
|
|
3753 fork Compiled to use fork()/exec() instead of system().
|
|
|
3754 gettext Compiled with message translation |multi-lang|
|
|
|
3755 gui Compiled with GUI enabled.
|
|
|
3756 gui_athena Compiled with Athena GUI.
|
|
9
|
3757 gui_beos Compiled with BeOS GUI.
|
|
7
|
3758 gui_gtk Compiled with GTK+ GUI (any version).
|
|
|
3759 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
|
|
11
|
3760 gui_kde Compiled with KDE GUI |KVim|
|
|
7
|
3761 gui_mac Compiled with Macintosh GUI.
|
|
|
3762 gui_motif Compiled with Motif GUI.
|
|
|
3763 gui_photon Compiled with Photon GUI.
|
|
|
3764 gui_win32 Compiled with MS Windows Win32 GUI.
|
|
|
3765 gui_win32s idem, and Win32s system being used (Windows 3.1)
|
|
|
3766 gui_running Vim is running in the GUI, or it will start soon.
|
|
|
3767 hangul_input Compiled with Hangul input support. |hangul|
|
|
|
3768 iconv Can use iconv() for conversion.
|
|
|
3769 insert_expand Compiled with support for CTRL-X expansion commands in
|
|
|
3770 Insert mode.
|
|
|
3771 jumplist Compiled with |jumplist| support.
|
|
|
3772 keymap Compiled with 'keymap' support.
|
|
|
3773 langmap Compiled with 'langmap' support.
|
|
|
3774 libcall Compiled with |libcall()| support.
|
|
|
3775 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
|
|
|
3776 support.
|
|
|
3777 lispindent Compiled with support for lisp indenting.
|
|
|
3778 listcmds Compiled with commands for the buffer list |:files|
|
|
|
3779 and the argument list |arglist|.
|
|
|
3780 localmap Compiled with local mappings and abbr. |:map-local|
|
|
|
3781 mac Macintosh version of Vim.
|
|
|
3782 macunix Macintosh version of Vim, using Unix files (OS-X).
|
|
|
3783 menu Compiled with support for |:menu|.
|
|
|
3784 mksession Compiled with support for |:mksession|.
|
|
|
3785 modify_fname Compiled with file name modifiers. |filename-modifiers|
|
|
|
3786 mouse Compiled with support mouse.
|
|
|
3787 mouseshape Compiled with support for 'mouseshape'.
|
|
|
3788 mouse_dec Compiled with support for Dec terminal mouse.
|
|
|
3789 mouse_gpm Compiled with support for gpm (Linux console mouse)
|
|
|
3790 mouse_netterm Compiled with support for netterm mouse.
|
|
|
3791 mouse_pterm Compiled with support for qnx pterm mouse.
|
|
|
3792 mouse_xterm Compiled with support for xterm mouse.
|
|
|
3793 multi_byte Compiled with support for editing Korean et al.
|
|
|
3794 multi_byte_ime Compiled with support for IME input method.
|
|
|
3795 multi_lang Compiled with support for multiple languages.
|
|
14
|
3796 mzscheme Compiled with MzScheme interface |mzscheme|.
|
|
7
|
3797 netbeans_intg Compiled with support for |netbeans|.
|
|
33
|
3798 netbeans_enabled Compiled with support for |netbeans| and it's used.
|
|
7
|
3799 ole Compiled with OLE automation support for Win32.
|
|
|
3800 os2 OS/2 version of Vim.
|
|
|
3801 osfiletype Compiled with support for osfiletypes |+osfiletype|
|
|
|
3802 path_extra Compiled with up/downwards search in 'path' and 'tags'
|
|
|
3803 perl Compiled with Perl interface.
|
|
|
3804 postscript Compiled with PostScript file printing.
|
|
|
3805 printer Compiled with |:hardcopy| support.
|
|
|
3806 python Compiled with Python interface.
|
|
|
3807 qnx QNX version of Vim.
|
|
|
3808 quickfix Compiled with |quickfix| support.
|
|
|
3809 rightleft Compiled with 'rightleft' support.
|
|
|
3810 ruby Compiled with Ruby interface |ruby|.
|
|
|
3811 scrollbind Compiled with 'scrollbind' support.
|
|
|
3812 showcmd Compiled with 'showcmd' support.
|
|
|
3813 signs Compiled with |:sign| support.
|
|
|
3814 smartindent Compiled with 'smartindent' support.
|
|
9
|
3815 sniff Compiled with SNiFF interface support.
|
|
7
|
3816 statusline Compiled with support for 'statusline', 'rulerformat'
|
|
|
3817 and special formats of 'titlestring' and 'iconstring'.
|
|
|
3818 sun_workshop Compiled with support for Sun |workshop|.
|
|
|
3819 syntax Compiled with syntax highlighting support.
|
|
|
3820 syntax_items There are active syntax highlighting items for the
|
|
|
3821 current buffer.
|
|
|
3822 system Compiled to use system() instead of fork()/exec().
|
|
|
3823 tag_binary Compiled with binary searching in tags files
|
|
|
3824 |tag-binary-search|.
|
|
|
3825 tag_old_static Compiled with support for old static tags
|
|
|
3826 |tag-old-static|.
|
|
|
3827 tag_any_white Compiled with support for any white characters in tags
|
|
|
3828 files |tag-any-white|.
|
|
|
3829 tcl Compiled with Tcl interface.
|
|
|
3830 terminfo Compiled with terminfo instead of termcap.
|
|
|
3831 termresponse Compiled with support for |t_RV| and |v:termresponse|.
|
|
|
3832 textobjects Compiled with support for |text-objects|.
|
|
|
3833 tgetent Compiled with tgetent support, able to use a termcap
|
|
|
3834 or terminfo file.
|
|
|
3835 title Compiled with window title support |'title'|.
|
|
|
3836 toolbar Compiled with support for |gui-toolbar|.
|
|
|
3837 unix Unix version of Vim.
|
|
|
3838 user_commands User-defined commands.
|
|
|
3839 viminfo Compiled with viminfo support.
|
|
|
3840 vim_starting True while initial source'ing takes place.
|
|
|
3841 vertsplit Compiled with vertically split windows |:vsplit|.
|
|
|
3842 virtualedit Compiled with 'virtualedit' option.
|
|
|
3843 visual Compiled with Visual mode.
|
|
|
3844 visualextra Compiled with extra Visual mode commands.
|
|
|
3845 |blockwise-operators|.
|
|
|
3846 vms VMS version of Vim.
|
|
|
3847 vreplace Compiled with |gR| and |gr| commands.
|
|
|
3848 wildignore Compiled with 'wildignore' option.
|
|
|
3849 wildmenu Compiled with 'wildmenu' option.
|
|
|
3850 windows Compiled with support for more than one window.
|
|
|
3851 winaltkeys Compiled with 'winaltkeys' option.
|
|
|
3852 win16 Win16 version of Vim (MS-Windows 3.1).
|
|
|
3853 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
|
|
|
3854 win64 Win64 version of Vim (MS-Windows 64 bit).
|
|
|
3855 win32unix Win32 version of Vim, using Unix files (Cygwin)
|
|
|
3856 win95 Win32 version for MS-Windows 95/98/ME.
|
|
|
3857 writebackup Compiled with 'writebackup' default on.
|
|
|
3858 xfontset Compiled with X fontset support |xfontset|.
|
|
|
3859 xim Compiled with X input method support |xim|.
|
|
|
3860 xsmp Compiled with X session management support.
|
|
|
3861 xsmp_interact Compiled with interactive X session management support.
|
|
|
3862 xterm_clipboard Compiled with support for xterm clipboard.
|
|
|
3863 xterm_save Compiled with support for saving and restoring the
|
|
|
3864 xterm screen.
|
|
|
3865 x11 Compiled with X11 support.
|
|
|
3866
|
|
|
3867 *string-match*
|
|
|
3868 Matching a pattern in a String
|
|
|
3869
|
|
|
3870 A regexp pattern as explained at |pattern| is normally used to find a match in
|
|
|
3871 the buffer lines. When a pattern is used to find a match in a String, almost
|
|
|
3872 everything works in the same way. The difference is that a String is handled
|
|
|
3873 like it is one line. When it contains a "\n" character, this is not seen as a
|
|
|
3874 line break for the pattern. It can be matched with a "\n" in the pattern, or
|
|
|
3875 with ".". Example: >
|
|
|
3876 :let a = "aaaa\nxxxx"
|
|
|
3877 :echo matchstr(a, "..\n..")
|
|
|
3878 aa
|
|
|
3879 xx
|
|
|
3880 :echo matchstr(a, "a.x")
|
|
|
3881 a
|
|
|
3882 x
|
|
|
3883
|
|
|
3884 Don't forget that "^" will only match at the first character of the String and
|
|
|
3885 "$" at the last character of the string. They don't match after or before a
|
|
|
3886 "\n".
|
|
|
3887
|
|
|
3888 ==============================================================================
|
|
|
3889 5. Defining functions *user-functions*
|
|
|
3890
|
|
|
3891 New functions can be defined. These can be called just like builtin
|
|
|
3892 functions. The function executes a sequence of Ex commands. Normal mode
|
|
|
3893 commands can be executed with the |:normal| command.
|
|
|
3894
|
|
|
3895 The function name must start with an uppercase letter, to avoid confusion with
|
|
|
3896 builtin functions. To prevent from using the same name in different scripts
|
|
|
3897 avoid obvious, short names. A good habit is to start the function name with
|
|
|
3898 the name of the script, e.g., "HTMLcolor()".
|
|
|
3899
|
|
|
3900 It's also possible to use curly braces, see |curly-braces-names|.
|
|
|
3901
|
|
|
3902 *local-function*
|
|
|
3903 A function local to a script must start with "s:". A local script function
|
|
|
3904 can only be called from within the script and from functions, user commands
|
|
|
3905 and autocommands defined in the script. It is also possible to call the
|
|
|
3906 function from a mappings defined in the script, but then |<SID>| must be used
|
|
|
3907 instead of "s:" when the mapping is expanded outside of the script.
|
|
|
3908
|
|
|
3909 *:fu* *:function* *E128* *E129* *E123*
|
|
|
3910 :fu[nction] List all functions and their arguments.
|
|
|
3911
|
|
|
3912 :fu[nction] {name} List function {name}.
|
|
|
3913 *E124* *E125*
|
|
|
3914 :fu[nction][!] {name}([arguments]) [range] [abort]
|
|
|
3915 Define a new function by the name {name}. The name
|
|
|
3916 must be made of alphanumeric characters and '_', and
|
|
|
3917 must start with a capital or "s:" (see above).
|
|
|
3918 *function-argument* *a:var*
|
|
|
3919 An argument can be defined by giving its name. In the
|
|
|
3920 function this can then be used as "a:name" ("a:" for
|
|
|
3921 argument).
|
|
|
3922 Up to 20 arguments can be given, separated by commas.
|
|
|
3923 Finally, an argument "..." can be specified, which
|
|
|
3924 means that more arguments may be following. In the
|
|
|
3925 function they can be used as "a:1", "a:2", etc. "a:0"
|
|
|
3926 is set to the number of extra arguments (which can be
|
|
|
3927 0).
|
|
|
3928 When not using "...", the number of arguments in a
|
|
|
3929 function call must be equal to the number of named
|
|
|
3930 arguments. When using "...", the number of arguments
|
|
|
3931 may be larger.
|
|
|
3932 It is also possible to define a function without any
|
|
|
3933 arguments. You must still supply the () then.
|
|
|
3934 The body of the function follows in the next lines,
|
|
|
3935 until the matching |:endfunction|. It is allowed to
|
|
|
3936 define another function inside a function body.
|
|
|
3937 *E127* *E122*
|
|
|
3938 When a function by this name already exists and [!] is
|
|
|
3939 not used an error message is given. When [!] is used,
|
|
|
3940 an existing function is silently replaced. Unless it
|
|
|
3941 is currently being executed, that is an error.
|
|
|
3942 *a:firstline* *a:lastline*
|
|
|
3943 When the [range] argument is added, the function is
|
|
|
3944 expected to take care of a range itself. The range is
|
|
|
3945 passed as "a:firstline" and "a:lastline". If [range]
|
|
|
3946 is excluded, ":{range}call" will call the function for
|
|
|
3947 each line in the range, with the cursor on the start
|
|
|
3948 of each line. See |function-range-example|.
|
|
|
3949 When the [abort] argument is added, the function will
|
|
|
3950 abort as soon as an error is detected.
|
|
|
3951 The last used search pattern and the redo command "."
|
|
|
3952 will not be changed by the function.
|
|
|
3953
|
|
|
3954 *:endf* *:endfunction* *E126* *E193*
|
|
|
3955 :endf[unction] The end of a function definition. Must be on a line
|
|
|
3956 by its own, without other commands.
|
|
|
3957
|
|
|
3958 *:delf* *:delfunction* *E130* *E131*
|
|
|
3959 :delf[unction] {name} Delete function {name}.
|
|
|
3960
|
|
|
3961 *:retu* *:return* *E133*
|
|
|
3962 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
|
|
|
3963 evaluated and returned as the result of the function.
|
|
|
3964 If "[expr]" is not given, the number 0 is returned.
|
|
|
3965 When a function ends without an explicit ":return",
|
|
|
3966 the number 0 is returned.
|
|
|
3967 Note that there is no check for unreachable lines,
|
|
|
3968 thus there is no warning if commands follow ":return".
|
|
|
3969
|
|
|
3970 If the ":return" is used after a |:try| but before the
|
|
|
3971 matching |:finally| (if present), the commands
|
|
|
3972 following the ":finally" up to the matching |:endtry|
|
|
|
3973 are executed first. This process applies to all
|
|
|
3974 nested ":try"s inside the function. The function
|
|
|
3975 returns at the outermost ":endtry".
|
|
|
3976
|
|
|
3977
|
|
|
3978 Inside a function variables can be used. These are local variables, which
|
|
|
3979 will disappear when the function returns. Global variables need to be
|
|
|
3980 accessed with "g:".
|
|
|
3981
|
|
|
3982 Example: >
|
|
|
3983 :function Table(title, ...)
|
|
|
3984 : echohl Title
|
|
|
3985 : echo a:title
|
|
|
3986 : echohl None
|
|
|
3987 : let idx = 1
|
|
|
3988 : while idx <= a:0
|
|
|
3989 : echo a:{idx} . ' '
|
|
|
3990 : let idx = idx + 1
|
|
|
3991 : endwhile
|
|
|
3992 : return idx
|
|
|
3993 :endfunction
|
|
|
3994
|
|
|
3995 This function can then be called with: >
|
|
|
3996 let lines = Table("Table", "line1", "line2")
|
|
|
3997 let lines = Table("Empty Table")
|
|
|
3998
|
|
|
3999 To return more than one value, pass the name of a global variable: >
|
|
|
4000 :function Compute(n1, n2, divname)
|
|
|
4001 : if a:n2 == 0
|
|
|
4002 : return "fail"
|
|
|
4003 : endif
|
|
|
4004 : let g:{a:divname} = a:n1 / a:n2
|
|
|
4005 : return "ok"
|
|
|
4006 :endfunction
|
|
|
4007
|
|
|
4008 This function can then be called with: >
|
|
|
4009 :let success = Compute(13, 1324, "div")
|
|
|
4010 :if success == "ok"
|
|
|
4011 : echo div
|
|
|
4012 :endif
|
|
|
4013
|
|
|
4014 An alternative is to return a command that can be executed. This also works
|
|
|
4015 with local variables in a calling function. Example: >
|
|
|
4016 :function Foo()
|
|
|
4017 : execute Bar()
|
|
|
4018 : echo "line " . lnum . " column " . col
|
|
|
4019 :endfunction
|
|
|
4020
|
|
|
4021 :function Bar()
|
|
|
4022 : return "let lnum = " . line(".") . " | let col = " . col(".")
|
|
|
4023 :endfunction
|
|
|
4024
|
|
|
4025 The names "lnum" and "col" could also be passed as argument to Bar(), to allow
|
|
|
4026 the caller to set the names.
|
|
|
4027
|
|
|
4028 *:cal* *:call* *E107*
|
|
|
4029 :[range]cal[l] {name}([arguments])
|
|
|
4030 Call a function. The name of the function and its arguments
|
|
|
4031 are as specified with |:function|. Up to 20 arguments can be
|
|
|
4032 used.
|
|
|
4033 Without a range and for functions that accept a range, the
|
|
|
4034 function is called once. When a range is given the cursor is
|
|
|
4035 positioned at the start of the first line before executing the
|
|
|
4036 function.
|
|
|
4037 When a range is given and the function doesn't handle it
|
|
|
4038 itself, the function is executed for each line in the range,
|
|
|
4039 with the cursor in the first column of that line. The cursor
|
|
|
4040 is left at the last line (possibly moved by the last function
|
|
|
4041 call). The arguments are re-evaluated for each line. Thus
|
|
|
4042 this works:
|
|
|
4043 *function-range-example* >
|
|
|
4044 :function Mynumber(arg)
|
|
|
4045 : echo line(".") . " " . a:arg
|
|
|
4046 :endfunction
|
|
|
4047 :1,5call Mynumber(getline("."))
|
|
|
4048 <
|
|
|
4049 The "a:firstline" and "a:lastline" are defined anyway, they
|
|
|
4050 can be used to do something different at the start or end of
|
|
|
4051 the range.
|
|
|
4052
|
|
|
4053 Example of a function that handles the range itself: >
|
|
|
4054
|
|
|
4055 :function Cont() range
|
|
|
4056 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
|
|
|
4057 :endfunction
|
|
|
4058 :4,8call Cont()
|
|
|
4059 <
|
|
|
4060 This function inserts the continuation character "\" in front
|
|
|
4061 of all the lines in the range, except the first one.
|
|
|
4062
|
|
|
4063 *E132*
|
|
|
4064 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
|
|
|
4065 option.
|
|
|
4066
|
|
|
4067 *autoload-functions*
|
|
|
4068 When using many or large functions, it's possible to automatically define them
|
|
|
4069 only when they are used. Use the FuncUndefined autocommand event with a
|
|
|
4070 pattern that matches the function(s) to be defined. Example: >
|
|
|
4071
|
|
|
4072 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
|
|
|
4073
|
|
|
4074 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
|
|
|
4075 "BufNet". Also see |FuncUndefined|.
|
|
|
4076
|
|
|
4077 ==============================================================================
|
|
|
4078 6. Curly braces names *curly-braces-names*
|
|
|
4079
|
|
|
4080 Wherever you can use a variable, you can use a "curly braces name" variable.
|
|
|
4081 This is a regular variable name with one or more expressions wrapped in braces
|
|
|
4082 {} like this: >
|
|
|
4083 my_{adjective}_variable
|
|
|
4084
|
|
|
4085 When Vim encounters this, it evaluates the expression inside the braces, puts
|
|
|
4086 that in place of the expression, and re-interprets the whole as a variable
|
|
|
4087 name. So in the above example, if the variable "adjective" was set to
|
|
|
4088 "noisy", then the reference would be to "my_noisy_variable", whereas if
|
|
|
4089 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
|
|
|
4090
|
|
|
4091 One application for this is to create a set of variables governed by an option
|
|
|
4092 value. For example, the statement >
|
|
|
4093 echo my_{&background}_message
|
|
|
4094
|
|
|
4095 would output the contents of "my_dark_message" or "my_light_message" depending
|
|
|
4096 on the current value of 'background'.
|
|
|
4097
|
|
|
4098 You can use multiple brace pairs: >
|
|
|
4099 echo my_{adverb}_{adjective}_message
|
|
|
4100 ..or even nest them: >
|
|
|
4101 echo my_{ad{end_of_word}}_message
|
|
|
4102 where "end_of_word" is either "verb" or "jective".
|
|
|
4103
|
|
|
4104 However, the expression inside the braces must evaluate to a valid single
|
|
|
4105 variable name. e.g. this is invalid: >
|
|
|
4106 :let foo='a + b'
|
|
|
4107 :echo c{foo}d
|
|
|
4108 .. since the result of expansion is "ca + bd", which is not a variable name.
|
|
|
4109
|
|
|
4110 *curly-braces-function-names*
|
|
|
4111 You can call and define functions by an evaluated name in a similar way.
|
|
|
4112 Example: >
|
|
|
4113 :let func_end='whizz'
|
|
|
4114 :call my_func_{func_end}(parameter)
|
|
|
4115
|
|
|
4116 This would call the function "my_func_whizz(parameter)".
|
|
|
4117
|
|
|
4118 ==============================================================================
|
|
|
4119 7. Commands *expression-commands*
|
|
|
4120
|
|
|
4121 :let {var-name} = {expr1} *:let* *E18*
|
|
|
4122 Set internal variable {var-name} to the result of the
|
|
|
4123 expression {expr1}. The variable will get the type
|
|
|
4124 from the {expr}. If {var-name} didn't exist yet, it
|
|
|
4125 is created.
|
|
|
4126
|
|
85
|
4127 :let {var-name}[{idx}] = {expr1} *E689*
|
|
|
4128 Set a list item to the result of the expression
|
|
|
4129 {expr1}. {var-name} must refer to a list and {idx}
|
|
|
4130 must be a valid index in that list. For nested list
|
|
|
4131 the index can be repeated.
|
|
|
4132 This cannot be used to add an item to a list.
|
|
|
4133
|
|
87
|
4134 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* *E711*
|
|
|
4135 Set a sequence of items in a List to the result of the
|
|
|
4136 expression {expr1}, which must be a list with the
|
|
|
4137 correct number of items.
|
|
|
4138 {idx1} can be omitted, zero is used instead.
|
|
|
4139 {idx2} can be omitted, meaning the end of the list.
|
|
|
4140 When the selected range of items is partly past the
|
|
|
4141 end of the list, items will be added.
|
|
|
4142
|
|
7
|
4143 :let ${env-name} = {expr1} *:let-environment* *:let-$*
|
|
|
4144 Set environment variable {env-name} to the result of
|
|
|
4145 the expression {expr1}. The type is always String.
|
|
|
4146
|
|
|
4147 :let @{reg-name} = {expr1} *:let-register* *:let-@*
|
|
|
4148 Write the result of the expression {expr1} in register
|
|
|
4149 {reg-name}. {reg-name} must be a single letter, and
|
|
|
4150 must be the name of a writable register (see
|
|
|
4151 |registers|). "@@" can be used for the unnamed
|
|
|
4152 register, "@/" for the search pattern.
|
|
|
4153 If the result of {expr1} ends in a <CR> or <NL>, the
|
|
|
4154 register will be linewise, otherwise it will be set to
|
|
|
4155 characterwise.
|
|
|
4156 This can be used to clear the last search pattern: >
|
|
|
4157 :let @/ = ""
|
|
|
4158 < This is different from searching for an empty string,
|
|
|
4159 that would match everywhere.
|
|
|
4160
|
|
|
4161 :let &{option-name} = {expr1} *:let-option* *:let-star*
|
|
|
4162 Set option {option-name} to the result of the
|
|
68
|
4163 expression {expr1}. A String or Number value is
|
|
|
4164 always converted to the type of the option.
|
|
7
|
4165 For an option local to a window or buffer the effect
|
|
|
4166 is just like using the |:set| command: both the local
|
|
|
4167 value and the global value is changed.
|
|
68
|
4168 Example: >
|
|
|
4169 :let &path = &path . ',/usr/local/include'
|
|
7
|
4170
|
|
|
4171 :let &l:{option-name} = {expr1}
|
|
|
4172 Like above, but only set the local value of an option
|
|
|
4173 (if there is one). Works like |:setlocal|.
|
|
|
4174
|
|
|
4175 :let &g:{option-name} = {expr1}
|
|
|
4176 Like above, but only set the global value of an option
|
|
|
4177 (if there is one). Works like |:setglobal|.
|
|
|
4178
|
|
85
|
4179 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
|
|
68
|
4180 {expr1} must evaluate to a List. The first item in
|
|
|
4181 the list is assigned to {name1}, the second item to
|
|
|
4182 {name2}, etc.
|
|
|
4183 The number of names must match the number of items in
|
|
|
4184 the List.
|
|
|
4185 Each name can be one of the items of the ":let"
|
|
|
4186 command as mentioned above.
|
|
|
4187 Example: >
|
|
|
4188 :let [s, item] = GetItem(s)
|
|
|
4189
|
|
|
4190 :let [{name}, ..., ; {lastname}] = {expr1}
|
|
|
4191 Like above, but the List may have more items than
|
|
|
4192 there are names. A list of the remaining items is
|
|
|
4193 assigned to {lastname}. If there are no remaining
|
|
|
4194 items {lastname} is set to an empty list.
|
|
|
4195 Example: >
|
|
|
4196 :let [a, b; rest] = ["aval", "bval", 3, 4]
|
|
|
4197 <
|
|
7
|
4198 *E106*
|
|
|
4199 :let {var-name} .. List the value of variable {var-name}. Several
|
|
|
4200 variable names may be given.
|
|
|
4201
|
|
55
|
4202 :let List the values of all variables. The type of the
|
|
|
4203 variable is indicated before the value:
|
|
|
4204 <nothing> String
|
|
|
4205 # Number
|
|
|
4206 * Funcref
|
|
7
|
4207
|
|
|
4208 *:unlet* *:unl* *E108*
|
|
|
4209 :unl[et][!] {var-name} ...
|
|
|
4210 Remove the internal variable {var-name}. Several
|
|
|
4211 variable names can be given, they are all removed.
|
|
|
4212 With [!] no error message is given for non-existing
|
|
|
4213 variables.
|
|
|
4214
|
|
|
4215 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
|
|
|
4216 :en[dif] Execute the commands until the next matching ":else"
|
|
|
4217 or ":endif" if {expr1} evaluates to non-zero.
|
|
|
4218
|
|
|
4219 From Vim version 4.5 until 5.0, every Ex command in
|
|
|
4220 between the ":if" and ":endif" is ignored. These two
|
|
|
4221 commands were just to allow for future expansions in a
|
|
|
4222 backwards compatible way. Nesting was allowed. Note
|
|
|
4223 that any ":else" or ":elseif" was ignored, the "else"
|
|
|
4224 part was not executed either.
|
|
|
4225
|
|
|
4226 You can use this to remain compatible with older
|
|
|
4227 versions: >
|
|
|
4228 :if version >= 500
|
|
|
4229 : version-5-specific-commands
|
|
|
4230 :endif
|
|
|
4231 < The commands still need to be parsed to find the
|
|
|
4232 "endif". Sometimes an older Vim has a problem with a
|
|
|
4233 new command. For example, ":silent" is recognized as
|
|
|
4234 a ":substitute" command. In that case ":execute" can
|
|
|
4235 avoid problems: >
|
|
|
4236 :if version >= 600
|
|
|
4237 : execute "silent 1,$delete"
|
|
|
4238 :endif
|
|
|
4239 <
|
|
|
4240 NOTE: The ":append" and ":insert" commands don't work
|
|
|
4241 properly in between ":if" and ":endif".
|
|
|
4242
|
|
|
4243 *:else* *:el* *E581* *E583*
|
|
|
4244 :el[se] Execute the commands until the next matching ":else"
|
|
|
4245 or ":endif" if they previously were not being
|
|
|
4246 executed.
|
|
|
4247
|
|
|
4248 *:elseif* *:elsei* *E582* *E584*
|
|
|
4249 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
|
|
|
4250 is no extra ":endif".
|
|
|
4251
|
|
|
4252 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
|
|
|
4253 *E170* *E585* *E588*
|
|
|
4254 :endw[hile] Repeat the commands between ":while" and ":endwhile",
|
|
|
4255 as long as {expr1} evaluates to non-zero.
|
|
|
4256 When an error is detected from a command inside the
|
|
|
4257 loop, execution continues after the "endwhile".
|
|
75
|
4258 Example: >
|
|
|
4259 :let lnum = 1
|
|
|
4260 :while lnum <= line("$")
|
|
|
4261 :call FixLine(lnum)
|
|
|
4262 :let lnum = lnum + 1
|
|
|
4263 :endwhile
|
|
|
4264 <
|
|
7
|
4265 NOTE: The ":append" and ":insert" commands don't work
|
|
99
|
4266 properly inside a ":while" and ":for" loop.
|
|
75
|
4267
|
|
85
|
4268 :for {var} in {list} *:for* *E690*
|
|
75
|
4269 :endfo[r] *:endfo* *:endfor*
|
|
|
4270 Repeat the commands between ":for" and ":endfor" for
|
|
79
|
4271 each item in {list}. variable {var} is set to the
|
|
|
4272 value of each item.
|
|
|
4273 When an error is detected for a command inside the
|
|
75
|
4274 loop, execution continues after the "endfor".
|
|
79
|
4275 Changing {list} affects what items are used. Make a
|
|
|
4276 copy if this is unwanted: >
|
|
|
4277 :for item in copy(mylist)
|
|
|
4278 < When not making a copy, Vim stores a reference to the
|
|
|
4279 next item in the list, before executing the commands
|
|
|
4280 with the current item. Thus the current item can be
|
|
|
4281 removed without effect. Removing any later item means
|
|
|
4282 it will not be found. Thus the following example
|
|
|
4283 works (an inefficient way to make a list empty): >
|
|
|
4284 :for item in mylist
|
|
75
|
4285 :call remove(mylist, 0)
|
|
|
4286 :endfor
|
|
87
|
4287 < Note that reordering the list (e.g., with sort() or
|
|
|
4288 reverse()) may have unexpected effects.
|
|
|
4289 Note that the type of each list item should be
|
|
75
|
4290 identical to avoid errors for the type of {var}
|
|
|
4291 changing. Unlet the variable at the end of the loop
|
|
|
4292 to allow multiple item types.
|
|
|
4293
|
|
|
4294 :for {var} in {string}
|
|
|
4295 :endfo[r] Like ":for" above, but use each character in {string}
|
|
|
4296 as a list item.
|
|
|
4297 Composing characters are used as separate characters.
|
|
|
4298 A Number is first converted to a String.
|
|
|
4299
|
|
|
4300 :for [{var1}, {var2}, ...] in {listlist}
|
|
|
4301 :endfo[r]
|
|
|
4302 Like ":for" above, but each item in {listlist} must be
|
|
|
4303 a list, of which each item is assigned to {var1},
|
|
|
4304 {var2}, etc. Example: >
|
|
|
4305 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
|
|
|
4306 :echo getline(lnum)[col]
|
|
|
4307 :endfor
|
|
|
4308 <
|
|
7
|
4309 *:continue* *:con* *E586*
|
|
75
|
4310 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
|
|
|
4311 to the start of the loop.
|
|
|
4312 If it is used after a |:try| inside the loop but
|
|
|
4313 before the matching |:finally| (if present), the
|
|
|
4314 commands following the ":finally" up to the matching
|
|
|
4315 |:endtry| are executed first. This process applies to
|
|
|
4316 all nested ":try"s inside the loop. The outermost
|
|
|
4317 ":endtry" then jumps back to the start of the loop.
|
|
7
|
4318
|
|
|
4319 *:break* *:brea* *E587*
|
|
75
|
4320 :brea[k] When used inside a ":while" or ":for" loop, skips to
|
|
|
4321 the command after the matching ":endwhile" or
|
|
|
4322 ":endfor".
|
|
|
4323 If it is used after a |:try| inside the loop but
|
|
|
4324 before the matching |:finally| (if present), the
|
|
|
4325 commands following the ":finally" up to the matching
|
|
|
4326 |:endtry| are executed first. This process applies to
|
|
|
4327 all nested ":try"s inside the loop. The outermost
|
|
|
4328 ":endtry" then jumps to the command after the loop.
|
|
7
|
4329
|
|
|
4330 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
|
|
|
4331 :endt[ry] Change the error handling for the commands between
|
|
|
4332 ":try" and ":endtry" including everything being
|
|
|
4333 executed across ":source" commands, function calls,
|
|
|
4334 or autocommand invocations.
|
|
|
4335
|
|
|
4336 When an error or interrupt is detected and there is
|
|
|
4337 a |:finally| command following, execution continues
|
|
|
4338 after the ":finally". Otherwise, or when the
|
|
|
4339 ":endtry" is reached thereafter, the next
|
|
|
4340 (dynamically) surrounding ":try" is checked for
|
|
|
4341 a corresponding ":finally" etc. Then the script
|
|
|
4342 processing is terminated. (Whether a function
|
|
|
4343 definition has an "abort" argument does not matter.)
|
|
|
4344 Example: >
|
|
|
4345 :try | edit too much | finally | echo "cleanup" | endtry
|
|
|
4346 :echo "impossible" " not reached, script terminated above
|
|
|
4347 <
|
|
|
4348 Moreover, an error or interrupt (dynamically) inside
|
|
|
4349 ":try" and ":endtry" is converted to an exception. It
|
|
|
4350 can be caught as if it were thrown by a |:throw|
|
|
|
4351 command (see |:catch|). In this case, the script
|
|
|
4352 processing is not terminated.
|
|
|
4353
|
|
|
4354 The value "Vim:Interrupt" is used for an interrupt
|
|
|
4355 exception. An error in a Vim command is converted
|
|
|
4356 to a value of the form "Vim({command}):{errmsg}",
|
|
|
4357 other errors are converted to a value of the form
|
|
|
4358 "Vim:{errmsg}". {command} is the full command name,
|
|
|
4359 and {errmsg} is the message that is displayed if the
|
|
|
4360 error exception is not caught, always beginning with
|
|
|
4361 the error number.
|
|
|
4362 Examples: >
|
|
|
4363 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
|
|
|
4364 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
|
|
|
4365 <
|
|
|
4366 *:cat* *:catch* *E603* *E604* *E605*
|
|
|
4367 :cat[ch] /{pattern}/ The following commands until the next ":catch",
|
|
|
4368 |:finally|, or |:endtry| that belongs to the same
|
|
|
4369 |:try| as the ":catch" are executed when an exception
|
|
|
4370 matching {pattern} is being thrown and has not yet
|
|
|
4371 been caught by a previous ":catch". Otherwise, these
|
|
|
4372 commands are skipped.
|
|
|
4373 When {pattern} is omitted all errors are caught.
|
|
|
4374 Examples: >
|
|
|
4375 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
|
|
|
4376 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
|
|
|
4377 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
|
|
|
4378 :catch /^Vim(write):/ " catch all errors in :write
|
|
|
4379 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
|
|
|
4380 :catch /my-exception/ " catch user exception
|
|
|
4381 :catch /.*/ " catch everything
|
|
|
4382 :catch " same as /.*/
|
|
|
4383 <
|
|
|
4384 Another character can be used instead of / around the
|
|
|
4385 {pattern}, so long as it does not have a special
|
|
|
4386 meaning (e.g., '|' or '"') and doesn't occur inside
|
|
|
4387 {pattern}.
|
|
|
4388 NOTE: It is not reliable to ":catch" the TEXT of
|
|
|
4389 an error message because it may vary in different
|
|
|
4390 locales.
|
|
|
4391
|
|
|
4392 *:fina* *:finally* *E606* *E607*
|
|
|
4393 :fina[lly] The following commands until the matching |:endtry|
|
|
|
4394 are executed whenever the part between the matching
|
|
|
4395 |:try| and the ":finally" is left: either by falling
|
|
|
4396 through to the ":finally" or by a |:continue|,
|
|
|
4397 |:break|, |:finish|, or |:return|, or by an error or
|
|
|
4398 interrupt or exception (see |:throw|).
|
|
|
4399
|
|
|
4400 *:th* *:throw* *E608*
|
|
|
4401 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
|
|
|
4402 If the ":throw" is used after a |:try| but before the
|
|
|
4403 first corresponding |:catch|, commands are skipped
|
|
|
4404 until the first ":catch" matching {expr1} is reached.
|
|
|
4405 If there is no such ":catch" or if the ":throw" is
|
|
|
4406 used after a ":catch" but before the |:finally|, the
|
|
|
4407 commands following the ":finally" (if present) up to
|
|
|
4408 the matching |:endtry| are executed. If the ":throw"
|
|
|
4409 is after the ":finally", commands up to the ":endtry"
|
|
|
4410 are skipped. At the ":endtry", this process applies
|
|
|
4411 again for the next dynamically surrounding ":try"
|
|
|
4412 (which may be found in a calling function or sourcing
|
|
|
4413 script), until a matching ":catch" has been found.
|
|
|
4414 If the exception is not caught, the command processing
|
|
|
4415 is terminated.
|
|
|
4416 Example: >
|
|
|
4417 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
|
|
|
4418 <
|
|
|
4419
|
|
|
4420 *:ec* *:echo*
|
|
|
4421 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
|
|
|
4422 first {expr1} starts on a new line.
|
|
|
4423 Also see |:comment|.
|
|
|
4424 Use "\n" to start a new line. Use "\r" to move the
|
|
|
4425 cursor to the first column.
|
|
|
4426 Uses the highlighting set by the |:echohl| command.
|
|
|
4427 Cannot be followed by a comment.
|
|
|
4428 Example: >
|
|
|
4429 :echo "the value of 'shell' is" &shell
|
|
|
4430 < A later redraw may make the message disappear again.
|
|
|
4431 To avoid that a command from before the ":echo" causes
|
|
|
4432 a redraw afterwards (redraws are often postponed until
|
|
|
4433 you type something), force a redraw with the |:redraw|
|
|
|
4434 command. Example: >
|
|
|
4435 :new | redraw | echo "there is a new window"
|
|
|
4436 <
|
|
|
4437 *:echon*
|
|
|
4438 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
|
|
|
4439 |:comment|.
|
|
|
4440 Uses the highlighting set by the |:echohl| command.
|
|
|
4441 Cannot be followed by a comment.
|
|
|
4442 Example: >
|
|
|
4443 :echon "the value of 'shell' is " &shell
|
|
|
4444 <
|
|
|
4445 Note the difference between using ":echo", which is a
|
|
|
4446 Vim command, and ":!echo", which is an external shell
|
|
|
4447 command: >
|
|
|
4448 :!echo % --> filename
|
|
|
4449 < The arguments of ":!" are expanded, see |:_%|. >
|
|
|
4450 :!echo "%" --> filename or "filename"
|
|
|
4451 < Like the previous example. Whether you see the double
|
|
|
4452 quotes or not depends on your 'shell'. >
|
|
|
4453 :echo % --> nothing
|
|
|
4454 < The '%' is an illegal character in an expression. >
|
|
|
4455 :echo "%" --> %
|
|
|
4456 < This just echoes the '%' character. >
|
|
|
4457 :echo expand("%") --> filename
|
|
|
4458 < This calls the expand() function to expand the '%'.
|
|
|
4459
|
|
|
4460 *:echoh* *:echohl*
|
|
|
4461 :echoh[l] {name} Use the highlight group {name} for the following
|
|
|
4462 |:echo|, |:echon| and |:echomsg| commands. Also used
|
|
|
4463 for the |input()| prompt. Example: >
|
|
|
4464 :echohl WarningMsg | echo "Don't panic!" | echohl None
|
|
|
4465 < Don't forget to set the group back to "None",
|
|
|
4466 otherwise all following echo's will be highlighted.
|
|
|
4467
|
|
|
4468 *:echom* *:echomsg*
|
|
|
4469 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
|
|
|
4470 message in the |message-history|.
|
|
|
4471 Spaces are placed between the arguments as with the
|
|
|
4472 |:echo| command. But unprintable characters are
|
|
|
4473 displayed, not interpreted.
|
|
|
4474 Uses the highlighting set by the |:echohl| command.
|
|
|
4475 Example: >
|
|
|
4476 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
|
|
|
4477 <
|
|
|
4478 *:echoe* *:echoerr*
|
|
|
4479 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
|
|
|
4480 message in the |message-history|. When used in a
|
|
|
4481 script or function the line number will be added.
|
|
|
4482 Spaces are placed between the arguments as with the
|
|
|
4483 :echo command. When used inside a try conditional,
|
|
|
4484 the message is raised as an error exception instead
|
|
|
4485 (see |try-echoerr|).
|
|
|
4486 Example: >
|
|
|
4487 :echoerr "This script just failed!"
|
|
|
4488 < If you just want a highlighted message use |:echohl|.
|
|
|
4489 And to get a beep: >
|
|
|
4490 :exe "normal \<Esc>"
|
|
|
4491 <
|
|
|
4492 *:exe* *:execute*
|
|
|
4493 :exe[cute] {expr1} .. Executes the string that results from the evaluation
|
|
|
4494 of {expr1} as an Ex command. Multiple arguments are
|
|
|
4495 concatenated, with a space in between. {expr1} is
|
|
|
4496 used as the processed command, command line editing
|
|
|
4497 keys are not recognized.
|
|
|
4498 Cannot be followed by a comment.
|
|
|
4499 Examples: >
|
|
|
4500 :execute "buffer " nextbuf
|
|
|
4501 :execute "normal " count . "w"
|
|
|
4502 <
|
|
|
4503 ":execute" can be used to append a command to commands
|
|
|
4504 that don't accept a '|'. Example: >
|
|
|
4505 :execute '!ls' | echo "theend"
|
|
|
4506
|
|
|
4507 < ":execute" is also a nice way to avoid having to type
|
|
|
4508 control characters in a Vim script for a ":normal"
|
|
|
4509 command: >
|
|
|
4510 :execute "normal ixxx\<Esc>"
|
|
|
4511 < This has an <Esc> character, see |expr-string|.
|
|
|
4512
|
|
|
4513 Note: The executed string may be any command-line, but
|
|
99
|
4514 you cannot start or end a "while", "for" or "if"
|
|
|
4515 command. Thus this is illegal: >
|
|
7
|
4516 :execute 'while i > 5'
|
|
|
4517 :execute 'echo "test" | break'
|
|
|
4518 <
|
|
|
4519 It is allowed to have a "while" or "if" command
|
|
|
4520 completely in the executed string: >
|
|
|
4521 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
|
|
|
4522 <
|
|
|
4523
|
|
|
4524 *:comment*
|
|
|
4525 ":execute", ":echo" and ":echon" cannot be followed by
|
|
|
4526 a comment directly, because they see the '"' as the
|
|
|
4527 start of a string. But, you can use '|' followed by a
|
|
|
4528 comment. Example: >
|
|
|
4529 :echo "foo" | "this is a comment
|
|
|
4530
|
|
|
4531 ==============================================================================
|
|
|
4532 8. Exception handling *exception-handling*
|
|
|
4533
|
|
|
4534 The Vim script language comprises an exception handling feature. This section
|
|
|
4535 explains how it can be used in a Vim script.
|
|
|
4536
|
|
|
4537 Exceptions may be raised by Vim on an error or on interrupt, see
|
|
|
4538 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
|
|
|
4539 exception by using the ":throw" command, see |throw-catch|.
|
|
|
4540
|
|
|
4541
|
|
|
4542 TRY CONDITIONALS *try-conditionals*
|
|
|
4543
|
|
|
4544 Exceptions can be caught or can cause cleanup code to be executed. You can
|
|
|
4545 use a try conditional to specify catch clauses (that catch exceptions) and/or
|
|
|
4546 a finally clause (to be executed for cleanup).
|
|
|
4547 A try conditional begins with a |:try| command and ends at the matching
|
|
|
4548 |:endtry| command. In between, you can use a |:catch| command to start
|
|
|
4549 a catch clause, or a |:finally| command to start a finally clause. There may
|
|
|
4550 be none or multiple catch clauses, but there is at most one finally clause,
|
|
|
4551 which must not be followed by any catch clauses. The lines before the catch
|
|
|
4552 clauses and the finally clause is called a try block. >
|
|
|
4553
|
|
|
4554 :try
|
|
|
4555 : ...
|
|
|
4556 : ... TRY BLOCK
|
|
|
4557 : ...
|
|
|
4558 :catch /{pattern}/
|
|
|
4559 : ...
|
|
|
4560 : ... CATCH CLAUSE
|
|
|
4561 : ...
|
|
|
4562 :catch /{pattern}/
|
|
|
4563 : ...
|
|
|
4564 : ... CATCH CLAUSE
|
|
|
4565 : ...
|
|
|
4566 :finally
|
|
|
4567 : ...
|
|
|
4568 : ... FINALLY CLAUSE
|
|
|
4569 : ...
|
|
|
4570 :endtry
|
|
|
4571
|
|
|
4572 The try conditional allows to watch code for exceptions and to take the
|
|
|
4573 appropriate actions. Exceptions from the try block may be caught. Exceptions
|
|
|
4574 from the try block and also the catch clauses may cause cleanup actions.
|
|
|
4575 When no exception is thrown during execution of the try block, the control
|
|
|
4576 is transferred to the finally clause, if present. After its execution, the
|
|
|
4577 script continues with the line following the ":endtry".
|
|
|
4578 When an exception occurs during execution of the try block, the remaining
|
|
|
4579 lines in the try block are skipped. The exception is matched against the
|
|
|
4580 patterns specified as arguments to the ":catch" commands. The catch clause
|
|
|
4581 after the first matching ":catch" is taken, other catch clauses are not
|
|
|
4582 executed. The catch clause ends when the next ":catch", ":finally", or
|
|
|
4583 ":endtry" command is reached - whatever is first. Then, the finally clause
|
|
|
4584 (if present) is executed. When the ":endtry" is reached, the script execution
|
|
|
4585 continues in the following line as usual.
|
|
|
4586 When an exception that does not match any of the patterns specified by the
|
|
|
4587 ":catch" commands is thrown in the try block, the exception is not caught by
|
|
|
4588 that try conditional and none of the catch clauses is executed. Only the
|
|
|
4589 finally clause, if present, is taken. The exception pends during execution of
|
|
|
4590 the finally clause. It is resumed at the ":endtry", so that commands after
|
|
|
4591 the ":endtry" are not executed and the exception might be caught elsewhere,
|
|
|
4592 see |try-nesting|.
|
|
|
4593 When during execution of a catch clause another exception is thrown, the
|
|
|
4594 remaining lines in that catch clause are not executed. The new exception is
|
|
|
4595 not matched against the patterns in any of the ":catch" commands of the same
|
|
|
4596 try conditional and none of its catch clauses is taken. If there is, however,
|
|
|
4597 a finally clause, it is executed, and the exception pends during its
|
|
|
4598 execution. The commands following the ":endtry" are not executed. The new
|
|
|
4599 exception might, however, be caught elsewhere, see |try-nesting|.
|
|
|
4600 When during execution of the finally clause (if present) an exception is
|
|
|
4601 thrown, the remaining lines in the finally clause are skipped. If the finally
|
|
|
4602 clause has been taken because of an exception from the try block or one of the
|
|
|
4603 catch clauses, the original (pending) exception is discarded. The commands
|
|
|
4604 following the ":endtry" are not executed, and the exception from the finally
|
|
|
4605 clause is propagated and can be caught elsewhere, see |try-nesting|.
|
|
|
4606
|
|
|
4607 The finally clause is also executed, when a ":break" or ":continue" for
|
|
|
4608 a ":while" loop enclosing the complete try conditional is executed from the
|
|
|
4609 try block or a catch clause. Or when a ":return" or ":finish" is executed
|
|
|
4610 from the try block or a catch clause of a try conditional in a function or
|
|
|
4611 sourced script, respectively. The ":break", ":continue", ":return", or
|
|
|
4612 ":finish" pends during execution of the finally clause and is resumed when the
|
|
|
4613 ":endtry" is reached. It is, however, discarded when an exception is thrown
|
|
|
4614 from the finally clause.
|
|
|
4615 When a ":break" or ":continue" for a ":while" loop enclosing the complete
|
|
|
4616 try conditional or when a ":return" or ":finish" is encountered in the finally
|
|
|
4617 clause, the rest of the finally clause is skipped, and the ":break",
|
|
|
4618 ":continue", ":return" or ":finish" is executed as usual. If the finally
|
|
|
4619 clause has been taken because of an exception or an earlier ":break",
|
|
|
4620 ":continue", ":return", or ":finish" from the try block or a catch clause,
|
|
|
4621 this pending exception or command is discarded.
|
|
|
4622
|
|
|
4623 For examples see |throw-catch| and |try-finally|.
|
|
|
4624
|
|
|
4625
|
|
|
4626 NESTING OF TRY CONDITIONALS *try-nesting*
|
|
|
4627
|
|
|
4628 Try conditionals can be nested arbitrarily. That is, a complete try
|
|
|
4629 conditional can be put into the try block, a catch clause, or the finally
|
|
|
4630 clause of another try conditional. If the inner try conditional does not
|
|
|
4631 catch an exception thrown in its try block or throws a new exception from one
|
|
|
4632 of its catch clauses or its finally clause, the outer try conditional is
|
|
|
4633 checked according to the rules above. If the inner try conditional is in the
|
|
|
4634 try block of the outer try conditional, its catch clauses are checked, but
|
|
|
4635 otherwise only the finally clause is executed. It does not matter for
|
|
|
4636 nesting, whether the inner try conditional is directly contained in the outer
|
|
|
4637 one, or whether the outer one sources a script or calls a function containing
|
|
|
4638 the inner try conditional.
|
|
|
4639
|
|
|
4640 When none of the active try conditionals catches an exception, just their
|
|
|
4641 finally clauses are executed. Thereafter, the script processing terminates.
|
|
|
4642 An error message is displayed in case of an uncaught exception explicitly
|
|
|
4643 thrown by a ":throw" command. For uncaught error and interrupt exceptions
|
|
|
4644 implicitly raised by Vim, the error message(s) or interrupt message are shown
|
|
|
4645 as usual.
|
|
|
4646
|
|
|
4647 For examples see |throw-catch|.
|
|
|
4648
|
|
|
4649
|
|
|
4650 EXAMINING EXCEPTION HANDLING CODE *except-examine*
|
|
|
4651
|
|
|
4652 Exception handling code can get tricky. If you are in doubt what happens, set
|
|
|
4653 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
|
|
|
4654 script file. Then you see when an exception is thrown, discarded, caught, or
|
|
|
4655 finished. When using a verbosity level of at least 14, things pending in
|
|
|
4656 a finally clause are also shown. This information is also given in debug mode
|
|
|
4657 (see |debug-scripts|).
|
|
|
4658
|
|
|
4659
|
|
|
4660 THROWING AND CATCHING EXCEPTIONS *throw-catch*
|
|
|
4661
|
|
|
4662 You can throw any number or string as an exception. Use the |:throw| command
|
|
|
4663 and pass the value to be thrown as argument: >
|
|
|
4664 :throw 4711
|
|
|
4665 :throw "string"
|
|
|
4666 < *throw-expression*
|
|
|
4667 You can also specify an expression argument. The expression is then evaluated
|
|
|
4668 first, and the result is thrown: >
|
|
|
4669 :throw 4705 + strlen("string")
|
|
|
4670 :throw strpart("strings", 0, 6)
|
|
|
4671
|
|
|
4672 An exception might be thrown during evaluation of the argument of the ":throw"
|
|
|
4673 command. Unless it is caught there, the expression evaluation is abandoned.
|
|
|
4674 The ":throw" command then does not throw a new exception.
|
|
|
4675 Example: >
|
|
|
4676
|
|
|
4677 :function! Foo(arg)
|
|
|
4678 : try
|
|
|
4679 : throw a:arg
|
|
|
4680 : catch /foo/
|
|
|
4681 : endtry
|
|
|
4682 : return 1
|
|
|
4683 :endfunction
|
|
|
4684 :
|
|
|
4685 :function! Bar()
|
|
|
4686 : echo "in Bar"
|
|
|
4687 : return 4710
|
|
|
4688 :endfunction
|
|
|
4689 :
|
|
|
4690 :throw Foo("arrgh") + Bar()
|
|
|
4691
|
|
|
4692 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
|
|
|
4693 executed. >
|
|
|
4694 :throw Foo("foo") + Bar()
|
|
|
4695 however displays "in Bar" and throws 4711.
|
|
|
4696
|
|
|
4697 Any other command that takes an expression as argument might also be
|
|
|
4698 abandoned by an (uncaught) exception during the expression evaluation. The
|
|
|
4699 exception is then propagated to the caller of the command.
|
|
|
4700 Example: >
|
|
|
4701
|
|
|
4702 :if Foo("arrgh")
|
|
|
4703 : echo "then"
|
|
|
4704 :else
|
|
|
4705 : echo "else"
|
|
|
4706 :endif
|
|
|
4707
|
|
|
4708 Here neither of "then" or "else" is displayed.
|
|
|
4709
|
|
|
4710 *catch-order*
|
|
|
4711 Exceptions can be caught by a try conditional with one or more |:catch|
|
|
|
4712 commands, see |try-conditionals|. The values to be caught by each ":catch"
|
|
|
4713 command can be specified as a pattern argument. The subsequent catch clause
|
|
|
4714 gets executed when a matching exception is caught.
|
|
|
4715 Example: >
|
|
|
4716
|
|
|
4717 :function! Foo(value)
|
|
|
4718 : try
|
|
|
4719 : throw a:value
|
|
|
4720 : catch /^\d\+$/
|
|
|
4721 : echo "Number thrown"
|
|
|
4722 : catch /.*/
|
|
|
4723 : echo "String thrown"
|
|
|
4724 : endtry
|
|
|
4725 :endfunction
|
|
|
4726 :
|
|
|
4727 :call Foo(0x1267)
|
|
|
4728 :call Foo('string')
|
|
|
4729
|
|
|
4730 The first call to Foo() displays "Number thrown", the second "String thrown".
|
|
|
4731 An exception is matched against the ":catch" commands in the order they are
|
|
|
4732 specified. Only the first match counts. So you should place the more
|
|
|
4733 specific ":catch" first. The following order does not make sense: >
|
|
|
4734
|
|
|
4735 : catch /.*/
|
|
|
4736 : echo "String thrown"
|
|
|
4737 : catch /^\d\+$/
|
|
|
4738 : echo "Number thrown"
|
|
|
4739
|
|
|
4740 The first ":catch" here matches always, so that the second catch clause is
|
|
|
4741 never taken.
|
|
|
4742
|
|
|
4743 *throw-variables*
|
|
|
4744 If you catch an exception by a general pattern, you may access the exact value
|
|
|
4745 in the variable |v:exception|: >
|
|
|
4746
|
|
|
4747 : catch /^\d\+$/
|
|
|
4748 : echo "Number thrown. Value is" v:exception
|
|
|
4749
|
|
|
4750 You may also be interested where an exception was thrown. This is stored in
|
|
|
4751 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
|
|
|
4752 exception most recently caught as long it is not finished.
|
|
|
4753 Example: >
|
|
|
4754
|
|
|
4755 :function! Caught()
|
|
|
4756 : if v:exception != ""
|
|
|
4757 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
|
|
|
4758 : else
|
|
|
4759 : echo 'Nothing caught'
|
|
|
4760 : endif
|
|
|
4761 :endfunction
|
|
|
4762 :
|
|
|
4763 :function! Foo()
|
|
|
4764 : try
|
|
|
4765 : try
|
|
|
4766 : try
|
|
|
4767 : throw 4711
|
|
|
4768 : finally
|
|
|
4769 : call Caught()
|
|
|
4770 : endtry
|
|
|
4771 : catch /.*/
|
|
|
4772 : call Caught()
|
|
|
4773 : throw "oops"
|
|
|
4774 : endtry
|
|
|
4775 : catch /.*/
|
|
|
4776 : call Caught()
|
|
|
4777 : finally
|
|
|
4778 : call Caught()
|
|
|
4779 : endtry
|
|
|
4780 :endfunction
|
|
|
4781 :
|
|
|
4782 :call Foo()
|
|
|
4783
|
|
|
4784 This displays >
|
|
|
4785
|
|
|
4786 Nothing caught
|
|
|
4787 Caught "4711" in function Foo, line 4
|
|
|
4788 Caught "oops" in function Foo, line 10
|
|
|
4789 Nothing caught
|
|
|
4790
|
|
|
4791 A practical example: The following command ":LineNumber" displays the line
|
|
|
4792 number in the script or function where it has been used: >
|
|
|
4793
|
|
|
4794 :function! LineNumber()
|
|
|
4795 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
|
|
|
4796 :endfunction
|
|
|
4797 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
|
|
|
4798 <
|
|
|
4799 *try-nested*
|
|
|
4800 An exception that is not caught by a try conditional can be caught by
|
|
|
4801 a surrounding try conditional: >
|
|
|
4802
|
|
|
4803 :try
|
|
|
4804 : try
|
|
|
4805 : throw "foo"
|
|
|
4806 : catch /foobar/
|
|
|
4807 : echo "foobar"
|
|
|
4808 : finally
|
|
|
4809 : echo "inner finally"
|
|
|
4810 : endtry
|
|
|
4811 :catch /foo/
|
|
|
4812 : echo "foo"
|
|
|
4813 :endtry
|
|
|
4814
|
|
|
4815 The inner try conditional does not catch the exception, just its finally
|
|
|
4816 clause is executed. The exception is then caught by the outer try
|
|
|
4817 conditional. The example displays "inner finally" and then "foo".
|
|
|
4818
|
|
|
4819 *throw-from-catch*
|
|
|
4820 You can catch an exception and throw a new one to be caught elsewhere from the
|
|
|
4821 catch clause: >
|
|
|
4822
|
|
|
4823 :function! Foo()
|
|
|
4824 : throw "foo"
|
|
|
4825 :endfunction
|
|
|
4826 :
|
|
|
4827 :function! Bar()
|
|
|
4828 : try
|
|
|
4829 : call Foo()
|
|
|
4830 : catch /foo/
|
|
|
4831 : echo "Caught foo, throw bar"
|
|
|
4832 : throw "bar"
|
|
|
4833 : endtry
|
|
|
4834 :endfunction
|
|
|
4835 :
|
|
|
4836 :try
|
|
|
4837 : call Bar()
|
|
|
4838 :catch /.*/
|
|
|
4839 : echo "Caught" v:exception
|
|
|
4840 :endtry
|
|
|
4841
|
|
|
4842 This displays "Caught foo, throw bar" and then "Caught bar".
|
|
|
4843
|
|
|
4844 *rethrow*
|
|
|
4845 There is no real rethrow in the Vim script language, but you may throw
|
|
|
4846 "v:exception" instead: >
|
|
|
4847
|
|
|
4848 :function! Bar()
|
|
|
4849 : try
|
|
|
4850 : call Foo()
|
|
|
4851 : catch /.*/
|
|
|
4852 : echo "Rethrow" v:exception
|
|
|
4853 : throw v:exception
|
|
|
4854 : endtry
|
|
|
4855 :endfunction
|
|
|
4856 < *try-echoerr*
|
|
|
4857 Note that this method cannot be used to "rethrow" Vim error or interrupt
|
|
|
4858 exceptions, because it is not possible to fake Vim internal exceptions.
|
|
|
4859 Trying so causes an error exception. You should throw your own exception
|
|
|
4860 denoting the situation. If you want to cause a Vim error exception containing
|
|
|
4861 the original error exception value, you can use the |:echoerr| command: >
|
|
|
4862
|
|
|
4863 :try
|
|
|
4864 : try
|
|
|
4865 : asdf
|
|
|
4866 : catch /.*/
|
|
|
4867 : echoerr v:exception
|
|
|
4868 : endtry
|
|
|
4869 :catch /.*/
|
|
|
4870 : echo v:exception
|
|
|
4871 :endtry
|
|
|
4872
|
|
|
4873 This code displays
|
|
|
4874
|
|
|
4875 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
|
|
|
4876
|
|
|
4877
|
|
|
4878 CLEANUP CODE *try-finally*
|
|
|
4879
|
|
|
4880 Scripts often change global settings and restore them at their end. If the
|
|
|
4881 user however interrupts the script by pressing CTRL-C, the settings remain in
|
|
|
4882 an inconsistent state. The same may happen to you in the development phase of
|
|
|
4883 a script when an error occurs or you explicitly throw an exception without
|
|
|
4884 catching it. You can solve these problems by using a try conditional with
|
|
|
4885 a finally clause for restoring the settings. Its execution is guaranteed on
|
|
|
4886 normal control flow, on error, on an explicit ":throw", and on interrupt.
|
|
|
4887 (Note that errors and interrupts from inside the try conditional are converted
|
|
|
4888 to exceptions. When not caught, they terminate the script after the finally
|
|
|
4889 clause has been executed.)
|
|
|
4890 Example: >
|
|
|
4891
|
|
|
4892 :try
|
|
|
4893 : let s:saved_ts = &ts
|
|
|
4894 : set ts=17
|
|
|
4895 :
|
|
|
4896 : " Do the hard work here.
|
|
|
4897 :
|
|
|
4898 :finally
|
|
|
4899 : let &ts = s:saved_ts
|
|
|
4900 : unlet s:saved_ts
|
|
|
4901 :endtry
|
|
|
4902
|
|
|
4903 This method should be used locally whenever a function or part of a script
|
|
|
4904 changes global settings which need to be restored on failure or normal exit of
|
|
|
4905 that function or script part.
|
|
|
4906
|
|
|
4907 *break-finally*
|
|
|
4908 Cleanup code works also when the try block or a catch clause is left by
|
|
|
4909 a ":continue", ":break", ":return", or ":finish".
|
|
|
4910 Example: >
|
|
|
4911
|
|
|
4912 :let first = 1
|
|
|
4913 :while 1
|
|
|
4914 : try
|
|
|
4915 : if first
|
|
|
4916 : echo "first"
|
|
|
4917 : let first = 0
|
|
|
4918 : continue
|
|
|
4919 : else
|
|
|
4920 : throw "second"
|
|
|
4921 : endif
|
|
|
4922 : catch /.*/
|
|
|
4923 : echo v:exception
|
|
|
4924 : break
|
|
|
4925 : finally
|
|
|
4926 : echo "cleanup"
|
|
|
4927 : endtry
|
|
|
4928 : echo "still in while"
|
|
|
4929 :endwhile
|
|
|
4930 :echo "end"
|
|
|
4931
|
|
|
4932 This displays "first", "cleanup", "second", "cleanup", and "end". >
|
|
|
4933
|
|
|
4934 :function! Foo()
|
|
|
4935 : try
|
|
|
4936 : return 4711
|
|
|
4937 : finally
|
|
|
4938 : echo "cleanup\n"
|
|
|
4939 : endtry
|
|
|
4940 : echo "Foo still active"
|
|
|
4941 :endfunction
|
|
|
4942 :
|
|
|
4943 :echo Foo() "returned by Foo"
|
|
|
4944
|
|
|
4945 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
|
|
|
4946 extra ":return" in the finally clause. (Above all, this would override the
|
|
|
4947 return value.)
|
|
|
4948
|
|
|
4949 *except-from-finally*
|
|
|
4950 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
|
|
|
4951 a finally clause is possible, but not recommended since it abandons the
|
|
|
4952 cleanup actions for the try conditional. But, of course, interrupt and error
|
|
|
4953 exceptions might get raised from a finally clause.
|
|
|
4954 Example where an error in the finally clause stops an interrupt from
|
|
|
4955 working correctly: >
|
|
|
4956
|
|
|
4957 :try
|
|
|
4958 : try
|
|
|
4959 : echo "Press CTRL-C for interrupt"
|
|
|
4960 : while 1
|
|
|
4961 : endwhile
|
|
|
4962 : finally
|
|
|
4963 : unlet novar
|
|
|
4964 : endtry
|
|
|
4965 :catch /novar/
|
|
|
4966 :endtry
|
|
|
4967 :echo "Script still running"
|
|
|
4968 :sleep 1
|
|
|
4969
|
|
|
4970 If you need to put commands that could fail into a finally clause, you should
|
|
|
4971 think about catching or ignoring the errors in these commands, see
|
|
|
4972 |catch-errors| and |ignore-errors|.
|
|
|
4973
|
|
|
4974
|
|
|
4975 CATCHING ERRORS *catch-errors*
|
|
|
4976
|
|
|
4977 If you want to catch specific errors, you just have to put the code to be
|
|
|
4978 watched in a try block and add a catch clause for the error message. The
|
|
|
4979 presence of the try conditional causes all errors to be converted to an
|
|
|
4980 exception. No message is displayed and |v:errmsg| is not set then. To find
|
|
|
4981 the right pattern for the ":catch" command, you have to know how the format of
|
|
|
4982 the error exception is.
|
|
|
4983 Error exceptions have the following format: >
|
|
|
4984
|
|
|
4985 Vim({cmdname}):{errmsg}
|
|
|
4986 or >
|
|
|
4987 Vim:{errmsg}
|
|
|
4988
|
|
|
4989 {cmdname} is the name of the command that failed; the second form is used when
|
|
|
4990 the command name is not known. {errmsg} is the error message usually produced
|
|
|
4991 when the error occurs outside try conditionals. It always begins with
|
|
|
4992 a capital "E", followed by a two or three-digit error number, a colon, and
|
|
|
4993 a space.
|
|
|
4994
|
|
|
4995 Examples:
|
|
|
4996
|
|
|
4997 The command >
|
|
|
4998 :unlet novar
|
|
|
4999 normally produces the error message >
|
|
|
5000 E108: No such variable: "novar"
|
|
|
5001 which is converted inside try conditionals to an exception >
|
|
|
5002 Vim(unlet):E108: No such variable: "novar"
|
|
|
5003
|
|
|
5004 The command >
|
|
|
5005 :dwim
|
|
|
5006 normally produces the error message >
|
|
|
5007 E492: Not an editor command: dwim
|
|
|
5008 which is converted inside try conditionals to an exception >
|
|
|
5009 Vim:E492: Not an editor command: dwim
|
|
|
5010
|
|
|
5011 You can catch all ":unlet" errors by a >
|
|
|
5012 :catch /^Vim(unlet):/
|
|
|
5013 or all errors for misspelled command names by a >
|
|
|
5014 :catch /^Vim:E492:/
|
|
|
5015
|
|
|
5016 Some error messages may be produced by different commands: >
|
|
|
5017 :function nofunc
|
|
|
5018 and >
|
|
|
5019 :delfunction nofunc
|
|
|
5020 both produce the error message >
|
|
|
5021 E128: Function name must start with a capital: nofunc
|
|
|
5022 which is converted inside try conditionals to an exception >
|
|
|
5023 Vim(function):E128: Function name must start with a capital: nofunc
|
|
|
5024 or >
|
|
|
5025 Vim(delfunction):E128: Function name must start with a capital: nofunc
|
|
|
5026 respectively. You can catch the error by its number independently on the
|
|
|
5027 command that caused it if you use the following pattern: >
|
|
|
5028 :catch /^Vim(\a\+):E128:/
|
|
|
5029
|
|
|
5030 Some commands like >
|
|
|
5031 :let x = novar
|
|
|
5032 produce multiple error messages, here: >
|
|
|
5033 E121: Undefined variable: novar
|
|
|
5034 E15: Invalid expression: novar
|
|
|
5035 Only the first is used for the exception value, since it is the most specific
|
|
|
5036 one (see |except-several-errors|). So you can catch it by >
|
|
|
5037 :catch /^Vim(\a\+):E121:/
|
|
|
5038
|
|
|
5039 You can catch all errors related to the name "nofunc" by >
|
|
|
5040 :catch /\<nofunc\>/
|
|
|
5041
|
|
|
5042 You can catch all Vim errors in the ":write" and ":read" commands by >
|
|
|
5043 :catch /^Vim(\(write\|read\)):E\d\+:/
|
|
|
5044
|
|
|
5045 You can catch all Vim errors by the pattern >
|
|
|
5046 :catch /^Vim\((\a\+)\)\=:E\d\+:/
|
|
|
5047 <
|
|
|
5048 *catch-text*
|
|
|
5049 NOTE: You should never catch the error message text itself: >
|
|
|
5050 :catch /No such variable/
|
|
|
5051 only works in the english locale, but not when the user has selected
|
|
|
5052 a different language by the |:language| command. It is however helpful to
|
|
|
5053 cite the message text in a comment: >
|
|
|
5054 :catch /^Vim(\a\+):E108:/ " No such variable
|
|
|
5055
|
|
|
5056
|
|
|
5057 IGNORING ERRORS *ignore-errors*
|
|
|
5058
|
|
|
5059 You can ignore errors in a specific Vim command by catching them locally: >
|
|
|
5060
|
|
|
5061 :try
|
|
|
5062 : write
|
|
|
5063 :catch
|
|
|
5064 :endtry
|
|
|
5065
|
|
|
5066 But you are strongly recommended NOT to use this simple form, since it could
|
|
|
5067 catch more than you want. With the ":write" command, some autocommands could
|
|
|
5068 be executed and cause errors not related to writing, for instance: >
|
|
|
5069
|
|
|
5070 :au BufWritePre * unlet novar
|
|
|
5071
|
|
|
5072 There could even be such errors you are not responsible for as a script
|
|
|
5073 writer: a user of your script might have defined such autocommands. You would
|
|
|
5074 then hide the error from the user.
|
|
|
5075 It is much better to use >
|
|
|
5076
|
|
|
5077 :try
|
|
|
5078 : write
|
|
|
5079 :catch /^Vim(write):/
|
|
|
5080 :endtry
|
|
|
5081
|
|
|
5082 which only catches real write errors. So catch only what you'd like to ignore
|
|
|
5083 intentionally.
|
|
|
5084
|
|
|
5085 For a single command that does not cause execution of autocommands, you could
|
|
|
5086 even suppress the conversion of errors to exceptions by the ":silent!"
|
|
|
5087 command: >
|
|
|
5088 :silent! nunmap k
|
|
|
5089 This works also when a try conditional is active.
|
|
|
5090
|
|
|
5091
|
|
|
5092 CATCHING INTERRUPTS *catch-interrupt*
|
|
|
5093
|
|
|
5094 When there are active try conditionals, an interrupt (CTRL-C) is converted to
|
|
|
5095 the exception "Vim:Interrupt". You can catch it like every exception. The
|
|
|
5096 script is not terminated, then.
|
|
|
5097 Example: >
|
|
|
5098
|
|
|
5099 :function! TASK1()
|
|
|
5100 : sleep 10
|
|
|
5101 :endfunction
|
|
|
5102
|
|
|
5103 :function! TASK2()
|
|
|
5104 : sleep 20
|
|
|
5105 :endfunction
|
|
|
5106
|
|
|
5107 :while 1
|
|
|
5108 : let command = input("Type a command: ")
|
|
|
5109 : try
|
|
|
5110 : if command == ""
|
|
|
5111 : continue
|
|
|
5112 : elseif command == "END"
|
|
|
5113 : break
|
|
|
5114 : elseif command == "TASK1"
|
|
|
5115 : call TASK1()
|
|
|
5116 : elseif command == "TASK2"
|
|
|
5117 : call TASK2()
|
|
|
5118 : else
|
|
|
5119 : echo "\nIllegal command:" command
|
|
|
5120 : continue
|
|
|
5121 : endif
|
|
|
5122 : catch /^Vim:Interrupt$/
|
|
|
5123 : echo "\nCommand interrupted"
|
|
|
5124 : " Caught the interrupt. Continue with next prompt.
|
|
|
5125 : endtry
|
|
|
5126 :endwhile
|
|
|
5127
|
|
|
5128 You can interrupt a task here by pressing CTRL-C; the script then asks for
|
|
|
5129 a new command. If you press CTRL-C at the prompt, the script is terminated.
|
|
|
5130
|
|
|
5131 For testing what happens when CTRL-C would be pressed on a specific line in
|
|
|
5132 your script, use the debug mode and execute the |>quit| or |>interrupt|
|
|
|
5133 command on that line. See |debug-scripts|.
|
|
|
5134
|
|
|
5135
|
|
|
5136 CATCHING ALL *catch-all*
|
|
|
5137
|
|
|
5138 The commands >
|
|
|
5139
|
|
|
5140 :catch /.*/
|
|
|
5141 :catch //
|
|
|
5142 :catch
|
|
|
5143
|
|
|
5144 catch everything, error exceptions, interrupt exceptions and exceptions
|
|
|
5145 explicitly thrown by the |:throw| command. This is useful at the top level of
|
|
|
5146 a script in order to catch unexpected things.
|
|
|
5147 Example: >
|
|
|
5148
|
|
|
5149 :try
|
|
|
5150 :
|
|
|
5151 : " do the hard work here
|
|
|
5152 :
|
|
|
5153 :catch /MyException/
|
|
|
5154 :
|
|
|
5155 : " handle known problem
|
|
|
5156 :
|
|
|
5157 :catch /^Vim:Interrupt$/
|
|
|
5158 : echo "Script interrupted"
|
|
|
5159 :catch /.*/
|
|
|
5160 : echo "Internal error (" . v:exception . ")"
|
|
|
5161 : echo " - occurred at " . v:throwpoint
|
|
|
5162 :endtry
|
|
|
5163 :" end of script
|
|
|
5164
|
|
|
5165 Note: Catching all might catch more things than you want. Thus, you are
|
|
|
5166 strongly encouraged to catch only for problems that you can really handle by
|
|
|
5167 specifying a pattern argument to the ":catch".
|
|
|
5168 Example: Catching all could make it nearly impossible to interrupt a script
|
|
|
5169 by pressing CTRL-C: >
|
|
|
5170
|
|
|
5171 :while 1
|
|
|
5172 : try
|
|
|
5173 : sleep 1
|
|
|
5174 : catch
|
|
|
5175 : endtry
|
|
|
5176 :endwhile
|
|
|
5177
|
|
|
5178
|
|
|
5179 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
|
|
|
5180
|
|
|
5181 Exceptions may be used during execution of autocommands. Example: >
|
|
|
5182
|
|
|
5183 :autocmd User x try
|
|
|
5184 :autocmd User x throw "Oops!"
|
|
|
5185 :autocmd User x catch
|
|
|
5186 :autocmd User x echo v:exception
|
|
|
5187 :autocmd User x endtry
|
|
|
5188 :autocmd User x throw "Arrgh!"
|
|
|
5189 :autocmd User x echo "Should not be displayed"
|
|
|
5190 :
|
|
|
5191 :try
|
|
|
5192 : doautocmd User x
|
|
|
5193 :catch
|
|
|
5194 : echo v:exception
|
|
|
5195 :endtry
|
|
|
5196
|
|
|
5197 This displays "Oops!" and "Arrgh!".
|
|
|
5198
|
|
|
5199 *except-autocmd-Pre*
|
|
|
5200 For some commands, autocommands get executed before the main action of the
|
|
|
5201 command takes place. If an exception is thrown and not caught in the sequence
|
|
|
5202 of autocommands, the sequence and the command that caused its execution are
|
|
|
5203 abandoned and the exception is propagated to the caller of the command.
|
|
|
5204 Example: >
|
|
|
5205
|
|
|
5206 :autocmd BufWritePre * throw "FAIL"
|
|
|
5207 :autocmd BufWritePre * echo "Should not be displayed"
|
|
|
5208 :
|
|
|
5209 :try
|
|
|
5210 : write
|
|
|
5211 :catch
|
|
|
5212 : echo "Caught:" v:exception "from" v:throwpoint
|
|
|
5213 :endtry
|
|
|
5214
|
|
|
5215 Here, the ":write" command does not write the file currently being edited (as
|
|
|
5216 you can see by checking 'modified'), since the exception from the BufWritePre
|
|
|
5217 autocommand abandons the ":write". The exception is then caught and the
|
|
|
5218 script displays: >
|
|
|
5219
|
|
|
5220 Caught: FAIL from BufWrite Auto commands for "*"
|
|
|
5221 <
|
|
|
5222 *except-autocmd-Post*
|
|
|
5223 For some commands, autocommands get executed after the main action of the
|
|
|
5224 command has taken place. If this main action fails and the command is inside
|
|
|
5225 an active try conditional, the autocommands are skipped and an error exception
|
|
|
5226 is thrown that can be caught by the caller of the command.
|
|
|
5227 Example: >
|
|
|
5228
|
|
|
5229 :autocmd BufWritePost * echo "File successfully written!"
|
|
|
5230 :
|
|
|
5231 :try
|
|
|
5232 : write /i/m/p/o/s/s/i/b/l/e
|
|
|
5233 :catch
|
|
|
5234 : echo v:exception
|
|
|
5235 :endtry
|
|
|
5236
|
|
|
5237 This just displays: >
|
|
|
5238
|
|
|
5239 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
|
|
|
5240
|
|
|
5241 If you really need to execute the autocommands even when the main action
|
|
|
5242 fails, trigger the event from the catch clause.
|
|
|
5243 Example: >
|
|
|
5244
|
|
|
5245 :autocmd BufWritePre * set noreadonly
|
|
|
5246 :autocmd BufWritePost * set readonly
|
|
|
5247 :
|
|
|
5248 :try
|
|
|
5249 : write /i/m/p/o/s/s/i/b/l/e
|
|
|
5250 :catch
|
|
|
5251 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
|
|
|
5252 :endtry
|
|
|
5253 <
|
|
|
5254 You can also use ":silent!": >
|
|
|
5255
|
|
|
5256 :let x = "ok"
|
|
|
5257 :let v:errmsg = ""
|
|
|
5258 :autocmd BufWritePost * if v:errmsg != ""
|
|
|
5259 :autocmd BufWritePost * let x = "after fail"
|
|
|
5260 :autocmd BufWritePost * endif
|
|
|
5261 :try
|
|
|
5262 : silent! write /i/m/p/o/s/s/i/b/l/e
|
|
|
5263 :catch
|
|
|
5264 :endtry
|
|
|
5265 :echo x
|
|
|
5266
|
|
|
5267 This displays "after fail".
|
|
|
5268
|
|
|
5269 If the main action of the command does not fail, exceptions from the
|
|
|
5270 autocommands will be catchable by the caller of the command: >
|
|
|
5271
|
|
|
5272 :autocmd BufWritePost * throw ":-("
|
|
|
5273 :autocmd BufWritePost * echo "Should not be displayed"
|
|
|
5274 :
|
|
|
5275 :try
|
|
|
5276 : write
|
|
|
5277 :catch
|
|
|
5278 : echo v:exception
|
|
|
5279 :endtry
|
|
|
5280 <
|
|
|
5281 *except-autocmd-Cmd*
|
|
|
5282 For some commands, the normal action can be replaced by a sequence of
|
|
|
5283 autocommands. Exceptions from that sequence will be catchable by the caller
|
|
|
5284 of the command.
|
|
|
5285 Example: For the ":write" command, the caller cannot know whether the file
|
|
|
5286 had actually been written when the exception occurred. You need to tell it in
|
|
|
5287 some way. >
|
|
|
5288
|
|
|
5289 :if !exists("cnt")
|
|
|
5290 : let cnt = 0
|
|
|
5291 :
|
|
|
5292 : autocmd BufWriteCmd * if &modified
|
|
|
5293 : autocmd BufWriteCmd * let cnt = cnt + 1
|
|
|
5294 : autocmd BufWriteCmd * if cnt % 3 == 2
|
|
|
5295 : autocmd BufWriteCmd * throw "BufWriteCmdError"
|
|
|
5296 : autocmd BufWriteCmd * endif
|
|
|
5297 : autocmd BufWriteCmd * write | set nomodified
|
|
|
5298 : autocmd BufWriteCmd * if cnt % 3 == 0
|
|
|
5299 : autocmd BufWriteCmd * throw "BufWriteCmdError"
|
|
|
5300 : autocmd BufWriteCmd * endif
|
|
|
5301 : autocmd BufWriteCmd * echo "File successfully written!"
|
|
|
5302 : autocmd BufWriteCmd * endif
|
|
|
5303 :endif
|
|
|
5304 :
|
|
|
5305 :try
|
|
|
5306 : write
|
|
|
5307 :catch /^BufWriteCmdError$/
|
|
|
5308 : if &modified
|
|
|
5309 : echo "Error on writing (file contents not changed)"
|
|
|
5310 : else
|
|
|
5311 : echo "Error after writing"
|
|
|
5312 : endif
|
|
|
5313 :catch /^Vim(write):/
|
|
|
5314 : echo "Error on writing"
|
|
|
5315 :endtry
|
|
|
5316
|
|
|
5317 When this script is sourced several times after making changes, it displays
|
|
|
5318 first >
|
|
|
5319 File successfully written!
|
|
|
5320 then >
|
|
|
5321 Error on writing (file contents not changed)
|
|
|
5322 then >
|
|
|
5323 Error after writing
|
|
|
5324 etc.
|
|
|
5325
|
|
|
5326 *except-autocmd-ill*
|
|
|
5327 You cannot spread a try conditional over autocommands for different events.
|
|
|
5328 The following code is ill-formed: >
|
|
|
5329
|
|
|
5330 :autocmd BufWritePre * try
|
|
|
5331 :
|
|
|
5332 :autocmd BufWritePost * catch
|
|
|
5333 :autocmd BufWritePost * echo v:exception
|
|
|
5334 :autocmd BufWritePost * endtry
|
|
|
5335 :
|
|
|
5336 :write
|
|
|
5337
|
|
|
5338
|
|
|
5339 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
|
|
|
5340
|
|
|
5341 Some programming languages allow to use hierarchies of exception classes or to
|
|
|
5342 pass additional information with the object of an exception class. You can do
|
|
|
5343 similar things in Vim.
|
|
|
5344 In order to throw an exception from a hierarchy, just throw the complete
|
|
|
5345 class name with the components separated by a colon, for instance throw the
|
|
|
5346 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
|
|
|
5347 When you want to pass additional information with your exception class, add
|
|
|
5348 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
|
|
|
5349 for an error when writing "myfile".
|
|
|
5350 With the appropriate patterns in the ":catch" command, you can catch for
|
|
|
5351 base classes or derived classes of your hierarchy. Additional information in
|
|
|
5352 parentheses can be cut out from |v:exception| with the ":substitute" command.
|
|
|
5353 Example: >
|
|
|
5354
|
|
|
5355 :function! CheckRange(a, func)
|
|
|
5356 : if a:a < 0
|
|
|
5357 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
|
|
|
5358 : endif
|
|
|
5359 :endfunction
|
|
|
5360 :
|
|
|
5361 :function! Add(a, b)
|
|
|
5362 : call CheckRange(a:a, "Add")
|
|
|
5363 : call CheckRange(a:b, "Add")
|
|
|
5364 : let c = a:a + a:b
|
|
|
5365 : if c < 0
|
|
|
5366 : throw "EXCEPT:MATHERR:OVERFLOW"
|
|
|
5367 : endif
|
|
|
5368 : return c
|
|
|
5369 :endfunction
|
|
|
5370 :
|
|
|
5371 :function! Div(a, b)
|
|
|
5372 : call CheckRange(a:a, "Div")
|
|
|
5373 : call CheckRange(a:b, "Div")
|
|
|
5374 : if (a:b == 0)
|
|
|
5375 : throw "EXCEPT:MATHERR:ZERODIV"
|
|
|
5376 : endif
|
|
|
5377 : return a:a / a:b
|
|
|
5378 :endfunction
|
|
|
5379 :
|
|
|
5380 :function! Write(file)
|
|
|
5381 : try
|
|
|
5382 : execute "write" a:file
|
|
|
5383 : catch /^Vim(write):/
|
|
|
5384 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
|
|
|
5385 : endtry
|
|
|
5386 :endfunction
|
|
|
5387 :
|
|
|
5388 :try
|
|
|
5389 :
|
|
|
5390 : " something with arithmetics and I/O
|
|
|
5391 :
|
|
|
5392 :catch /^EXCEPT:MATHERR:RANGE/
|
|
|
5393 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
|
|
|
5394 : echo "Range error in" function
|
|
|
5395 :
|
|
|
5396 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
|
|
|
5397 : echo "Math error"
|
|
|
5398 :
|
|
|
5399 :catch /^EXCEPT:IO/
|
|
|
5400 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
|
|
|
5401 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
|
|
|
5402 : if file !~ '^/'
|
|
|
5403 : let file = dir . "/" . file
|
|
|
5404 : endif
|
|
|
5405 : echo 'I/O error for "' . file . '"'
|
|
|
5406 :
|
|
|
5407 :catch /^EXCEPT/
|
|
|
5408 : echo "Unspecified error"
|
|
|
5409 :
|
|
|
5410 :endtry
|
|
|
5411
|
|
|
5412 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
|
|
|
5413 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
|
|
|
5414 exceptions with the "Vim" prefix; they are reserved for Vim.
|
|
|
5415 Vim error exceptions are parameterized with the name of the command that
|
|
|
5416 failed, if known. See |catch-errors|.
|
|
|
5417
|
|
|
5418
|
|
|
5419 PECULIARITIES
|
|
|
5420 *except-compat*
|
|
|
5421 The exception handling concept requires that the command sequence causing the
|
|
|
5422 exception is aborted immediately and control is transferred to finally clauses
|
|
|
5423 and/or a catch clause.
|
|
|
5424
|
|
|
5425 In the Vim script language there are cases where scripts and functions
|
|
|
5426 continue after an error: in functions without the "abort" flag or in a command
|
|
|
5427 after ":silent!", control flow goes to the following line, and outside
|
|
|
5428 functions, control flow goes to the line following the outermost ":endwhile"
|
|
|
5429 or ":endif". On the other hand, errors should be catchable as exceptions
|
|
|
5430 (thus, requiring the immediate abortion).
|
|
|
5431
|
|
|
5432 This problem has been solved by converting errors to exceptions and using
|
|
|
5433 immediate abortion (if not suppressed by ":silent!") only when a try
|
|
|
5434 conditional is active. This is no restriction since an (error) exception can
|
|
|
5435 be caught only from an active try conditional. If you want an immediate
|
|
|
5436 termination without catching the error, just use a try conditional without
|
|
|
5437 catch clause. (You can cause cleanup code being executed before termination
|
|
|
5438 by specifying a finally clause.)
|
|
|
5439
|
|
|
5440 When no try conditional is active, the usual abortion and continuation
|
|
|
5441 behavior is used instead of immediate abortion. This ensures compatibility of
|
|
|
5442 scripts written for Vim 6.1 and earlier.
|
|
|
5443
|
|
|
5444 However, when sourcing an existing script that does not use exception handling
|
|
|
5445 commands (or when calling one of its functions) from inside an active try
|
|
|
5446 conditional of a new script, you might change the control flow of the existing
|
|
|
5447 script on error. You get the immediate abortion on error and can catch the
|
|
|
5448 error in the new script. If however the sourced script suppresses error
|
|
|
5449 messages by using the ":silent!" command (checking for errors by testing
|
|
|
5450 |v:errmsg| if appropriate), its execution path is not changed. The error is
|
|
|
5451 not converted to an exception. (See |:silent|.) So the only remaining cause
|
|
|
5452 where this happens is for scripts that don't care about errors and produce
|
|
|
5453 error messages. You probably won't want to use such code from your new
|
|
|
5454 scripts.
|
|
|
5455
|
|
|
5456 *except-syntax-err*
|
|
|
5457 Syntax errors in the exception handling commands are never caught by any of
|
|
|
5458 the ":catch" commands of the try conditional they belong to. Its finally
|
|
|
5459 clauses, however, is executed.
|
|
|
5460 Example: >
|
|
|
5461
|
|
|
5462 :try
|
|
|
5463 : try
|
|
|
5464 : throw 4711
|
|
|
5465 : catch /\(/
|
|
|
5466 : echo "in catch with syntax error"
|
|
|
5467 : catch
|
|
|
5468 : echo "inner catch-all"
|
|
|
5469 : finally
|
|
|
5470 : echo "inner finally"
|
|
|
5471 : endtry
|
|
|
5472 :catch
|
|
|
5473 : echo 'outer catch-all caught "' . v:exception . '"'
|
|
|
5474 : finally
|
|
|
5475 : echo "outer finally"
|
|
|
5476 :endtry
|
|
|
5477
|
|
|
5478 This displays: >
|
|
|
5479 inner finally
|
|
|
5480 outer catch-all caught "Vim(catch):E54: Unmatched \("
|
|
|
5481 outer finally
|
|
|
5482 The original exception is discarded and an error exception is raised, instead.
|
|
|
5483
|
|
|
5484 *except-single-line*
|
|
|
5485 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
|
|
|
5486 a single line, but then syntax errors may make it difficult to recognize the
|
|
|
5487 "catch" line, thus you better avoid this.
|
|
|
5488 Example: >
|
|
|
5489 :try | unlet! foo # | catch | endtry
|
|
|
5490 raises an error exception for the trailing characters after the ":unlet!"
|
|
|
5491 argument, but does not see the ":catch" and ":endtry" commands, so that the
|
|
|
5492 error exception is discarded and the "E488: Trailing characters" message gets
|
|
|
5493 displayed.
|
|
|
5494
|
|
|
5495 *except-several-errors*
|
|
|
5496 When several errors appear in a single command, the first error message is
|
|
|
5497 usually the most specific one and therefor converted to the error exception.
|
|
|
5498 Example: >
|
|
|
5499 echo novar
|
|
|
5500 causes >
|
|
|
5501 E121: Undefined variable: novar
|
|
|
5502 E15: Invalid expression: novar
|
|
|
5503 The value of the error exception inside try conditionals is: >
|
|
|
5504 Vim(echo):E121: Undefined variable: novar
|
|
|
5505 < *except-syntax-error*
|
|
|
5506 But when a syntax error is detected after a normal error in the same command,
|
|
|
5507 the syntax error is used for the exception being thrown.
|
|
|
5508 Example: >
|
|
|
5509 unlet novar #
|
|
|
5510 causes >
|
|
|
5511 E108: No such variable: "novar"
|
|
|
5512 E488: Trailing characters
|
|
|
5513 The value of the error exception inside try conditionals is: >
|
|
|
5514 Vim(unlet):E488: Trailing characters
|
|
|
5515 This is done because the syntax error might change the execution path in a way
|
|
|
5516 not intended by the user. Example: >
|
|
|
5517 try
|
|
|
5518 try | unlet novar # | catch | echo v:exception | endtry
|
|
|
5519 catch /.*/
|
|
|
5520 echo "outer catch:" v:exception
|
|
|
5521 endtry
|
|
|
5522 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
|
|
|
5523 a "E600: Missing :endtry" error message is given, see |except-single-line|.
|
|
|
5524
|
|
|
5525 ==============================================================================
|
|
|
5526 9. Examples *eval-examples*
|
|
|
5527
|
|
|
5528 Printing in Hex ~
|
|
|
5529 >
|
|
|
5530 :" The function Nr2Hex() returns the Hex string of a number.
|
|
|
5531 :func Nr2Hex(nr)
|
|
|
5532 : let n = a:nr
|
|
|
5533 : let r = ""
|
|
|
5534 : while n
|
|
|
5535 : let r = '0123456789ABCDEF'[n % 16] . r
|
|
|
5536 : let n = n / 16
|
|
|
5537 : endwhile
|
|
|
5538 : return r
|
|
|
5539 :endfunc
|
|
|
5540
|
|
|
5541 :" The function String2Hex() converts each character in a string to a two
|
|
|
5542 :" character Hex string.
|
|
|
5543 :func String2Hex(str)
|
|
|
5544 : let out = ''
|
|
|
5545 : let ix = 0
|
|
|
5546 : while ix < strlen(a:str)
|
|
|
5547 : let out = out . Nr2Hex(char2nr(a:str[ix]))
|
|
|
5548 : let ix = ix + 1
|
|
|
5549 : endwhile
|
|
|
5550 : return out
|
|
|
5551 :endfunc
|
|
|
5552
|
|
|
5553 Example of its use: >
|
|
|
5554 :echo Nr2Hex(32)
|
|
|
5555 result: "20" >
|
|
|
5556 :echo String2Hex("32")
|
|
|
5557 result: "3332"
|
|
|
5558
|
|
|
5559
|
|
|
5560 Sorting lines (by Robert Webb) ~
|
|
|
5561
|
|
|
5562 Here is a Vim script to sort lines. Highlight the lines in Vim and type
|
|
|
5563 ":Sort". This doesn't call any external programs so it'll work on any
|
|
|
5564 platform. The function Sort() actually takes the name of a comparison
|
|
|
5565 function as its argument, like qsort() does in C. So you could supply it
|
|
|
5566 with different comparison functions in order to sort according to date etc.
|
|
|
5567 >
|
|
|
5568 :" Function for use with Sort(), to compare two strings.
|
|
|
5569 :func! Strcmp(str1, str2)
|
|
|
5570 : if (a:str1 < a:str2)
|
|
|
5571 : return -1
|
|
|
5572 : elseif (a:str1 > a:str2)
|
|
|
5573 : return 1
|
|
|
5574 : else
|
|
|
5575 : return 0
|
|
|
5576 : endif
|
|
|
5577 :endfunction
|
|
|
5578
|
|
|
5579 :" Sort lines. SortR() is called recursively.
|
|
|
5580 :func! SortR(start, end, cmp)
|
|
|
5581 : if (a:start >= a:end)
|
|
|
5582 : return
|
|
|
5583 : endif
|
|
|
5584 : let partition = a:start - 1
|
|
|
5585 : let middle = partition
|
|
|
5586 : let partStr = getline((a:start + a:end) / 2)
|
|
|
5587 : let i = a:start
|
|
|
5588 : while (i <= a:end)
|
|
|
5589 : let str = getline(i)
|
|
|
5590 : exec "let result = " . a:cmp . "(str, partStr)"
|
|
|
5591 : if (result <= 0)
|
|
|
5592 : " Need to put it before the partition. Swap lines i and partition.
|
|
|
5593 : let partition = partition + 1
|
|
|
5594 : if (result == 0)
|
|
|
5595 : let middle = partition
|
|
|
5596 : endif
|
|
|
5597 : if (i != partition)
|
|
|
5598 : let str2 = getline(partition)
|
|
|
5599 : call setline(i, str2)
|
|
|
5600 : call setline(partition, str)
|
|
|
5601 : endif
|
|
|
5602 : endif
|
|
|
5603 : let i = i + 1
|
|
|
5604 : endwhile
|
|
|
5605
|
|
|
5606 : " Now we have a pointer to the "middle" element, as far as partitioning
|
|
|
5607 : " goes, which could be anywhere before the partition. Make sure it is at
|
|
|
5608 : " the end of the partition.
|
|
|
5609 : if (middle != partition)
|
|
|
5610 : let str = getline(middle)
|
|
|
5611 : let str2 = getline(partition)
|
|
|
5612 : call setline(middle, str2)
|
|
|
5613 : call setline(partition, str)
|
|
|
5614 : endif
|
|
|
5615 : call SortR(a:start, partition - 1, a:cmp)
|
|
|
5616 : call SortR(partition + 1, a:end, a:cmp)
|
|
|
5617 :endfunc
|
|
|
5618
|
|
|
5619 :" To Sort a range of lines, pass the range to Sort() along with the name of a
|
|
|
5620 :" function that will compare two lines.
|
|
|
5621 :func! Sort(cmp) range
|
|
|
5622 : call SortR(a:firstline, a:lastline, a:cmp)
|
|
|
5623 :endfunc
|
|
|
5624
|
|
|
5625 :" :Sort takes a range of lines and sorts them.
|
|
|
5626 :command! -nargs=0 -range Sort <line1>,<line2>call Sort("Strcmp")
|
|
|
5627 <
|
|
|
5628 *sscanf*
|
|
|
5629 There is no sscanf() function in Vim. If you need to extract parts from a
|
|
|
5630 line, you can use matchstr() and substitute() to do it. This example shows
|
|
|
5631 how to get the file name, line number and column number out of a line like
|
|
|
5632 "foobar.txt, 123, 45". >
|
|
|
5633 :" Set up the match bit
|
|
|
5634 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
|
|
|
5635 :"get the part matching the whole expression
|
|
|
5636 :let l = matchstr(line, mx)
|
|
|
5637 :"get each item out of the match
|
|
|
5638 :let file = substitute(l, mx, '\1', '')
|
|
|
5639 :let lnum = substitute(l, mx, '\2', '')
|
|
|
5640 :let col = substitute(l, mx, '\3', '')
|
|
|
5641
|
|
|
5642 The input is in the variable "line", the results in the variables "file",
|
|
|
5643 "lnum" and "col". (idea from Michael Geddes)
|
|
|
5644
|
|
|
5645 ==============================================================================
|
|
|
5646 10. No +eval feature *no-eval-feature*
|
|
|
5647
|
|
|
5648 When the |+eval| feature was disabled at compile time, none of the expression
|
|
|
5649 evaluation commands are available. To prevent this from causing Vim scripts
|
|
|
5650 to generate all kinds of errors, the ":if" and ":endif" commands are still
|
|
|
5651 recognized, though the argument of the ":if" and everything between the ":if"
|
|
|
5652 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
|
|
|
5653 only if the commands are at the start of the line. The ":else" command is not
|
|
|
5654 recognized.
|
|
|
5655
|
|
|
5656 Example of how to avoid executing commands when the |+eval| feature is
|
|
|
5657 missing: >
|
|
|
5658
|
|
|
5659 :if 1
|
|
|
5660 : echo "Expression evaluation is compiled in"
|
|
|
5661 :else
|
|
|
5662 : echo "You will _never_ see this message"
|
|
|
5663 :endif
|
|
|
5664
|
|
|
5665 ==============================================================================
|
|
|
5666 11. The sandbox *eval-sandbox* *sandbox* *E48*
|
|
|
5667
|
|
|
5668 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
|
|
|
5669 options are evaluated in a sandbox. This means that you are protected from
|
|
|
5670 these expressions having nasty side effects. This gives some safety for when
|
|
|
5671 these options are set from a modeline. It is also used when the command from
|
|
|
5672 a tags file is executed.
|
|
29
|
5673 The sandbox is also used for the |:sandbox| command.
|
|
7
|
5674
|
|
|
5675 These items are not allowed in the sandbox:
|
|
|
5676 - changing the buffer text
|
|
|
5677 - defining or changing mapping, autocommands, functions, user commands
|
|
|
5678 - setting certain options (see |option-summary|)
|
|
|
5679 - executing a shell command
|
|
|
5680 - reading or writing a file
|
|
|
5681 - jumping to another buffer or editing a file
|
|
29
|
5682 This is not guaranteed 100% secure, but it should block most attacks.
|
|
|
5683
|
|
|
5684 *:san* *:sandbox*
|
|
|
5685 :sandbox {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
|
|
|
5686 option that may have been set from a modeline, e.g.
|
|
|
5687 'foldexpr'.
|
|
|
5688
|
|
7
|
5689
|
|
|
5690 vim:tw=78:ts=8:ft=help:norl:
|
