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