|
1621
|
1 *eval.txt* For Vim version 7.2a. Last change: 2008 Jun 24
|
|
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
7
|
5
|
|
|
6
|
|
|
7 Expression evaluation *expression* *expr* *E15* *eval*
|
|
|
8
|
|
|
9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|.
|
|
|
10
|
|
|
11 Note: Expression evaluation can be disabled at compile time. If this has been
|
|
1621
|
12 done, the features in this document are not available. See |+eval| and
|
|
99
|
13 |no-eval-feature|.
|
|
7
|
14
|
|
85
|
15 1. Variables |variables|
|
|
|
16 1.1 Variable types
|
|
87
|
17 1.2 Function references |Funcref|
|
|
161
|
18 1.3 Lists |Lists|
|
|
99
|
19 1.4 Dictionaries |Dictionaries|
|
|
|
20 1.5 More about variables |more-variables|
|
|
85
|
21 2. Expression syntax |expression-syntax|
|
|
|
22 3. Internal variable |internal-variables|
|
|
|
23 4. Builtin Functions |functions|
|
|
|
24 5. Defining functions |user-functions|
|
|
|
25 6. Curly braces names |curly-braces-names|
|
|
|
26 7. Commands |expression-commands|
|
|
|
27 8. Exception handling |exception-handling|
|
|
|
28 9. Examples |eval-examples|
|
|
|
29 10. No +eval feature |no-eval-feature|
|
|
|
30 11. The sandbox |eval-sandbox|
|
|
634
|
31 12. Textlock |textlock|
|
|
7
|
32
|
|
|
33 {Vi does not have any of these commands}
|
|
|
34
|
|
|
35 ==============================================================================
|
|
|
36 1. Variables *variables*
|
|
|
37
|
|
85
|
38 1.1 Variable types ~
|
|
114
|
39 *E712*
|
|
1621
|
40 There are six types of variables:
|
|
|
41
|
|
|
42 Number A 32 bit signed number. |expr-number| *Number*
|
|
99
|
43 Examples: -123 0x10 0177
|
|
|
44
|
|
1621
|
45 Float A floating point number. |floating-point-format| *Float*
|
|
|
46 {only when compiled with the |+float| feature}
|
|
|
47 Examples: 123.456 1.15e-6 -1.1e3
|
|
|
48
|
|
99
|
49 String A NUL terminated string of 8-bit unsigned characters (bytes).
|
|
1621
|
50 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
|
|
99
|
51
|
|
|
52 Funcref A reference to a function |Funcref|.
|
|
|
53 Example: function("strlen")
|
|
|
54
|
|
|
55 List An ordered sequence of items |List|.
|
|
|
56 Example: [1, 2, ['a', 'b']]
|
|
55
|
57
|
|
370
|
58 Dictionary An associative, unordered array: Each entry has a key and a
|
|
|
59 value. |Dictionary|
|
|
|
60 Example: {'blue': "#0000ff", 'red': "#ff0000"}
|
|
|
61
|
|
55
|
62 The Number and String types are converted automatically, depending on how they
|
|
|
63 are used.
|
|
7
|
64
|
|
|
65 Conversion from a Number to a String is by making the ASCII representation of
|
|
|
66 the Number. Examples: >
|
|
|
67 Number 123 --> String "123"
|
|
|
68 Number 0 --> String "0"
|
|
|
69 Number -1 --> String "-1"
|
|
|
70
|
|
|
71 Conversion from a String to a Number is done by converting the first digits
|
|
|
72 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
|
|
|
73 the String doesn't start with digits, the result is zero. Examples: >
|
|
|
74 String "456" --> Number 456
|
|
|
75 String "6bar" --> Number 6
|
|
|
76 String "foo" --> Number 0
|
|
|
77 String "0xf1" --> Number 241
|
|
|
78 String "0100" --> Number 64
|
|
|
79 String "-8" --> Number -8
|
|
|
80 String "+8" --> Number 0
|
|
|
81
|
|
|
82 To force conversion from String to Number, add zero to it: >
|
|
|
83 :echo "0100" + 0
|
|
782
|
84 < 64 ~
|
|
|
85
|
|
|
86 To avoid a leading zero to cause octal conversion, or for using a different
|
|
|
87 base, use |str2nr()|.
|
|
7
|
88
|
|
|
89 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
|
|
|
90
|
|
|
91 Note that in the command >
|
|
|
92 :if "foo"
|
|
|
93 "foo" is converted to 0, which means FALSE. To test for a non-empty string,
|
|
|
94 use strlen(): >
|
|
|
95 :if strlen("foo")
|
|
153
|
96 < *E745* *E728* *E703* *E729* *E730* *E731*
|
|
|
97 List, Dictionary and Funcref types are not automatically converted.
|
|
85
|
98
|
|
1621
|
99 *E805* *E806* *E808*
|
|
|
100 When mixing Number and Float the Number is converted to Float. Otherwise
|
|
|
101 there is no automatic conversion of Float. You can use str2float() for String
|
|
|
102 to Float, printf() for Float to String and float2nr() for Float to Number.
|
|
|
103
|
|
|
104 *E706* *sticky-type-checking*
|
|
85
|
105 You will get an error if you try to change the type of a variable. You need
|
|
|
106 to |:unlet| it first to avoid this error. String and Number are considered
|
|
1621
|
107 equivalent though, as well are Float and Number. Consider this sequence of
|
|
|
108 commands: >
|
|
85
|
109 :let l = "string"
|
|
87
|
110 :let l = 44 " changes type from String to Number
|
|
1621
|
111 :let l = [1, 2, 3] " error! l is still a Number
|
|
|
112 :let l = 4.4 " changes type from Number to Float
|
|
|
113 :let l = "string" " error!
|
|
85
|
114
|
|
|
115
|
|
87
|
116 1.2 Function references ~
|
|
153
|
117 *Funcref* *E695* *E718*
|
|
1621
|
118 A Funcref variable is obtained with the |function()| function. It can be used
|
|
114
|
119 in an expression in the place of a function name, before the parenthesis
|
|
|
120 around the arguments, to invoke the function it refers to. Example: >
|
|
55
|
121
|
|
|
122 :let Fn = function("MyFunc")
|
|
|
123 :echo Fn()
|
|
114
|
124 < *E704* *E705* *E707*
|
|
819
|
125 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
|
|
|
126 cannot have both a Funcref variable and a function with the same name.
|
|
85
|
127
|
|
114
|
128 A special case is defining a function and directly assigning its Funcref to a
|
|
|
129 Dictionary entry. Example: >
|
|
|
130 :function dict.init() dict
|
|
|
131 : let self.val = 0
|
|
|
132 :endfunction
|
|
|
133
|
|
|
134 The key of the Dictionary can start with a lower case letter. The actual
|
|
|
135 function name is not used here. Also see |numbered-function|.
|
|
|
136
|
|
|
137 A Funcref can also be used with the |:call| command: >
|
|
|
138 :call Fn()
|
|
|
139 :call dict.init()
|
|
85
|
140
|
|
|
141 The name of the referenced function can be obtained with |string()|. >
|
|
119
|
142 :let func = string(Fn)
|
|
85
|
143
|
|
|
144 You can use |call()| to invoke a Funcref and use a list variable for the
|
|
|
145 arguments: >
|
|
119
|
146 :let r = call(Fn, mylist)
|
|
85
|
147
|
|
|
148
|
|
87
|
149 1.3 Lists ~
|
|
161
|
150 *List* *Lists* *E686*
|
|
55
|
151 A List is an ordered sequence of items. An item can be of any type. Items
|
|
1621
|
152 can be accessed by their index number. Items can be added and removed at any
|
|
55
|
153 position in the sequence.
|
|
|
154
|
|
85
|
155
|
|
|
156 List creation ~
|
|
|
157 *E696* *E697*
|
|
55
|
158 A List is created with a comma separated list of items in square brackets.
|
|
85
|
159 Examples: >
|
|
|
160 :let mylist = [1, two, 3, "four"]
|
|
|
161 :let emptylist = []
|
|
55
|
162
|
|
1621
|
163 An item can be any expression. Using a List for an item creates a
|
|
842
|
164 List of Lists: >
|
|
85
|
165 :let nestlist = [[11, 12], [21, 22], [31, 32]]
|
|
55
|
166
|
|
|
167 An extra comma after the last item is ignored.
|
|
|
168
|
|
85
|
169
|
|
|
170 List index ~
|
|
|
171 *list-index* *E684*
|
|
55
|
172 An item in the List can be accessed by putting the index in square brackets
|
|
85
|
173 after the List. Indexes are zero-based, thus the first item has index zero. >
|
|
|
174 :let item = mylist[0] " get the first item: 1
|
|
55
|
175 :let item = mylist[2] " get the third item: 3
|
|
85
|
176
|
|
87
|
177 When the resulting item is a list this can be repeated: >
|
|
85
|
178 :let item = nestlist[0][1] " get the first list, second item: 12
|
|
55
|
179 <
|
|
85
|
180 A negative index is counted from the end. Index -1 refers to the last item in
|
|
|
181 the List, -2 to the last but one item, etc. >
|
|
55
|
182 :let last = mylist[-1] " get the last item: "four"
|
|
|
183
|
|
85
|
184 To avoid an error for an invalid index use the |get()| function. When an item
|
|
87
|
185 is not available it returns zero or the default value you specify: >
|
|
85
|
186 :echo get(mylist, idx)
|
|
|
187 :echo get(mylist, idx, "NONE")
|
|
|
188
|
|
|
189
|
|
|
190 List concatenation ~
|
|
|
191
|
|
|
192 Two lists can be concatenated with the "+" operator: >
|
|
|
193 :let longlist = mylist + [5, 6]
|
|
119
|
194 :let mylist += [7, 8]
|
|
85
|
195
|
|
|
196 To prepend or append an item turn the item into a list by putting [] around
|
|
|
197 it. To change a list in-place see |list-modification| below.
|
|
|
198
|
|
|
199
|
|
|
200 Sublist ~
|
|
|
201
|
|
55
|
202 A part of the List can be obtained by specifying the first and last index,
|
|
|
203 separated by a colon in square brackets: >
|
|
85
|
204 :let shortlist = mylist[2:-1] " get List [3, "four"]
|
|
55
|
205
|
|
|
206 Omitting the first index is similar to zero. Omitting the last index is
|
|
1156
|
207 similar to -1. >
|
|
90
|
208 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
|
|
|
209 :let shortlist = mylist[2:2] " List with one item: [3]
|
|
|
210 :let otherlist = mylist[:] " make a copy of the List
|
|
85
|
211
|
|
842
|
212 If the first index is beyond the last item of the List or the second item is
|
|
|
213 before the first item, the result is an empty list. There is no error
|
|
|
214 message.
|
|
|
215
|
|
|
216 If the second index is equal to or greater than the length of the list the
|
|
|
217 length minus one is used: >
|
|
829
|
218 :let mylist = [0, 1, 2, 3]
|
|
|
219 :echo mylist[2:8] " result: [2, 3]
|
|
|
220
|
|
270
|
221 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
|
|
1621
|
222 using a single letter variable before the ":". Insert a space when needed:
|
|
270
|
223 mylist[s : e].
|
|
|
224
|
|
85
|
225
|
|
|
226 List identity ~
|
|
99
|
227 *list-identity*
|
|
85
|
228 When variable "aa" is a list and you assign it to another variable "bb", both
|
|
|
229 variables refer to the same list. Thus changing the list "aa" will also
|
|
|
230 change "bb": >
|
|
|
231 :let aa = [1, 2, 3]
|
|
|
232 :let bb = aa
|
|
|
233 :call add(aa, 4)
|
|
|
234 :echo bb
|
|
114
|
235 < [1, 2, 3, 4]
|
|
85
|
236
|
|
|
237 Making a copy of a list is done with the |copy()| function. Using [:] also
|
|
|
238 works, as explained above. This creates a shallow copy of the list: Changing
|
|
87
|
239 a list item in the list will also change the item in the copied list: >
|
|
85
|
240 :let aa = [[1, 'a'], 2, 3]
|
|
|
241 :let bb = copy(aa)
|
|
114
|
242 :call add(aa, 4)
|
|
85
|
243 :let aa[0][1] = 'aaa'
|
|
|
244 :echo aa
|
|
114
|
245 < [[1, aaa], 2, 3, 4] >
|
|
85
|
246 :echo bb
|
|
114
|
247 < [[1, aaa], 2, 3]
|
|
85
|
248
|
|
87
|
249 To make a completely independent list use |deepcopy()|. This also makes a
|
|
114
|
250 copy of the values in the list, recursively. Up to a hundred levels deep.
|
|
85
|
251
|
|
|
252 The operator "is" can be used to check if two variables refer to the same
|
|
114
|
253 List. "isnot" does the opposite. In contrast "==" compares if two lists have
|
|
87
|
254 the same value. >
|
|
|
255 :let alist = [1, 2, 3]
|
|
|
256 :let blist = [1, 2, 3]
|
|
|
257 :echo alist is blist
|
|
114
|
258 < 0 >
|
|
87
|
259 :echo alist == blist
|
|
114
|
260 < 1
|
|
85
|
261
|
|
323
|
262 Note about comparing lists: Two lists are considered equal if they have the
|
|
|
263 same length and all items compare equal, as with using "==". There is one
|
|
388
|
264 exception: When comparing a number with a string they are considered
|
|
|
265 different. There is no automatic type conversion, as with using "==" on
|
|
|
266 variables. Example: >
|
|
|
267 echo 4 == "4"
|
|
323
|
268 < 1 >
|
|
388
|
269 echo [4] == ["4"]
|
|
323
|
270 < 0
|
|
|
271
|
|
388
|
272 Thus comparing Lists is more strict than comparing numbers and strings. You
|
|
1621
|
273 can compare simple values this way too by putting them in a list: >
|
|
388
|
274
|
|
|
275 :let a = 5
|
|
|
276 :let b = "5"
|
|
1621
|
277 :echo a == b
|
|
388
|
278 < 1 >
|
|
1621
|
279 :echo [a] == [b]
|
|
388
|
280 < 0
|
|
323
|
281
|
|
85
|
282
|
|
|
283 List unpack ~
|
|
|
284
|
|
|
285 To unpack the items in a list to individual variables, put the variables in
|
|
|
286 square brackets, like list items: >
|
|
|
287 :let [var1, var2] = mylist
|
|
|
288
|
|
|
289 When the number of variables does not match the number of items in the list
|
|
|
290 this produces an error. To handle any extra items from the list append ";"
|
|
|
291 and a variable name: >
|
|
|
292 :let [var1, var2; rest] = mylist
|
|
|
293
|
|
|
294 This works like: >
|
|
|
295 :let var1 = mylist[0]
|
|
|
296 :let var2 = mylist[1]
|
|
95
|
297 :let rest = mylist[2:]
|
|
85
|
298
|
|
|
299 Except that there is no error if there are only two items. "rest" will be an
|
|
|
300 empty list then.
|
|
|
301
|
|
|
302
|
|
|
303 List modification ~
|
|
|
304 *list-modification*
|
|
87
|
305 To change a specific item of a list use |:let| this way: >
|
|
85
|
306 :let list[4] = "four"
|
|
|
307 :let listlist[0][3] = item
|
|
|
308
|
|
87
|
309 To change part of a list you can specify the first and last item to be
|
|
114
|
310 modified. The value must at least have the number of items in the range: >
|
|
87
|
311 :let list[3:5] = [3, 4, 5]
|
|
|
312
|
|
85
|
313 Adding and removing items from a list is done with functions. Here are a few
|
|
|
314 examples: >
|
|
|
315 :call insert(list, 'a') " prepend item 'a'
|
|
|
316 :call insert(list, 'a', 3) " insert item 'a' before list[3]
|
|
|
317 :call add(list, "new") " append String item
|
|
114
|
318 :call add(list, [1, 2]) " append a List as one new item
|
|
85
|
319 :call extend(list, [1, 2]) " extend the list with two more items
|
|
|
320 :let i = remove(list, 3) " remove item 3
|
|
108
|
321 :unlet list[3] " idem
|
|
85
|
322 :let l = remove(list, 3, -1) " remove items 3 to last item
|
|
108
|
323 :unlet list[3 : ] " idem
|
|
114
|
324 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
|
|
|
325
|
|
|
326 Changing the order of items in a list: >
|
|
87
|
327 :call sort(list) " sort a list alphabetically
|
|
|
328 :call reverse(list) " reverse the order of items
|
|
|
329
|
|
85
|
330
|
|
|
331 For loop ~
|
|
|
332
|
|
87
|
333 The |:for| loop executes commands for each item in a list. A variable is set
|
|
|
334 to each item in the list in sequence. Example: >
|
|
114
|
335 :for item in mylist
|
|
|
336 : call Doit(item)
|
|
85
|
337 :endfor
|
|
|
338
|
|
|
339 This works like: >
|
|
|
340 :let index = 0
|
|
|
341 :while index < len(mylist)
|
|
114
|
342 : let item = mylist[index]
|
|
|
343 : :call Doit(item)
|
|
85
|
344 : let index = index + 1
|
|
|
345 :endwhile
|
|
|
346
|
|
|
347 Note that all items in the list should be of the same type, otherwise this
|
|
114
|
348 results in error |E706|. To avoid this |:unlet| the variable at the end of
|
|
87
|
349 the loop.
|
|
85
|
350
|
|
95
|
351 If all you want to do is modify each item in the list then the |map()|
|
|
114
|
352 function will be a simpler method than a for loop.
|
|
95
|
353
|
|
1621
|
354 Just like the |:let| command, |:for| also accepts a list of variables. This
|
|
85
|
355 requires the argument to be a list of lists. >
|
|
|
356 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
|
|
|
357 : call Doit(lnum, col)
|
|
|
358 :endfor
|
|
|
359
|
|
|
360 This works like a |:let| command is done for each list item. Again, the types
|
|
|
361 must remain the same to avoid an error.
|
|
|
362
|
|
114
|
363 It is also possible to put remaining items in a List variable: >
|
|
85
|
364 :for [i, j; rest] in listlist
|
|
|
365 : call Doit(i, j)
|
|
|
366 : if !empty(rest)
|
|
|
367 : echo "remainder: " . string(rest)
|
|
|
368 : endif
|
|
|
369 :endfor
|
|
|
370
|
|
|
371
|
|
|
372 List functions ~
|
|
114
|
373 *E714*
|
|
85
|
374 Functions that are useful with a List: >
|
|
87
|
375 :let r = call(funcname, list) " call a function with an argument list
|
|
85
|
376 :if empty(list) " check if list is empty
|
|
102
|
377 :let l = len(list) " number of items in list
|
|
|
378 :let big = max(list) " maximum value in list
|
|
|
379 :let small = min(list) " minimum value in list
|
|
87
|
380 :let xs = count(list, 'x') " count nr of times 'x' appears in list
|
|
|
381 :let i = index(list, 'x') " index of first 'x' in list
|
|
85
|
382 :let lines = getline(1, 10) " get ten text lines from buffer
|
|
|
383 :call append('$', lines) " append text lines in buffer
|
|
95
|
384 :let list = split("a b c") " create list from items in a string
|
|
|
385 :let string = join(list, ', ') " create string from list items
|
|
102
|
386 :let s = string(list) " String representation of list
|
|
|
387 :call map(list, '">> " . v:val') " prepend ">> " to each item
|
|
99
|
388
|
|
258
|
389 Don't forget that a combination of features can make things simple. For
|
|
|
390 example, to add up all the numbers in a list: >
|
|
|
391 :exe 'let sum = ' . join(nrlist, '+')
|
|
|
392
|
|
99
|
393
|
|
|
394 1.4 Dictionaries ~
|
|
114
|
395 *Dictionaries* *Dictionary*
|
|
99
|
396 A Dictionary is an associative array: Each entry has a key and a value. The
|
|
114
|
397 entry can be located with the key. The entries are stored without a specific
|
|
|
398 ordering.
|
|
99
|
399
|
|
|
400
|
|
|
401 Dictionary creation ~
|
|
114
|
402 *E720* *E721* *E722* *E723*
|
|
99
|
403 A Dictionary is created with a comma separated list of entries in curly
|
|
114
|
404 braces. Each entry has a key and a value, separated by a colon. Each key can
|
|
|
405 only appear once. Examples: >
|
|
99
|
406 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
|
|
|
407 :let emptydict = {}
|
|
114
|
408 < *E713* *E716* *E717*
|
|
99
|
409 A key is always a String. You can use a Number, it will be converted to a
|
|
|
410 String automatically. Thus the String '4' and the number 4 will find the same
|
|
1621
|
411 entry. Note that the String '04' and the Number 04 are different, since the
|
|
114
|
412 Number will be converted to the String '4'.
|
|
|
413
|
|
1621
|
414 A value can be any expression. Using a Dictionary for a value creates a
|
|
99
|
415 nested Dictionary: >
|
|
|
416 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
|
|
|
417
|
|
|
418 An extra comma after the last entry is ignored.
|
|
|
419
|
|
|
420
|
|
|
421 Accessing entries ~
|
|
|
422
|
|
|
423 The normal way to access an entry is by putting the key in square brackets: >
|
|
|
424 :let val = mydict["one"]
|
|
|
425 :let mydict["four"] = 4
|
|
|
426
|
|
114
|
427 You can add new entries to an existing Dictionary this way, unlike Lists.
|
|
99
|
428
|
|
|
429 For keys that consist entirely of letters, digits and underscore the following
|
|
|
430 form can be used |expr-entry|: >
|
|
|
431 :let val = mydict.one
|
|
|
432 :let mydict.four = 4
|
|
|
433
|
|
|
434 Since an entry can be any type, also a List and a Dictionary, the indexing and
|
|
|
435 key lookup can be repeated: >
|
|
114
|
436 :echo dict.key[idx].key
|
|
99
|
437
|
|
|
438
|
|
|
439 Dictionary to List conversion ~
|
|
|
440
|
|
1621
|
441 You may want to loop over the entries in a dictionary. For this you need to
|
|
99
|
442 turn the Dictionary into a List and pass it to |:for|.
|
|
|
443
|
|
|
444 Most often you want to loop over the keys, using the |keys()| function: >
|
|
|
445 :for key in keys(mydict)
|
|
|
446 : echo key . ': ' . mydict[key]
|
|
|
447 :endfor
|
|
|
448
|
|
|
449 The List of keys is unsorted. You may want to sort them first: >
|
|
|
450 :for key in sort(keys(mydict))
|
|
|
451
|
|
|
452 To loop over the values use the |values()| function: >
|
|
|
453 :for v in values(mydict)
|
|
|
454 : echo "value: " . v
|
|
|
455 :endfor
|
|
|
456
|
|
|
457 If you want both the key and the value use the |items()| function. It returns
|
|
1621
|
458 a List in which each item is a List with two items, the key and the value: >
|
|
1156
|
459 :for [key, value] in items(mydict)
|
|
|
460 : echo key . ': ' . value
|
|
99
|
461 :endfor
|
|
|
462
|
|
|
463
|
|
|
464 Dictionary identity ~
|
|
161
|
465 *dict-identity*
|
|
99
|
466 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
|
|
|
467 Dictionary. Otherwise, assignment results in referring to the same
|
|
|
468 Dictionary: >
|
|
|
469 :let onedict = {'a': 1, 'b': 2}
|
|
|
470 :let adict = onedict
|
|
|
471 :let adict['a'] = 11
|
|
|
472 :echo onedict['a']
|
|
|
473 11
|
|
|
474
|
|
327
|
475 Two Dictionaries compare equal if all the key-value pairs compare equal. For
|
|
|
476 more info see |list-identity|.
|
|
99
|
477
|
|
|
478
|
|
|
479 Dictionary modification ~
|
|
|
480 *dict-modification*
|
|
|
481 To change an already existing entry of a Dictionary, or to add a new entry,
|
|
|
482 use |:let| this way: >
|
|
|
483 :let dict[4] = "four"
|
|
|
484 :let dict['one'] = item
|
|
|
485
|
|
108
|
486 Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
|
|
|
487 Three ways to remove the entry with key "aaa" from dict: >
|
|
|
488 :let i = remove(dict, 'aaa')
|
|
|
489 :unlet dict.aaa
|
|
|
490 :unlet dict['aaa']
|
|
99
|
491
|
|
|
492 Merging a Dictionary with another is done with |extend()|: >
|
|
114
|
493 :call extend(adict, bdict)
|
|
|
494 This extends adict with all entries from bdict. Duplicate keys cause entries
|
|
|
495 in adict to be overwritten. An optional third argument can change this.
|
|
119
|
496 Note that the order of entries in a Dictionary is irrelevant, thus don't
|
|
|
497 expect ":echo adict" to show the items from bdict after the older entries in
|
|
|
498 adict.
|
|
99
|
499
|
|
|
500 Weeding out entries from a Dictionary can be done with |filter()|: >
|
|
1156
|
501 :call filter(dict, 'v:val =~ "x"')
|
|
114
|
502 This removes all entries from "dict" with a value not matching 'x'.
|
|
102
|
503
|
|
|
504
|
|
|
505 Dictionary function ~
|
|
114
|
506 *Dictionary-function* *self* *E725*
|
|
102
|
507 When a function is defined with the "dict" attribute it can be used in a
|
|
1621
|
508 special way with a dictionary. Example: >
|
|
102
|
509 :function Mylen() dict
|
|
114
|
510 : return len(self.data)
|
|
102
|
511 :endfunction
|
|
114
|
512 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
|
|
|
513 :echo mydict.len()
|
|
102
|
514
|
|
|
515 This is like a method in object oriented programming. The entry in the
|
|
|
516 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
|
|
|
517 the function was invoked from.
|
|
|
518
|
|
114
|
519 It is also possible to add a function without the "dict" attribute as a
|
|
|
520 Funcref to a Dictionary, but the "self" variable is not available then.
|
|
|
521
|
|
819
|
522 *numbered-function* *anonymous-function*
|
|
102
|
523 To avoid the extra name for the function it can be defined and directly
|
|
|
524 assigned to a Dictionary in this way: >
|
|
114
|
525 :let mydict = {'data': [0, 1, 2, 3]}
|
|
|
526 :function mydict.len() dict
|
|
|
527 : return len(self.data)
|
|
102
|
528 :endfunction
|
|
114
|
529 :echo mydict.len()
|
|
|
530
|
|
|
531 The function will then get a number and the value of dict.len is a |Funcref|
|
|
1621
|
532 that references this function. The function can only be used through a
|
|
114
|
533 |Funcref|. It will automatically be deleted when there is no |Funcref|
|
|
|
534 remaining that refers to it.
|
|
|
535
|
|
|
536 It is not necessary to use the "dict" attribute for a numbered function.
|
|
102
|
537
|
|
|
538
|
|
|
539 Functions for Dictionaries ~
|
|
114
|
540 *E715*
|
|
|
541 Functions that can be used with a Dictionary: >
|
|
102
|
542 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
|
|
|
543 :if empty(dict) " TRUE if dict is empty
|
|
|
544 :let l = len(dict) " number of items in dict
|
|
|
545 :let big = max(dict) " maximum value in dict
|
|
|
546 :let small = min(dict) " minimum value in dict
|
|
|
547 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
|
|
|
548 :let s = string(dict) " String representation of dict
|
|
|
549 :call map(dict, '">> " . v:val') " prepend ">> " to each item
|
|
99
|
550
|
|
|
551
|
|
|
552 1.5 More about variables ~
|
|
85
|
553 *more-variables*
|
|
7
|
554 If you need to know the type of a variable or expression, use the |type()|
|
|
|
555 function.
|
|
|
556
|
|
|
557 When the '!' flag is included in the 'viminfo' option, global variables that
|
|
|
558 start with an uppercase letter, and don't contain a lowercase letter, are
|
|
|
559 stored in the viminfo file |viminfo-file|.
|
|
|
560
|
|
|
561 When the 'sessionoptions' option contains "global", global variables that
|
|
|
562 start with an uppercase letter and contain at least one lowercase letter are
|
|
|
563 stored in the session file |session-file|.
|
|
|
564
|
|
|
565 variable name can be stored where ~
|
|
|
566 my_var_6 not
|
|
|
567 My_Var_6 session file
|
|
|
568 MY_VAR_6 viminfo file
|
|
|
569
|
|
|
570
|
|
|
571 It's possible to form a variable name with curly braces, see
|
|
|
572 |curly-braces-names|.
|
|
|
573
|
|
|
574 ==============================================================================
|
|
|
575 2. Expression syntax *expression-syntax*
|
|
|
576
|
|
|
577 Expression syntax summary, from least to most significant:
|
|
|
578
|
|
|
579 |expr1| expr2 ? expr1 : expr1 if-then-else
|
|
|
580
|
|
|
581 |expr2| expr3 || expr3 .. logical OR
|
|
|
582
|
|
|
583 |expr3| expr4 && expr4 .. logical AND
|
|
|
584
|
|
|
585 |expr4| expr5 == expr5 equal
|
|
|
586 expr5 != expr5 not equal
|
|
|
587 expr5 > expr5 greater than
|
|
|
588 expr5 >= expr5 greater than or equal
|
|
|
589 expr5 < expr5 smaller than
|
|
|
590 expr5 <= expr5 smaller than or equal
|
|
|
591 expr5 =~ expr5 regexp matches
|
|
|
592 expr5 !~ expr5 regexp doesn't match
|
|
|
593
|
|
|
594 expr5 ==? expr5 equal, ignoring case
|
|
|
595 expr5 ==# expr5 equal, match case
|
|
|
596 etc. As above, append ? for ignoring case, # for
|
|
|
597 matching case
|
|
|
598
|
|
685
|
599 expr5 is expr5 same |List| instance
|
|
|
600 expr5 isnot expr5 different |List| instance
|
|
79
|
601
|
|
|
602 |expr5| expr6 + expr6 .. number addition or list concatenation
|
|
7
|
603 expr6 - expr6 .. number subtraction
|
|
|
604 expr6 . expr6 .. string concatenation
|
|
|
605
|
|
|
606 |expr6| expr7 * expr7 .. number multiplication
|
|
|
607 expr7 / expr7 .. number division
|
|
|
608 expr7 % expr7 .. number modulo
|
|
|
609
|
|
|
610 |expr7| ! expr7 logical NOT
|
|
|
611 - expr7 unary minus
|
|
|
612 + expr7 unary plus
|
|
102
|
613
|
|
|
614
|
|
685
|
615 |expr8| expr8[expr1] byte of a String or item of a |List|
|
|
|
616 expr8[expr1 : expr1] substring of a String or sublist of a |List|
|
|
|
617 expr8.name entry in a |Dictionary|
|
|
|
618 expr8(expr1, ...) function call with |Funcref| variable
|
|
102
|
619
|
|
|
620 |expr9| number number constant
|
|
26
|
621 "string" string constant, backslash is special
|
|
99
|
622 'string' string constant, ' is doubled
|
|
685
|
623 [expr1, ...] |List|
|
|
|
624 {expr1: expr1, ...} |Dictionary|
|
|
7
|
625 &option option value
|
|
|
626 (expr1) nested expression
|
|
|
627 variable internal variable
|
|
|
628 va{ria}ble internal variable with curly braces
|
|
|
629 $VAR environment variable
|
|
|
630 @r contents of register 'r'
|
|
|
631 function(expr1, ...) function call
|
|
|
632 func{ti}on(expr1, ...) function call with curly braces
|
|
|
633
|
|
|
634
|
|
|
635 ".." indicates that the operations in this level can be concatenated.
|
|
|
636 Example: >
|
|
|
637 &nu || &list && &shell == "csh"
|
|
|
638
|
|
|
639 All expressions within one level are parsed from left to right.
|
|
|
640
|
|
|
641
|
|
|
642 expr1 *expr1* *E109*
|
|
|
643 -----
|
|
|
644
|
|
|
645 expr2 ? expr1 : expr1
|
|
|
646
|
|
|
647 The expression before the '?' is evaluated to a number. If it evaluates to
|
|
|
648 non-zero, the result is the value of the expression between the '?' and ':',
|
|
|
649 otherwise the result is the value of the expression after the ':'.
|
|
|
650 Example: >
|
|
|
651 :echo lnum == 1 ? "top" : lnum
|
|
|
652
|
|
|
653 Since the first expression is an "expr2", it cannot contain another ?:. The
|
|
|
654 other two expressions can, thus allow for recursive use of ?:.
|
|
|
655 Example: >
|
|
|
656 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
|
|
|
657
|
|
|
658 To keep this readable, using |line-continuation| is suggested: >
|
|
|
659 :echo lnum == 1
|
|
|
660 :\ ? "top"
|
|
|
661 :\ : lnum == 1000
|
|
|
662 :\ ? "last"
|
|
|
663 :\ : lnum
|
|
|
664
|
|
1156
|
665 You should always put a space before the ':', otherwise it can be mistaken for
|
|
|
666 use in a variable such as "a:1".
|
|
|
667
|
|
7
|
668
|
|
|
669 expr2 and expr3 *expr2* *expr3*
|
|
|
670 ---------------
|
|
|
671
|
|
|
672 *expr-barbar* *expr-&&*
|
|
|
673 The "||" and "&&" operators take one argument on each side. The arguments
|
|
|
674 are (converted to) Numbers. The result is:
|
|
|
675
|
|
|
676 input output ~
|
|
|
677 n1 n2 n1 || n2 n1 && n2 ~
|
|
|
678 zero zero zero zero
|
|
|
679 zero non-zero non-zero zero
|
|
|
680 non-zero zero non-zero zero
|
|
|
681 non-zero non-zero non-zero non-zero
|
|
|
682
|
|
|
683 The operators can be concatenated, for example: >
|
|
|
684
|
|
|
685 &nu || &list && &shell == "csh"
|
|
|
686
|
|
|
687 Note that "&&" takes precedence over "||", so this has the meaning of: >
|
|
|
688
|
|
|
689 &nu || (&list && &shell == "csh")
|
|
|
690
|
|
|
691 Once the result is known, the expression "short-circuits", that is, further
|
|
|
692 arguments are not evaluated. This is like what happens in C. For example: >
|
|
|
693
|
|
|
694 let a = 1
|
|
|
695 echo a || b
|
|
|
696
|
|
|
697 This is valid even if there is no variable called "b" because "a" is non-zero,
|
|
|
698 so the result must be non-zero. Similarly below: >
|
|
|
699
|
|
|
700 echo exists("b") && b == "yes"
|
|
|
701
|
|
|
702 This is valid whether "b" has been defined or not. The second clause will
|
|
|
703 only be evaluated if "b" has been defined.
|
|
|
704
|
|
|
705
|
|
|
706 expr4 *expr4*
|
|
|
707 -----
|
|
|
708
|
|
|
709 expr5 {cmp} expr5
|
|
|
710
|
|
|
711 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
|
|
|
712 if it evaluates to true.
|
|
|
713
|
|
1621
|
714 *expr-==* *expr-!=* *expr->* *expr->=*
|
|
7
|
715 *expr-<* *expr-<=* *expr-=~* *expr-!~*
|
|
|
716 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
|
|
|
717 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
|
|
|
718 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
|
|
|
719 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
|
|
79
|
720 *expr-is*
|
|
7
|
721 use 'ignorecase' match case ignore case ~
|
|
|
722 equal == ==# ==?
|
|
|
723 not equal != !=# !=?
|
|
|
724 greater than > ># >?
|
|
|
725 greater than or equal >= >=# >=?
|
|
|
726 smaller than < <# <?
|
|
|
727 smaller than or equal <= <=# <=?
|
|
|
728 regexp matches =~ =~# =~?
|
|
|
729 regexp doesn't match !~ !~# !~?
|
|
79
|
730 same instance is
|
|
|
731 different instance isnot
|
|
7
|
732
|
|
|
733 Examples:
|
|
|
734 "abc" ==# "Abc" evaluates to 0
|
|
|
735 "abc" ==? "Abc" evaluates to 1
|
|
|
736 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
|
|
|
737
|
|
85
|
738 *E691* *E692*
|
|
685
|
739 A |List| can only be compared with a |List| and only "equal", "not equal" and
|
|
|
740 "is" can be used. This compares the values of the list, recursively.
|
|
|
741 Ignoring case means case is ignored when comparing item values.
|
|
79
|
742
|
|
114
|
743 *E735* *E736*
|
|
685
|
744 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
|
|
|
745 equal" and "is" can be used. This compares the key/values of the |Dictionary|
|
|
114
|
746 recursively. Ignoring case means case is ignored when comparing item values.
|
|
|
747
|
|
85
|
748 *E693* *E694*
|
|
685
|
749 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not
|
|
|
750 equal" can be used. Case is never ignored.
|
|
|
751
|
|
|
752 When using "is" or "isnot" with a |List| this checks if the expressions are
|
|
1621
|
753 referring to the same |List| instance. A copy of a |List| is different from
|
|
685
|
754 the original |List|. When using "is" without a |List| it is equivalent to
|
|
|
755 using "equal", using "isnot" equivalent to using "not equal". Except that a
|
|
1621
|
756 different type means the values are different. "4 == '4'" is true, "4 is '4'"
|
|
79
|
757 is false.
|
|
|
758
|
|
7
|
759 When comparing a String with a Number, the String is converted to a Number,
|
|
1621
|
760 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
|
|
7
|
761 because 'x' converted to a Number is zero.
|
|
|
762
|
|
|
763 When comparing two Strings, this is done with strcmp() or stricmp(). This
|
|
|
764 results in the mathematical difference (comparing byte values), not
|
|
|
765 necessarily the alphabetical difference in the local language.
|
|
|
766
|
|
1621
|
767 When using the operators with a trailing '#', or the short version and
|
|
1156
|
768 'ignorecase' is off, the comparing is done with strcmp(): case matters.
|
|
7
|
769
|
|
|
770 When using the operators with a trailing '?', or the short version and
|
|
1156
|
771 'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
|
|
|
772
|
|
|
773 'smartcase' is not used.
|
|
7
|
774
|
|
|
775 The "=~" and "!~" operators match the lefthand argument with the righthand
|
|
|
776 argument, which is used as a pattern. See |pattern| for what a pattern is.
|
|
|
777 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
|
|
|
778 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
|
|
|
779 portable. To avoid backslashes in the regexp pattern to be doubled, use a
|
|
|
780 single-quote string, see |literal-string|.
|
|
|
781 Since a string is considered to be a single line, a multi-line pattern
|
|
|
782 (containing \n, backslash-n) will not match. However, a literal NL character
|
|
|
783 can be matched like an ordinary character. Examples:
|
|
|
784 "foo\nbar" =~ "\n" evaluates to 1
|
|
|
785 "foo\nbar" =~ "\\n" evaluates to 0
|
|
|
786
|
|
|
787
|
|
|
788 expr5 and expr6 *expr5* *expr6*
|
|
|
789 ---------------
|
|
685
|
790 expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
|
|
79
|
791 expr6 - expr6 .. Number subtraction *expr--*
|
|
|
792 expr6 . expr6 .. String concatenation *expr-.*
|
|
|
793
|
|
692
|
794 For |Lists| only "+" is possible and then both expr6 must be a list. The
|
|
685
|
795 result is a new list with the two lists Concatenated.
|
|
79
|
796
|
|
|
797 expr7 * expr7 .. number multiplication *expr-star*
|
|
|
798 expr7 / expr7 .. number division *expr-/*
|
|
|
799 expr7 % expr7 .. number modulo *expr-%*
|
|
7
|
800
|
|
|
801 For all, except ".", Strings are converted to Numbers.
|
|
|
802
|
|
|
803 Note the difference between "+" and ".":
|
|
|
804 "123" + "456" = 579
|
|
|
805 "123" . "456" = "123456"
|
|
|
806
|
|
1621
|
807 Since '.' has the same precedence as '+' and '-', you need to read: >
|
|
|
808 1 . 90 + 90.0
|
|
|
809 As: >
|
|
|
810 (1 . 90) + 90.0
|
|
|
811 That works, since the String "190" is automatically converted to the Number
|
|
|
812 190, which can be added to the Float 90.0. However: >
|
|
|
813 1 . 90 * 90.0
|
|
|
814 Should be read as: >
|
|
|
815 1 . (90 * 90.0)
|
|
|
816 Since '.' has lower precedence than '*'. This does NOT work, since this
|
|
|
817 attempts to concatenate a Float and a String.
|
|
|
818
|
|
|
819 When dividing a Number by zero the result depends on the value:
|
|
|
820 0 / 0 = -0x80000000 (like NaN for Float)
|
|
|
821 >0 / 0 = 0x7fffffff (like positive infinity)
|
|
|
822 <0 / 0 = -0x7fffffff (like negative infinity)
|
|
|
823 (before Vim 7.2 it was always 0x7fffffff)
|
|
|
824
|
|
7
|
825 When the righthand side of '%' is zero, the result is 0.
|
|
|
826
|
|
685
|
827 None of these work for |Funcref|s.
|
|
79
|
828
|
|
1621
|
829 . and % do not work for Float. *E804*
|
|
|
830
|
|
7
|
831
|
|
|
832 expr7 *expr7*
|
|
|
833 -----
|
|
|
834 ! expr7 logical NOT *expr-!*
|
|
|
835 - expr7 unary minus *expr-unary--*
|
|
|
836 + expr7 unary plus *expr-unary-+*
|
|
|
837
|
|
|
838 For '!' non-zero becomes zero, zero becomes one.
|
|
|
839 For '-' the sign of the number is changed.
|
|
|
840 For '+' the number is unchanged.
|
|
|
841
|
|
|
842 A String will be converted to a Number first.
|
|
|
843
|
|
1621
|
844 These three can be repeated and mixed. Examples:
|
|
7
|
845 !-1 == 0
|
|
|
846 !!8 == 1
|
|
|
847 --9 == 9
|
|
|
848
|
|
|
849
|
|
|
850 expr8 *expr8*
|
|
|
851 -----
|
|
685
|
852 expr8[expr1] item of String or |List| *expr-[]* *E111*
|
|
102
|
853
|
|
|
854 If expr8 is a Number or String this results in a String that contains the
|
|
|
855 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
|
|
55
|
856 Number. Note that this doesn't recognize multi-byte encodings.
|
|
|
857
|
|
|
858 Index zero gives the first character. This is like it works in C. Careful:
|
|
|
859 text column numbers start with one! Example, to get the character under the
|
|
|
860 cursor: >
|
|
823
|
861 :let c = getline(".")[col(".") - 1]
|
|
7
|
862
|
|
|
863 If the length of the String is less than the index, the result is an empty
|
|
55
|
864 String. A negative index always results in an empty string (reason: backwards
|
|
|
865 compatibility). Use [-1:] to get the last byte.
|
|
|
866
|
|
685
|
867 If expr8 is a |List| then it results the item at index expr1. See |list-index|
|
|
55
|
868 for possible index values. If the index is out of range this results in an
|
|
1621
|
869 error. Example: >
|
|
55
|
870 :let item = mylist[-1] " get last item
|
|
|
871
|
|
685
|
872 Generally, if a |List| index is equal to or higher than the length of the
|
|
|
873 |List|, or more negative than the length of the |List|, this results in an
|
|
|
874 error.
|
|
55
|
875
|
|
99
|
876
|
|
102
|
877 expr8[expr1a : expr1b] substring or sublist *expr-[:]*
|
|
|
878
|
|
|
879 If expr8 is a Number or String this results in the substring with the bytes
|
|
|
880 from expr1a to and including expr1b. expr8 is used as a String, expr1a and
|
|
55
|
881 expr1b are used as a Number. Note that this doesn't recognize multi-byte
|
|
|
882 encodings.
|
|
|
883
|
|
|
884 If expr1a is omitted zero is used. If expr1b is omitted the length of the
|
|
|
885 string minus one is used.
|
|
|
886
|
|
|
887 A negative number can be used to measure from the end of the string. -1 is
|
|
|
888 the last character, -2 the last but one, etc.
|
|
|
889
|
|
|
890 If an index goes out of range for the string characters are omitted. If
|
|
|
891 expr1b is smaller than expr1a the result is an empty string.
|
|
|
892
|
|
|
893 Examples: >
|
|
|
894 :let c = name[-1:] " last byte of a string
|
|
|
895 :let c = name[-2:-2] " last but one byte of a string
|
|
|
896 :let s = line(".")[4:] " from the fifth byte to the end
|
|
|
897 :let s = s[:-3] " remove last two bytes
|
|
|
898
|
|
685
|
899 If expr8 is a |List| this results in a new |List| with the items indicated by
|
|
1621
|
900 the indexes expr1a and expr1b. This works like with a String, as explained
|
|
685
|
901 just above, except that indexes out of range cause an error. Examples: >
|
|
55
|
902 :let l = mylist[:3] " first four items
|
|
|
903 :let l = mylist[4:4] " List with one item
|
|
|
904 :let l = mylist[:] " shallow copy of a List
|
|
|
905
|
|
685
|
906 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
|
|
|
907 error.
|
|
|
908
|
|
|
909
|
|
|
910 expr8.name entry in a |Dictionary| *expr-entry*
|
|
|
911
|
|
|
912 If expr8 is a |Dictionary| and it is followed by a dot, then the following
|
|
|
913 name will be used as a key in the |Dictionary|. This is just like:
|
|
|
914 expr8[name].
|
|
99
|
915
|
|
|
916 The name must consist of alphanumeric characters, just like a variable name,
|
|
|
917 but it may start with a number. Curly braces cannot be used.
|
|
|
918
|
|
|
919 There must not be white space before or after the dot.
|
|
|
920
|
|
|
921 Examples: >
|
|
|
922 :let dict = {"one": 1, 2: "two"}
|
|
|
923 :echo dict.one
|
|
|
924 :echo dict .2
|
|
|
925
|
|
|
926 Note that the dot is also used for String concatenation. To avoid confusion
|
|
|
927 always put spaces around the dot for String concatenation.
|
|
|
928
|
|
|
929
|
|
685
|
930 expr8(expr1, ...) |Funcref| function call
|
|
102
|
931
|
|
|
932 When expr8 is a |Funcref| type variable, invoke the function it refers to.
|
|
|
933
|
|
|
934
|
|
|
935
|
|
|
936 *expr9*
|
|
7
|
937 number
|
|
|
938 ------
|
|
|
939 number number constant *expr-number*
|
|
|
940
|
|
|
941 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
|
|
|
942
|
|
1621
|
943 *floating-point-format*
|
|
|
944 Floating point numbers can be written in two forms:
|
|
|
945
|
|
|
946 [-+]{N}.{M}
|
|
|
947 [-+]{N}.{M}e[-+]{exp}
|
|
|
948
|
|
|
949 {N} and {M} are numbers. Both {N} and {M} must be present and can only
|
|
|
950 contain digits.
|
|
|
951 [-+] means there is an optional plus or minus sign.
|
|
|
952 {exp} is the exponent, power of 10.
|
|
|
953 Only a decimal point is accepted, not a comma. No matter what the current
|
|
|
954 locale is.
|
|
|
955 {only when compiled with the |+float| feature}
|
|
|
956
|
|
|
957 Examples:
|
|
|
958 123.456
|
|
|
959 +0.0001
|
|
|
960 55.0
|
|
|
961 -0.123
|
|
|
962 1.234e03
|
|
|
963 1.0E-6
|
|
|
964 -3.1416e+88
|
|
|
965
|
|
|
966 These are INVALID:
|
|
|
967 3. empty {M}
|
|
|
968 1e40 missing .{M}
|
|
|
969
|
|
|
970 Rationale:
|
|
|
971 Before floating point was introduced, the text "123.456" was interpreted as
|
|
|
972 the two numbers "123" and "456", both converted to a string and concatenated,
|
|
|
973 resulting in the string "123456". Since this was considered pointless, and we
|
|
|
974 could not find it actually being used in Vim scripts, this backwards
|
|
|
975 incompatibility was accepted in favor of being able to use the normal notation
|
|
|
976 for floating point numbers.
|
|
|
977
|
|
|
978 *floating-point-precision*
|
|
|
979 The precision and range of floating points numbers depends on what "double"
|
|
|
980 means in the library Vim was compiled with. There is no way to change this at
|
|
|
981 runtime.
|
|
|
982
|
|
|
983 The default for displaying a |Float| is to use 6 decimal places, like using
|
|
|
984 printf("%g", f). You can select something else when using the |printf()|
|
|
|
985 function. Example: >
|
|
|
986 :echo printf('%.15e', atan(1))
|
|
|
987 < 7.853981633974483e-01
|
|
|
988
|
|
|
989
|
|
7
|
990
|
|
|
991 string *expr-string* *E114*
|
|
|
992 ------
|
|
|
993 "string" string constant *expr-quote*
|
|
|
994
|
|
|
995 Note that double quotes are used.
|
|
|
996
|
|
|
997 A string constant accepts these special characters:
|
|
|
998 \... three-digit octal number (e.g., "\316")
|
|
|
999 \.. two-digit octal number (must be followed by non-digit)
|
|
|
1000 \. one-digit octal number (must be followed by non-digit)
|
|
|
1001 \x.. byte specified with two hex numbers (e.g., "\x1f")
|
|
|
1002 \x. byte specified with one hex number (must be followed by non-hex char)
|
|
|
1003 \X.. same as \x..
|
|
|
1004 \X. same as \x.
|
|
1621
|
1005 \u.... character specified with up to 4 hex numbers, stored according to the
|
|
7
|
1006 current value of 'encoding' (e.g., "\u02a4")
|
|
|
1007 \U.... same as \u....
|
|
|
1008 \b backspace <BS>
|
|
|
1009 \e escape <Esc>
|
|
|
1010 \f formfeed <FF>
|
|
|
1011 \n newline <NL>
|
|
|
1012 \r return <CR>
|
|
|
1013 \t tab <Tab>
|
|
|
1014 \\ backslash
|
|
|
1015 \" double quote
|
|
|
1016 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W.
|
|
|
1017
|
|
1156
|
1018 Note that "\xff" is stored as the byte 255, which may be invalid in some
|
|
|
1019 encodings. Use "\u00ff" to store character 255 according to the current value
|
|
|
1020 of 'encoding'.
|
|
|
1021
|
|
7
|
1022 Note that "\000" and "\x00" force the end of the string.
|
|
|
1023
|
|
|
1024
|
|
|
1025 literal-string *literal-string* *E115*
|
|
|
1026 ---------------
|
|
26
|
1027 'string' string constant *expr-'*
|
|
7
|
1028
|
|
|
1029 Note that single quotes are used.
|
|
|
1030
|
|
1621
|
1031 This string is taken as it is. No backslashes are removed or have a special
|
|
99
|
1032 meaning. The only exception is that two quotes stand for one quote.
|
|
26
|
1033
|
|
|
1034 Single quoted strings are useful for patterns, so that backslashes do not need
|
|
1621
|
1035 to be doubled. These two commands are equivalent: >
|
|
26
|
1036 if a =~ "\\s*"
|
|
|
1037 if a =~ '\s*'
|
|
7
|
1038
|
|
|
1039
|
|
|
1040 option *expr-option* *E112* *E113*
|
|
|
1041 ------
|
|
|
1042 &option option value, local value if possible
|
|
|
1043 &g:option global option value
|
|
|
1044 &l:option local option value
|
|
|
1045
|
|
|
1046 Examples: >
|
|
|
1047 echo "tabstop is " . &tabstop
|
|
|
1048 if &insertmode
|
|
|
1049
|
|
|
1050 Any option name can be used here. See |options|. When using the local value
|
|
|
1051 and there is no buffer-local or window-local value, the global value is used
|
|
|
1052 anyway.
|
|
|
1053
|
|
|
1054
|
|
1156
|
1055 register *expr-register* *@r*
|
|
7
|
1056 --------
|
|
|
1057 @r contents of register 'r'
|
|
|
1058
|
|
|
1059 The result is the contents of the named register, as a single string.
|
|
|
1060 Newlines are inserted where required. To get the contents of the unnamed
|
|
1621
|
1061 register use @" or @@. See |registers| for an explanation of the available
|
|
336
|
1062 registers.
|
|
|
1063
|
|
|
1064 When using the '=' register you get the expression itself, not what it
|
|
|
1065 evaluates to. Use |eval()| to evaluate it.
|
|
7
|
1066
|
|
|
1067
|
|
|
1068 nesting *expr-nesting* *E110*
|
|
|
1069 -------
|
|
|
1070 (expr1) nested expression
|
|
|
1071
|
|
|
1072
|
|
|
1073 environment variable *expr-env*
|
|
|
1074 --------------------
|
|
|
1075 $VAR environment variable
|
|
|
1076
|
|
|
1077 The String value of any environment variable. When it is not defined, the
|
|
|
1078 result is an empty string.
|
|
|
1079 *expr-env-expand*
|
|
|
1080 Note that there is a difference between using $VAR directly and using
|
|
|
1081 expand("$VAR"). Using it directly will only expand environment variables that
|
|
|
1082 are known inside the current Vim session. Using expand() will first try using
|
|
|
1083 the environment variables known inside the current Vim session. If that
|
|
|
1084 fails, a shell will be used to expand the variable. This can be slow, but it
|
|
|
1085 does expand all variables that the shell knows about. Example: >
|
|
|
1086 :echo $version
|
|
|
1087 :echo expand("$version")
|
|
|
1088 The first one probably doesn't echo anything, the second echoes the $version
|
|
|
1089 variable (if your shell supports it).
|
|
|
1090
|
|
|
1091
|
|
|
1092 internal variable *expr-variable*
|
|
|
1093 -----------------
|
|
|
1094 variable internal variable
|
|
|
1095 See below |internal-variables|.
|
|
|
1096
|
|
|
1097
|
|
170
|
1098 function call *expr-function* *E116* *E118* *E119* *E120*
|
|
7
|
1099 -------------
|
|
|
1100 function(expr1, ...) function call
|
|
|
1101 See below |functions|.
|
|
|
1102
|
|
|
1103
|
|
|
1104 ==============================================================================
|
|
|
1105 3. Internal variable *internal-variables* *E121*
|
|
|
1106 *E461*
|
|
|
1107 An internal variable name can be made up of letters, digits and '_'. But it
|
|
|
1108 cannot start with a digit. It's also possible to use curly braces, see
|
|
|
1109 |curly-braces-names|.
|
|
|
1110
|
|
|
1111 An internal variable is created with the ":let" command |:let|.
|
|
87
|
1112 An internal variable is explicitly destroyed with the ":unlet" command
|
|
|
1113 |:unlet|.
|
|
|
1114 Using a name that is not an internal variable or refers to a variable that has
|
|
|
1115 been destroyed results in an error.
|
|
7
|
1116
|
|
|
1117 There are several name spaces for variables. Which one is to be used is
|
|
|
1118 specified by what is prepended:
|
|
|
1119
|
|
|
1120 (nothing) In a function: local to a function; otherwise: global
|
|
|
1121 |buffer-variable| b: Local to the current buffer.
|
|
|
1122 |window-variable| w: Local to the current window.
|
|
819
|
1123 |tabpage-variable| t: Local to the current tab page.
|
|
7
|
1124 |global-variable| g: Global.
|
|
|
1125 |local-variable| l: Local to a function.
|
|
|
1126 |script-variable| s: Local to a |:source|'ed Vim script.
|
|
|
1127 |function-argument| a: Function argument (only inside a function).
|
|
1621
|
1128 |vim-variable| v: Global, predefined by Vim.
|
|
7
|
1129
|
|
685
|
1130 The scope name by itself can be used as a |Dictionary|. For example, to
|
|
|
1131 delete all script-local variables: >
|
|
133
|
1132 :for k in keys(s:)
|
|
|
1133 : unlet s:[k]
|
|
|
1134 :endfor
|
|
|
1135 <
|
|
7
|
1136 *buffer-variable* *b:var*
|
|
|
1137 A variable name that is preceded with "b:" is local to the current buffer.
|
|
|
1138 Thus you can have several "b:foo" variables, one for each buffer.
|
|
|
1139 This kind of variable is deleted when the buffer is wiped out or deleted with
|
|
|
1140 |:bdelete|.
|
|
|
1141
|
|
|
1142 One local buffer variable is predefined:
|
|
|
1143 *b:changedtick-variable* *changetick*
|
|
|
1144 b:changedtick The total number of changes to the current buffer. It is
|
|
|
1145 incremented for each change. An undo command is also a change
|
|
|
1146 in this case. This can be used to perform an action only when
|
|
|
1147 the buffer has changed. Example: >
|
|
|
1148 :if my_changedtick != b:changedtick
|
|
1621
|
1149 : let my_changedtick = b:changedtick
|
|
|
1150 : call My_Update()
|
|
7
|
1151 :endif
|
|
|
1152 <
|
|
|
1153 *window-variable* *w:var*
|
|
|
1154 A variable name that is preceded with "w:" is local to the current window. It
|
|
|
1155 is deleted when the window is closed.
|
|
|
1156
|
|
819
|
1157 *tabpage-variable* *t:var*
|
|
|
1158 A variable name that is preceded with "t:" is local to the current tab page,
|
|
|
1159 It is deleted when the tab page is closed. {not available when compiled
|
|
|
1160 without the +windows feature}
|
|
|
1161
|
|
7
|
1162 *global-variable* *g:var*
|
|
|
1163 Inside functions global variables are accessed with "g:". Omitting this will
|
|
1621
|
1164 access a variable local to a function. But "g:" can also be used in any other
|
|
7
|
1165 place if you like.
|
|
|
1166
|
|
|
1167 *local-variable* *l:var*
|
|
|
1168 Inside functions local variables are accessed without prepending anything.
|
|
1156
|
1169 But you can also prepend "l:" if you like. However, without prepending "l:"
|
|
|
1170 you may run into reserved variable names. For example "count". By itself it
|
|
|
1171 refers to "v:count". Using "l:count" you can have a local variable with the
|
|
|
1172 same name.
|
|
7
|
1173
|
|
|
1174 *script-variable* *s:var*
|
|
|
1175 In a Vim script variables starting with "s:" can be used. They cannot be
|
|
|
1176 accessed from outside of the scripts, thus are local to the script.
|
|
|
1177
|
|
|
1178 They can be used in:
|
|
|
1179 - commands executed while the script is sourced
|
|
|
1180 - functions defined in the script
|
|
|
1181 - autocommands defined in the script
|
|
|
1182 - functions and autocommands defined in functions and autocommands which were
|
|
|
1183 defined in the script (recursively)
|
|
|
1184 - user defined commands defined in the script
|
|
|
1185 Thus not in:
|
|
|
1186 - other scripts sourced from this one
|
|
|
1187 - mappings
|
|
|
1188 - etc.
|
|
|
1189
|
|
1156
|
1190 Script variables can be used to avoid conflicts with global variable names.
|
|
|
1191 Take this example: >
|
|
7
|
1192
|
|
|
1193 let s:counter = 0
|
|
|
1194 function MyCounter()
|
|
|
1195 let s:counter = s:counter + 1
|
|
|
1196 echo s:counter
|
|
|
1197 endfunction
|
|
|
1198 command Tick call MyCounter()
|
|
|
1199
|
|
|
1200 You can now invoke "Tick" from any script, and the "s:counter" variable in
|
|
|
1201 that script will not be changed, only the "s:counter" in the script where
|
|
|
1202 "Tick" was defined is used.
|
|
|
1203
|
|
|
1204 Another example that does the same: >
|
|
|
1205
|
|
|
1206 let s:counter = 0
|
|
|
1207 command Tick let s:counter = s:counter + 1 | echo s:counter
|
|
|
1208
|
|
|
1209 When calling a function and invoking a user-defined command, the context for
|
|
9
|
1210 script variables is set to the script where the function or command was
|
|
7
|
1211 defined.
|
|
|
1212
|
|
|
1213 The script variables are also available when a function is defined inside a
|
|
|
1214 function that is defined in a script. Example: >
|
|
|
1215
|
|
|
1216 let s:counter = 0
|
|
|
1217 function StartCounting(incr)
|
|
|
1218 if a:incr
|
|
|
1219 function MyCounter()
|
|
|
1220 let s:counter = s:counter + 1
|
|
|
1221 endfunction
|
|
|
1222 else
|
|
|
1223 function MyCounter()
|
|
|
1224 let s:counter = s:counter - 1
|
|
|
1225 endfunction
|
|
|
1226 endif
|
|
|
1227 endfunction
|
|
|
1228
|
|
|
1229 This defines the MyCounter() function either for counting up or counting down
|
|
|
1230 when calling StartCounting(). It doesn't matter from where StartCounting() is
|
|
|
1231 called, the s:counter variable will be accessible in MyCounter().
|
|
|
1232
|
|
|
1233 When the same script is sourced again it will use the same script variables.
|
|
|
1234 They will remain valid as long as Vim is running. This can be used to
|
|
|
1235 maintain a counter: >
|
|
|
1236
|
|
|
1237 if !exists("s:counter")
|
|
|
1238 let s:counter = 1
|
|
|
1239 echo "script executed for the first time"
|
|
|
1240 else
|
|
|
1241 let s:counter = s:counter + 1
|
|
|
1242 echo "script executed " . s:counter . " times now"
|
|
|
1243 endif
|
|
|
1244
|
|
|
1245 Note that this means that filetype plugins don't get a different set of script
|
|
|
1246 variables for each buffer. Use local buffer variables instead |b:var|.
|
|
|
1247
|
|
|
1248
|
|
|
1249 Predefined Vim variables: *vim-variable* *v:var*
|
|
|
1250
|
|
189
|
1251 *v:beval_col* *beval_col-variable*
|
|
|
1252 v:beval_col The number of the column, over which the mouse pointer is.
|
|
|
1253 This is the byte index in the |v:beval_lnum| line.
|
|
|
1254 Only valid while evaluating the 'balloonexpr' option.
|
|
|
1255
|
|
|
1256 *v:beval_bufnr* *beval_bufnr-variable*
|
|
|
1257 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
|
|
|
1258 valid while evaluating the 'balloonexpr' option.
|
|
|
1259
|
|
|
1260 *v:beval_lnum* *beval_lnum-variable*
|
|
|
1261 v:beval_lnum The number of the line, over which the mouse pointer is. Only
|
|
|
1262 valid while evaluating the 'balloonexpr' option.
|
|
|
1263
|
|
|
1264 *v:beval_text* *beval_text-variable*
|
|
374
|
1265 v:beval_text The text under or after the mouse pointer. Usually a word as
|
|
|
1266 it is useful for debugging a C program. 'iskeyword' applies,
|
|
|
1267 but a dot and "->" before the position is included. When on a
|
|
|
1268 ']' the text before it is used, including the matching '[' and
|
|
189
|
1269 word before it. When on a Visual area within one line the
|
|
|
1270 highlighted text is used.
|
|
|
1271 Only valid while evaluating the 'balloonexpr' option.
|
|
|
1272
|
|
|
1273 *v:beval_winnr* *beval_winnr-variable*
|
|
|
1274 v:beval_winnr The number of the window, over which the mouse pointer is. Only
|
|
|
1275 valid while evaluating the 'balloonexpr' option.
|
|
|
1276
|
|
844
|
1277 *v:char* *char-variable*
|
|
|
1278 v:char Argument for evaluating 'formatexpr'.
|
|
|
1279
|
|
7
|
1280 *v:charconvert_from* *charconvert_from-variable*
|
|
|
1281 v:charconvert_from
|
|
|
1282 The name of the character encoding of a file to be converted.
|
|
|
1283 Only valid while evaluating the 'charconvert' option.
|
|
|
1284
|
|
|
1285 *v:charconvert_to* *charconvert_to-variable*
|
|
|
1286 v:charconvert_to
|
|
|
1287 The name of the character encoding of a file after conversion.
|
|
|
1288 Only valid while evaluating the 'charconvert' option.
|
|
|
1289
|
|
|
1290 *v:cmdarg* *cmdarg-variable*
|
|
|
1291 v:cmdarg This variable is used for two purposes:
|
|
|
1292 1. The extra arguments given to a file read/write command.
|
|
|
1293 Currently these are "++enc=" and "++ff=". This variable is
|
|
|
1294 set before an autocommand event for a file read/write
|
|
|
1295 command is triggered. There is a leading space to make it
|
|
|
1296 possible to append this variable directly after the
|
|
1621
|
1297 read/write command. Note: The "+cmd" argument isn't
|
|
7
|
1298 included here, because it will be executed anyway.
|
|
|
1299 2. When printing a PostScript file with ":hardcopy" this is
|
|
|
1300 the argument for the ":hardcopy" command. This can be used
|
|
|
1301 in 'printexpr'.
|
|
|
1302
|
|
|
1303 *v:cmdbang* *cmdbang-variable*
|
|
|
1304 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
|
|
|
1305 was used the value is 1, otherwise it is 0. Note that this
|
|
|
1306 can only be used in autocommands. For user commands |<bang>|
|
|
|
1307 can be used.
|
|
|
1308
|
|
|
1309 *v:count* *count-variable*
|
|
|
1310 v:count The count given for the last Normal mode command. Can be used
|
|
1621
|
1311 to get the count before a mapping. Read-only. Example: >
|
|
7
|
1312 :map _x :<C-U>echo "the count is " . v:count<CR>
|
|
|
1313 < Note: The <C-U> is required to remove the line range that you
|
|
|
1314 get when typing ':' after a count.
|
|
667
|
1315 Also used for evaluating the 'formatexpr' option.
|
|
7
|
1316 "count" also works, for backwards compatibility.
|
|
|
1317
|
|
|
1318 *v:count1* *count1-variable*
|
|
|
1319 v:count1 Just like "v:count", but defaults to one when no count is
|
|
|
1320 used.
|
|
|
1321
|
|
|
1322 *v:ctype* *ctype-variable*
|
|
|
1323 v:ctype The current locale setting for characters of the runtime
|
|
|
1324 environment. This allows Vim scripts to be aware of the
|
|
|
1325 current locale encoding. Technical: it's the value of
|
|
|
1326 LC_CTYPE. When not using a locale the value is "C".
|
|
|
1327 This variable can not be set directly, use the |:language|
|
|
|
1328 command.
|
|
|
1329 See |multi-lang|.
|
|
|
1330
|
|
|
1331 *v:dying* *dying-variable*
|
|
1621
|
1332 v:dying Normally zero. When a deadly signal is caught it's set to
|
|
7
|
1333 one. When multiple signals are caught the number increases.
|
|
|
1334 Can be used in an autocommand to check if Vim didn't
|
|
|
1335 terminate normally. {only works on Unix}
|
|
|
1336 Example: >
|
|
|
1337 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
|
|
|
1338 <
|
|
|
1339 *v:errmsg* *errmsg-variable*
|
|
|
1340 v:errmsg Last given error message. It's allowed to set this variable.
|
|
|
1341 Example: >
|
|
|
1342 :let v:errmsg = ""
|
|
|
1343 :silent! next
|
|
|
1344 :if v:errmsg != ""
|
|
|
1345 : ... handle error
|
|
|
1346 < "errmsg" also works, for backwards compatibility.
|
|
|
1347
|
|
|
1348 *v:exception* *exception-variable*
|
|
|
1349 v:exception The value of the exception most recently caught and not
|
|
|
1350 finished. See also |v:throwpoint| and |throw-variables|.
|
|
|
1351 Example: >
|
|
|
1352 :try
|
|
|
1353 : throw "oops"
|
|
|
1354 :catch /.*/
|
|
|
1355 : echo "caught" v:exception
|
|
|
1356 :endtry
|
|
|
1357 < Output: "caught oops".
|
|
|
1358
|
|
179
|
1359 *v:fcs_reason* *fcs_reason-variable*
|
|
|
1360 v:fcs_reason The reason why the |FileChangedShell| event was triggered.
|
|
|
1361 Can be used in an autocommand to decide what to do and/or what
|
|
|
1362 to set v:fcs_choice to. Possible values:
|
|
|
1363 deleted file no longer exists
|
|
|
1364 conflict file contents, mode or timestamp was
|
|
|
1365 changed and buffer is modified
|
|
|
1366 changed file contents has changed
|
|
|
1367 mode mode of file changed
|
|
|
1368 time only file timestamp changed
|
|
|
1369
|
|
|
1370 *v:fcs_choice* *fcs_choice-variable*
|
|
|
1371 v:fcs_choice What should happen after a |FileChangedShell| event was
|
|
|
1372 triggered. Can be used in an autocommand to tell Vim what to
|
|
|
1373 do with the affected buffer:
|
|
|
1374 reload Reload the buffer (does not work if
|
|
|
1375 the file was deleted).
|
|
|
1376 ask Ask the user what to do, as if there
|
|
|
1377 was no autocommand. Except that when
|
|
|
1378 only the timestamp changed nothing
|
|
|
1379 will happen.
|
|
|
1380 <empty> Nothing, the autocommand should do
|
|
|
1381 everything that needs to be done.
|
|
|
1382 The default is empty. If another (invalid) value is used then
|
|
|
1383 Vim behaves like it is empty, there is no warning message.
|
|
|
1384
|
|
7
|
1385 *v:fname_in* *fname_in-variable*
|
|
579
|
1386 v:fname_in The name of the input file. Valid while evaluating:
|
|
7
|
1387 option used for ~
|
|
|
1388 'charconvert' file to be converted
|
|
|
1389 'diffexpr' original file
|
|
|
1390 'patchexpr' original file
|
|
|
1391 'printexpr' file to be printed
|
|
593
|
1392 And set to the swap file name for |SwapExists|.
|
|
7
|
1393
|
|
|
1394 *v:fname_out* *fname_out-variable*
|
|
|
1395 v:fname_out The name of the output file. Only valid while
|
|
|
1396 evaluating:
|
|
|
1397 option used for ~
|
|
|
1398 'charconvert' resulting converted file (*)
|
|
|
1399 'diffexpr' output of diff
|
|
|
1400 'patchexpr' resulting patched file
|
|
|
1401 (*) When doing conversion for a write command (e.g., ":w
|
|
1621
|
1402 file") it will be equal to v:fname_in. When doing conversion
|
|
7
|
1403 for a read command (e.g., ":e file") it will be a temporary
|
|
|
1404 file and different from v:fname_in.
|
|
|
1405
|
|
|
1406 *v:fname_new* *fname_new-variable*
|
|
|
1407 v:fname_new The name of the new version of the file. Only valid while
|
|
|
1408 evaluating 'diffexpr'.
|
|
|
1409
|
|
|
1410 *v:fname_diff* *fname_diff-variable*
|
|
|
1411 v:fname_diff The name of the diff (patch) file. Only valid while
|
|
|
1412 evaluating 'patchexpr'.
|
|
|
1413
|
|
|
1414 *v:folddashes* *folddashes-variable*
|
|
|
1415 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
|
|
|
1416 fold.
|
|
29
|
1417 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1418
|
|
|
1419 *v:foldlevel* *foldlevel-variable*
|
|
|
1420 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
|
|
29
|
1421 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1422
|
|
|
1423 *v:foldend* *foldend-variable*
|
|
|
1424 v:foldend Used for 'foldtext': last line of closed fold.
|
|
29
|
1425 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1426
|
|
|
1427 *v:foldstart* *foldstart-variable*
|
|
|
1428 v:foldstart Used for 'foldtext': first line of closed fold.
|
|
29
|
1429 Read-only in the |sandbox|. |fold-foldtext|
|
|
7
|
1430
|
|
11
|
1431 *v:insertmode* *insertmode-variable*
|
|
|
1432 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
|
|
|
1433 events. Values:
|
|
|
1434 i Insert mode
|
|
|
1435 r Replace mode
|
|
|
1436 v Virtual Replace mode
|
|
|
1437
|
|
102
|
1438 *v:key* *key-variable*
|
|
685
|
1439 v:key Key of the current item of a |Dictionary|. Only valid while
|
|
102
|
1440 evaluating the expression used with |map()| and |filter()|.
|
|
|
1441 Read-only.
|
|
|
1442
|
|
7
|
1443 *v:lang* *lang-variable*
|
|
|
1444 v:lang The current locale setting for messages of the runtime
|
|
|
1445 environment. This allows Vim scripts to be aware of the
|
|
|
1446 current language. Technical: it's the value of LC_MESSAGES.
|
|
|
1447 The value is system dependent.
|
|
|
1448 This variable can not be set directly, use the |:language|
|
|
|
1449 command.
|
|
|
1450 It can be different from |v:ctype| when messages are desired
|
|
|
1451 in a different language than what is used for character
|
|
|
1452 encoding. See |multi-lang|.
|
|
|
1453
|
|
|
1454 *v:lc_time* *lc_time-variable*
|
|
|
1455 v:lc_time The current locale setting for time messages of the runtime
|
|
|
1456 environment. This allows Vim scripts to be aware of the
|
|
|
1457 current language. Technical: it's the value of LC_TIME.
|
|
|
1458 This variable can not be set directly, use the |:language|
|
|
|
1459 command. See |multi-lang|.
|
|
|
1460
|
|
|
1461 *v:lnum* *lnum-variable*
|
|
29
|
1462 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr'
|
|
839
|
1463 expressions, tab page number for 'guitablabel' and
|
|
|
1464 'guitabtooltip'. Only valid while one of these expressions is
|
|
|
1465 being evaluated. Read-only when in the |sandbox|.
|
|
7
|
1466
|
|
1029
|
1467 *v:mouse_win* *mouse_win-variable*
|
|
|
1468 v:mouse_win Window number for a mouse click obtained with |getchar()|.
|
|
|
1469 First window has number 1, like with |winnr()|. The value is
|
|
|
1470 zero when there was no mouse button click.
|
|
|
1471
|
|
|
1472 *v:mouse_lnum* *mouse_lnum-variable*
|
|
|
1473 v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
|
|
|
1474 This is the text line number, not the screen line number. The
|
|
|
1475 value is zero when there was no mouse button click.
|
|
|
1476
|
|
|
1477 *v:mouse_col* *mouse_col-variable*
|
|
|
1478 v:mouse_col Column number for a mouse click obtained with |getchar()|.
|
|
|
1479 This is the screen column number, like with |virtcol()|. The
|
|
|
1480 value is zero when there was no mouse button click.
|
|
|
1481
|
|
1490
|
1482 *v:operator* *operator-variable*
|
|
|
1483 v:operator The last operator given in Normal mode. This is a single
|
|
|
1484 character except for commands starting with <g> or <z>,
|
|
|
1485 in which case it is two characters. Best used alongside
|
|
|
1486 |v:prevcount| and |v:register|. Useful if you want to cancel
|
|
|
1487 Operator-pending mode and then use the operator, e.g.: >
|
|
|
1488 :omap O <Esc>:call MyMotion(v:operator)<CR>
|
|
|
1489 < The value remains set until another operator is entered, thus
|
|
|
1490 don't expect it to be empty.
|
|
|
1491 v:operator is not set for |:delete|, |:yank| or other Ex
|
|
|
1492 commands.
|
|
|
1493 Read-only.
|
|
|
1494
|
|
7
|
1495 *v:prevcount* *prevcount-variable*
|
|
|
1496 v:prevcount The count given for the last but one Normal mode command.
|
|
|
1497 This is the v:count value of the previous command. Useful if
|
|
1490
|
1498 you want to cancel Visual or Operator-pending mode and then
|
|
|
1499 use the count, e.g.: >
|
|
7
|
1500 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
|
|
|
1501 < Read-only.
|
|
|
1502
|
|
170
|
1503 *v:profiling* *profiling-variable*
|
|
1621
|
1504 v:profiling Normally zero. Set to one after using ":profile start".
|
|
170
|
1505 See |profiling|.
|
|
|
1506
|
|
7
|
1507 *v:progname* *progname-variable*
|
|
|
1508 v:progname Contains the name (with path removed) with which Vim was
|
|
|
1509 invoked. Allows you to do special initialisations for "view",
|
|
|
1510 "evim" etc., or any other name you might symlink to Vim.
|
|
|
1511 Read-only.
|
|
|
1512
|
|
|
1513 *v:register* *register-variable*
|
|
|
1514 v:register The name of the register supplied to the last normal mode
|
|
|
1515 command. Empty if none were supplied. |getreg()| |setreg()|
|
|
|
1516
|
|
540
|
1517 *v:scrollstart* *scrollstart-variable*
|
|
|
1518 v:scrollstart String describing the script or function that caused the
|
|
|
1519 screen to scroll up. It's only set when it is empty, thus the
|
|
|
1520 first reason is remembered. It is set to "Unknown" for a
|
|
|
1521 typed command.
|
|
|
1522 This can be used to find out why your script causes the
|
|
|
1523 hit-enter prompt.
|
|
|
1524
|
|
7
|
1525 *v:servername* *servername-variable*
|
|
|
1526 v:servername The resulting registered |x11-clientserver| name if any.
|
|
|
1527 Read-only.
|
|
|
1528
|
|
1621
|
1529
|
|
|
1530 v:searchforward *v:searchforward* *searchforward-variable*
|
|
|
1531 Search direction: 1 after a forward search, 0 after a
|
|
|
1532 backward search. It is reset to forward when directly setting
|
|
|
1533 the last search pattern, see |quote/|.
|
|
|
1534 Note that the value is restored when returning from a
|
|
|
1535 function. |function-search-undo|.
|
|
|
1536 Read-write.
|
|
|
1537
|
|
7
|
1538 *v:shell_error* *shell_error-variable*
|
|
|
1539 v:shell_error Result of the last shell command. When non-zero, the last
|
|
|
1540 shell command had an error. When zero, there was no problem.
|
|
|
1541 This only works when the shell returns the error code to Vim.
|
|
|
1542 The value -1 is often used when the command could not be
|
|
|
1543 executed. Read-only.
|
|
|
1544 Example: >
|
|
|
1545 :!mv foo bar
|
|
|
1546 :if v:shell_error
|
|
|
1547 : echo 'could not rename "foo" to "bar"!'
|
|
|
1548 :endif
|
|
|
1549 < "shell_error" also works, for backwards compatibility.
|
|
|
1550
|
|
|
1551 *v:statusmsg* *statusmsg-variable*
|
|
|
1552 v:statusmsg Last given status message. It's allowed to set this variable.
|
|
|
1553
|
|
579
|
1554 *v:swapname* *swapname-variable*
|
|
|
1555 v:swapname Only valid when executing |SwapExists| autocommands: Name of
|
|
|
1556 the swap file found. Read-only.
|
|
|
1557
|
|
|
1558 *v:swapchoice* *swapchoice-variable*
|
|
|
1559 v:swapchoice |SwapExists| autocommands can set this to the selected choice
|
|
|
1560 for handling an existing swap file:
|
|
|
1561 'o' Open read-only
|
|
|
1562 'e' Edit anyway
|
|
|
1563 'r' Recover
|
|
|
1564 'd' Delete swapfile
|
|
|
1565 'q' Quit
|
|
|
1566 'a' Abort
|
|
1621
|
1567 The value should be a single-character string. An empty value
|
|
579
|
1568 results in the user being asked, as would happen when there is
|
|
|
1569 no SwapExists autocommand. The default is empty.
|
|
|
1570
|
|
590
|
1571 *v:swapcommand* *swapcommand-variable*
|
|
625
|
1572 v:swapcommand Normal mode command to be executed after a file has been
|
|
590
|
1573 opened. Can be used for a |SwapExists| autocommand to have
|
|
1621
|
1574 another Vim open the file and jump to the right place. For
|
|
590
|
1575 example, when jumping to a tag the value is ":tag tagname\r".
|
|
716
|
1576 For ":edit +cmd file" the value is ":cmd\r".
|
|
590
|
1577
|
|
7
|
1578 *v:termresponse* *termresponse-variable*
|
|
|
1579 v:termresponse The escape sequence returned by the terminal for the |t_RV|
|
|
1621
|
1580 termcap entry. It is set when Vim receives an escape sequence
|
|
7
|
1581 that starts with ESC [ or CSI and ends in a 'c', with only
|
|
|
1582 digits, ';' and '.' in between.
|
|
|
1583 When this option is set, the TermResponse autocommand event is
|
|
|
1584 fired, so that you can react to the response from the
|
|
|
1585 terminal.
|
|
|
1586 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
|
|
|
1587 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
|
|
|
1588 patch level (since this was introduced in patch 95, it's
|
|
|
1589 always 95 or bigger). Pc is always zero.
|
|
|
1590 {only when compiled with |+termresponse| feature}
|
|
|
1591
|
|
|
1592 *v:this_session* *this_session-variable*
|
|
|
1593 v:this_session Full filename of the last loaded or saved session file. See
|
|
|
1594 |:mksession|. It is allowed to set this variable. When no
|
|
|
1595 session file has been saved, this variable is empty.
|
|
|
1596 "this_session" also works, for backwards compatibility.
|
|
|
1597
|
|
|
1598 *v:throwpoint* *throwpoint-variable*
|
|
|
1599 v:throwpoint The point where the exception most recently caught and not
|
|
1621
|
1600 finished was thrown. Not set when commands are typed. See
|
|
7
|
1601 also |v:exception| and |throw-variables|.
|
|
|
1602 Example: >
|
|
|
1603 :try
|
|
|
1604 : throw "oops"
|
|
|
1605 :catch /.*/
|
|
|
1606 : echo "Exception from" v:throwpoint
|
|
|
1607 :endtry
|
|
|
1608 < Output: "Exception from test.vim, line 2"
|
|
|
1609
|
|
102
|
1610 *v:val* *val-variable*
|
|
1621
|
1611 v:val Value of the current item of a |List| or |Dictionary|. Only
|
|
685
|
1612 valid while evaluating the expression used with |map()| and
|
|
102
|
1613 |filter()|. Read-only.
|
|
|
1614
|
|
7
|
1615 *v:version* *version-variable*
|
|
|
1616 v:version Version number of Vim: Major version number times 100 plus
|
|
|
1617 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
|
|
|
1618 is 501. Read-only. "version" also works, for backwards
|
|
|
1619 compatibility.
|
|
|
1620 Use |has()| to check if a certain patch was included, e.g.: >
|
|
|
1621 if has("patch123")
|
|
|
1622 < Note that patch numbers are specific to the version, thus both
|
|
|
1623 version 5.0 and 5.1 may have a patch 123, but these are
|
|
|
1624 completely different.
|
|
|
1625
|
|
|
1626 *v:warningmsg* *warningmsg-variable*
|
|
|
1627 v:warningmsg Last given warning message. It's allowed to set this variable.
|
|
|
1628
|
|
|
1629 ==============================================================================
|
|
|
1630 4. Builtin Functions *functions*
|
|
|
1631
|
|
|
1632 See |function-list| for a list grouped by what the function is used for.
|
|
|
1633
|
|
236
|
1634 (Use CTRL-] on the function name to jump to the full explanation.)
|
|
7
|
1635
|
|
|
1636 USAGE RESULT DESCRIPTION ~
|
|
|
1637
|
|
1621
|
1638 abs( {expr}) Float or Number absolute value of {expr}
|
|
685
|
1639 add( {list}, {item}) List append {item} to |List| {list}
|
|
55
|
1640 append( {lnum}, {string}) Number append {string} below line {lnum}
|
|
161
|
1641 append( {lnum}, {list}) Number append lines {list} below line {lnum}
|
|
7
|
1642 argc() Number number of files in the argument list
|
|
55
|
1643 argidx() Number current index in the argument list
|
|
7
|
1644 argv( {nr}) String {nr} entry of the argument list
|
|
818
|
1645 argv( ) List the argument list
|
|
1621
|
1646 atan( {expr}) Float arc tangent of {expr}
|
|
7
|
1647 browse( {save}, {title}, {initdir}, {default})
|
|
|
1648 String put up a file requester
|
|
1621
|
1649 browsedir( {title}, {initdir}) String put up a directory requester
|
|
7
|
1650 bufexists( {expr}) Number TRUE if buffer {expr} exists
|
|
55
|
1651 buflisted( {expr}) Number TRUE if buffer {expr} is listed
|
|
|
1652 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
|
|
7
|
1653 bufname( {expr}) String Name of the buffer {expr}
|
|
|
1654 bufnr( {expr}) Number Number of the buffer {expr}
|
|
|
1655 bufwinnr( {expr}) Number window number of buffer {expr}
|
|
|
1656 byte2line( {byte}) Number line number at byte count {byte}
|
|
55
|
1657 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
|
|
102
|
1658 call( {func}, {arglist} [, {dict}])
|
|
|
1659 any call {func} with arguments {arglist}
|
|
1621
|
1660 ceil( {expr}) Float round {expr} up
|
|
|
1661 changenr() Number current change number
|
|
7
|
1662 char2nr( {expr}) Number ASCII value of first char in {expr}
|
|
55
|
1663 cindent( {lnum}) Number C indent for line {lnum}
|
|
1326
|
1664 clearmatches() None clear all matches
|
|
7
|
1665 col( {expr}) Number column nr of cursor or mark
|
|
1621
|
1666 complete({startcol}, {matches}) String set Insert mode completion
|
|
464
|
1667 complete_add( {expr}) Number add completion match
|
|
1621
|
1668 complete_check() Number check for key typed during completion
|
|
7
|
1669 confirm( {msg} [, {choices} [, {default} [, {type}]]])
|
|
|
1670 Number number of choice picked by user
|
|
55
|
1671 copy( {expr}) any make a shallow copy of {expr}
|
|
1621
|
1672 cos( {expr}) Float cosine of {expr}
|
|
95
|
1673 count( {list}, {expr} [, {start} [, {ic}]])
|
|
|
1674 Number count how many {expr} are in {list}
|
|
7
|
1675 cscope_connection( [{num} , {dbpath} [, {prepend}]])
|
|
|
1676 Number checks existence of cscope connection
|
|
703
|
1677 cursor( {lnum}, {col} [, {coladd}])
|
|
|
1678 Number move cursor to {lnum}, {col}, {coladd}
|
|
|
1679 cursor( {list}) Number move cursor to position in {list}
|
|
55
|
1680 deepcopy( {expr}) any make a full copy of {expr}
|
|
7
|
1681 delete( {fname}) Number delete file {fname}
|
|
|
1682 did_filetype() Number TRUE if FileType autocommand event used
|
|
55
|
1683 diff_filler( {lnum}) Number diff filler lines about {lnum}
|
|
|
1684 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
|
|
85
|
1685 empty( {expr}) Number TRUE if {expr} is empty
|
|
7
|
1686 escape( {string}, {chars}) String escape {chars} in {string} with '\'
|
|
205
|
1687 eval( {string}) any evaluate {string} into its value
|
|
55
|
1688 eventhandler( ) Number TRUE if inside an event handler
|
|
7
|
1689 executable( {expr}) Number 1 if executable {expr} exists
|
|
|
1690 exists( {expr}) Number TRUE if {expr} exists
|
|
824
|
1691 extend({expr1}, {expr2} [, {expr3}])
|
|
|
1692 List/Dict insert items of {expr2} into {expr1}
|
|
7
|
1693 expand( {expr}) String expand special keywords in {expr}
|
|
1621
|
1694 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer
|
|
7
|
1695 filereadable( {file}) Number TRUE if {file} is a readable file
|
|
824
|
1696 filewritable( {file}) Number TRUE if {file} is a writable file
|
|
102
|
1697 filter( {expr}, {string}) List/Dict remove items from {expr} where
|
|
|
1698 {string} is 0
|
|
95
|
1699 finddir( {name}[, {path}[, {count}]])
|
|
824
|
1700 String find directory {name} in {path}
|
|
19
|
1701 findfile( {name}[, {path}[, {count}]])
|
|
824
|
1702 String find file {name} in {path}
|
|
1621
|
1703 float2nr( {expr}) Number convert Float {expr} to a Number
|
|
|
1704 floor( {expr}) Float round {expr} down
|
|
1586
|
1705 fnameescape( {fname}) String escape special characters in {fname}
|
|
7
|
1706 fnamemodify( {fname}, {mods}) String modify file name
|
|
55
|
1707 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
|
|
|
1708 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
|
|
7
|
1709 foldlevel( {lnum}) Number fold level at {lnum}
|
|
55
|
1710 foldtext( ) String line displayed for closed fold
|
|
824
|
1711 foldtextresult( {lnum}) String text for closed fold at {lnum}
|
|
7
|
1712 foreground( ) Number bring the Vim window to the foreground
|
|
55
|
1713 function( {name}) Funcref reference to function {name}
|
|
1405
|
1714 garbagecollect( [at_exit]) none free memory, breaking cyclic references
|
|
82
|
1715 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
|
|
102
|
1716 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
|
|
435
|
1717 getbufline( {expr}, {lnum} [, {end}])
|
|
|
1718 List lines {lnum} to {end} of buffer {expr}
|
|
824
|
1719 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr}
|
|
55
|
1720 getchar( [expr]) Number get one character from the user
|
|
|
1721 getcharmod( ) Number modifiers for the last typed character
|
|
7
|
1722 getcmdline() String return the current command-line
|
|
|
1723 getcmdpos() Number return cursor position in command-line
|
|
531
|
1724 getcmdtype() String return the current command-line type
|
|
7
|
1725 getcwd() String the current working directory
|
|
20
|
1726 getfperm( {fname}) String file permissions of file {fname}
|
|
|
1727 getfsize( {fname}) Number size in bytes of file {fname}
|
|
37
|
1728 getfontname( [{name}]) String name of font being used
|
|
7
|
1729 getftime( {fname}) Number last modification time of file
|
|
20
|
1730 getftype( {fname}) String description of type of file {fname}
|
|
161
|
1731 getline( {lnum}) String line {lnum} of current buffer
|
|
|
1732 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
|
|
647
|
1733 getloclist({nr}) List list of location list items
|
|
1326
|
1734 getmatches() List list of current matches
|
|
1548
|
1735 getpid() Number process ID of Vim
|
|
703
|
1736 getpos( {expr}) List position of cursor, mark, etc.
|
|
230
|
1737 getqflist() List list of quickfix items
|
|
282
|
1738 getreg( [{regname} [, 1]]) String contents of register
|
|
55
|
1739 getregtype( [{regname}]) String type of register
|
|
831
|
1740 gettabwinvar( {tabnr}, {winnr}, {name})
|
|
|
1741 any {name} in {winnr} in tab page {tabnr}
|
|
7
|
1742 getwinposx() Number X coord in pixels of GUI Vim window
|
|
|
1743 getwinposy() Number Y coord in pixels of GUI Vim window
|
|
824
|
1744 getwinvar( {nr}, {varname}) any variable {varname} in window {nr}
|
|
7
|
1745 glob( {expr}) String expand file wildcards in {expr}
|
|
|
1746 globpath( {path}, {expr}) String do glob({expr}) for all dirs in {path}
|
|
|
1747 has( {feature}) Number TRUE if feature {feature} supported
|
|
102
|
1748 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
|
|
1104
|
1749 haslocaldir() Number TRUE if current window executed |:lcd|
|
|
782
|
1750 hasmapto( {what} [, {mode} [, {abbr}]])
|
|
|
1751 Number TRUE if mapping to {what} exists
|
|
7
|
1752 histadd( {history},{item}) String add an item to a history
|
|
|
1753 histdel( {history} [, {item}]) String remove an item from a history
|
|
|
1754 histget( {history} [, {index}]) String get the item {index} from a history
|
|
|
1755 histnr( {history}) Number highest index of a history
|
|
|
1756 hlexists( {name}) Number TRUE if highlight group {name} exists
|
|
|
1757 hlID( {name}) Number syntax ID of highlight group {name}
|
|
|
1758 hostname() String name of the machine Vim is running on
|
|
55
|
1759 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
|
|
|
1760 indent( {lnum}) Number indent of line {lnum}
|
|
95
|
1761 index( {list}, {expr} [, {start} [, {ic}]])
|
|
|
1762 Number index in {list} where {expr} appears
|
|
531
|
1763 input( {prompt} [, {text} [, {completion}]])
|
|
|
1764 String get input from the user
|
|
7
|
1765 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
|
|
824
|
1766 inputlist( {textlist}) Number let the user pick from a choice list
|
|
55
|
1767 inputrestore() Number restore typeahead
|
|
|
1768 inputsave() Number save and clear typeahead
|
|
7
|
1769 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
|
|
55
|
1770 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
|
|
7
|
1771 isdirectory( {directory}) Number TRUE if {directory} is a directory
|
|
148
|
1772 islocked( {expr}) Number TRUE if {expr} is locked
|
|
685
|
1773 items( {dict}) List key-value pairs in {dict}
|
|
95
|
1774 join( {list} [, {sep}]) String join {list} items into one String
|
|
685
|
1775 keys( {dict}) List keys in {dict}
|
|
55
|
1776 len( {expr}) Number the length of {expr}
|
|
|
1777 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
|
|
7
|
1778 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
|
|
|
1779 line( {expr}) Number line nr of cursor, last line or mark
|
|
|
1780 line2byte( {lnum}) Number byte count of line {lnum}
|
|
55
|
1781 lispindent( {lnum}) Number Lisp indent for line {lnum}
|
|
7
|
1782 localtime() Number current time
|
|
1621
|
1783 log10( {expr}) Float logarithm of Float {expr} to base 10
|
|
102
|
1784 map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
|
|
782
|
1785 maparg( {name}[, {mode} [, {abbr}]])
|
|
|
1786 String rhs of mapping {name} in mode {mode}
|
|
|
1787 mapcheck( {name}[, {mode} [, {abbr}]])
|
|
|
1788 String check for mappings matching {name}
|
|
19
|
1789 match( {expr}, {pat}[, {start}[, {count}]])
|
|
7
|
1790 Number position where {pat} matches in {expr}
|
|
1326
|
1791 matchadd( {group}, {pattern}[, {priority}[, {id}]])
|
|
|
1792 Number highlight {pattern} with {group}
|
|
819
|
1793 matcharg( {nr}) List arguments of |:match|
|
|
1326
|
1794 matchdelete( {id}) Number delete match identified by {id}
|
|
19
|
1795 matchend( {expr}, {pat}[, {start}[, {count}]])
|
|
7
|
1796 Number position where {pat} ends in {expr}
|
|
158
|
1797 matchlist( {expr}, {pat}[, {start}[, {count}]])
|
|
|
1798 List match and submatches of {pat} in {expr}
|
|
19
|
1799 matchstr( {expr}, {pat}[, {start}[, {count}]])
|
|
|
1800 String {count}'th match of {pat} in {expr}
|
|
87
|
1801 max({list}) Number maximum value of items in {list}
|
|
1215
|
1802 min({list}) Number minimum value of items in {list}
|
|
168
|
1803 mkdir({name} [, {path} [, {prot}]])
|
|
|
1804 Number create directory {name}
|
|
1621
|
1805 mode( [expr]) String current editing mode
|
|
7
|
1806 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
|
|
|
1807 nr2char( {expr}) String single char with ASCII value {expr}
|
|
819
|
1808 pathshorten( {expr}) String shorten directory names in a path
|
|
1621
|
1809 pow( {x}, {y}) Float {x} to the power of {y}
|
|
7
|
1810 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
|
|
1621
|
1811 printf( {fmt}, {expr1}...) String format text
|
|
|
1812 pumvisible() Number whether popup menu is visible
|
|
99
|
1813 range( {expr} [, {max} [, {stride}]])
|
|
|
1814 List items from {expr} to {max}
|
|
168
|
1815 readfile({fname} [, {binary} [, {max}]])
|
|
|
1816 List get list of lines from file {fname}
|
|
794
|
1817 reltime( [{start} [, {end}]]) List get time value
|
|
|
1818 reltimestr( {time}) String turn time value into a String
|
|
7
|
1819 remote_expr( {server}, {string} [, {idvar}])
|
|
|
1820 String send expression
|
|
|
1821 remote_foreground( {server}) Number bring Vim server to the foreground
|
|
|
1822 remote_peek( {serverid} [, {retvar}])
|
|
|
1823 Number check for reply string
|
|
|
1824 remote_read( {serverid}) String read reply string
|
|
|
1825 remote_send( {server}, {string} [, {idvar}])
|
|
|
1826 String send key sequence
|
|
79
|
1827 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
|
|
856
|
1828 remove( {dict}, {key}) any remove entry {key} from {dict}
|
|
55
|
1829 rename( {from}, {to}) Number rename (move) file from {from} to {to}
|
|
|
1830 repeat( {expr}, {count}) String repeat {expr} {count} times
|
|
|
1831 resolve( {filename}) String get filename a shortcut points to
|
|
82
|
1832 reverse( {list}) List reverse {list} in-place
|
|
1621
|
1833 round( {expr}) Float round off {expr}
|
|
1496
|
1834 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
|
|
|
1835 Number search for {pattern}
|
|
523
|
1836 searchdecl({name} [, {global} [, {thisblock}]])
|
|
1621
|
1837 Number search for variable declaration
|
|
1496
|
1838 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
|
|
55
|
1839 Number search for other end of start/end pair
|
|
1496
|
1840 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
|
|
667
|
1841 List search for other end of start/end pair
|
|
1496
|
1842 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
|
|
667
|
1843 List search for {pattern}
|
|
7
|
1844 server2client( {clientid}, {string})
|
|
|
1845 Number send reply string
|
|
|
1846 serverlist() String get a list of available servers
|
|
|
1847 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
|
|
|
1848 setcmdpos( {pos}) Number set cursor position in command-line
|
|
|
1849 setline( {lnum}, {line}) Number set line {lnum} to {line}
|
|
647
|
1850 setloclist( {nr}, {list}[, {action}])
|
|
|
1851 Number modify location list using {list}
|
|
1326
|
1852 setmatches( {list}) Number restore a list of matches
|
|
824
|
1853 setpos( {expr}, {list}) none set the {expr} position to {list}
|
|
647
|
1854 setqflist( {list}[, {action}]) Number modify quickfix list using {list}
|
|
55
|
1855 setreg( {n}, {v}[, {opt}]) Number set register to value and type
|
|
831
|
1856 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
|
|
|
1857 {winnr} in tab page {tabnr} to {val}
|
|
7
|
1858 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
|
|
985
|
1859 shellescape( {string}) String escape {string} for use as shell
|
|
|
1860 command argument
|
|
55
|
1861 simplify( {filename}) String simplify filename as much as possible
|
|
1621
|
1862 sin( {expr}) Float sine of {expr}
|
|
82
|
1863 sort( {list} [, {func}]) List sort {list}, using {func} to compare
|
|
374
|
1864 soundfold( {word}) String sound-fold {word}
|
|
344
|
1865 spellbadword() String badly spelled word at cursor
|
|
537
|
1866 spellsuggest( {word} [, {max} [, {capital}]])
|
|
|
1867 List spelling suggestions
|
|
282
|
1868 split( {expr} [, {pat} [, {keepempty}]])
|
|
685
|
1869 List make |List| from {pat} separated {expr}
|
|
1621
|
1870 sqrt( {expr} Float squar root of {expr}
|
|
|
1871 str2float( {expr}) Float convert String to Float
|
|
|
1872 str2nr( {expr} [, {base}]) Number convert String to Number
|
|
7
|
1873 strftime( {format}[, {time}]) String time in specified format
|
|
133
|
1874 stridx( {haystack}, {needle}[, {start}])
|
|
|
1875 Number index of {needle} in {haystack}
|
|
95
|
1876 string( {expr}) String String representation of {expr} value
|
|
7
|
1877 strlen( {expr}) Number length of the String {expr}
|
|
|
1878 strpart( {src}, {start}[, {len}])
|
|
|
1879 String {len} characters of {src} at {start}
|
|
140
|
1880 strridx( {haystack}, {needle} [, {start}])
|
|
|
1881 Number last index of {needle} in {haystack}
|
|
7
|
1882 strtrans( {expr}) String translate string to make it printable
|
|
55
|
1883 submatch( {nr}) String specific match in ":substitute"
|
|
7
|
1884 substitute( {expr}, {pat}, {sub}, {flags})
|
|
|
1885 String all {pat} in {expr} replaced with {sub}
|
|
32
|
1886 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
|
|
7
|
1887 synIDattr( {synID}, {what} [, {mode}])
|
|
|
1888 String attribute {what} of syntax ID {synID}
|
|
|
1889 synIDtrans( {synID}) Number translated syntax ID of {synID}
|
|
1621
|
1890 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
|
|
24
|
1891 system( {expr} [, {input}]) String output of shell command/filter {expr}
|
|
677
|
1892 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
|
|
|
1893 tabpagenr( [{arg}]) Number number of current or last tab page
|
|
|
1894 tabpagewinnr( {tabarg}[, {arg}])
|
|
|
1895 Number number of current window in tab page
|
|
|
1896 taglist( {expr}) List list of tags matching {expr}
|
|
1621
|
1897 tagfiles() List tags files used
|
|
7
|
1898 tempname() String name for a temporary file
|
|
|
1899 tolower( {expr}) String the String {expr} switched to lowercase
|
|
|
1900 toupper( {expr}) String the String {expr} switched to uppercase
|
|
15
|
1901 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
|
|
|
1902 to chars in {tostr}
|
|
1621
|
1903 trunc( {expr} Float truncate Float {expr}
|
|
7
|
1904 type( {name}) Number type of variable {name}
|
|
685
|
1905 values( {dict}) List values in {dict}
|
|
7
|
1906 virtcol( {expr}) Number screen column of cursor or mark
|
|
|
1907 visualmode( [expr]) String last visual mode used
|
|
|
1908 winbufnr( {nr}) Number buffer number of window {nr}
|
|
|
1909 wincol() Number window column of the cursor
|
|
|
1910 winheight( {nr}) Number height of window {nr}
|
|
|
1911 winline() Number window line of the cursor
|
|
674
|
1912 winnr( [{expr}]) Number number of current window
|
|
55
|
1913 winrestcmd() String returns command to restore window sizes
|
|
712
|
1914 winrestview({dict}) None restore view of current window
|
|
|
1915 winsaveview() Dict save view of current window
|
|
7
|
1916 winwidth( {nr}) Number width of window {nr}
|
|
158
|
1917 writefile({list}, {fname} [, {binary}])
|
|
|
1918 Number write list of lines to file {fname}
|
|
7
|
1919
|
|
1621
|
1920 abs({expr}) *abs()*
|
|
|
1921 Return the absolute value of {expr}. When {expr} evaluates to
|
|
|
1922 a |Float| abs() returns a |Float|. When {expr} can be
|
|
|
1923 converted to a |Number| abs() returns a |Number|. Otherwise
|
|
|
1924 abs() gives an error message and returns -1.
|
|
|
1925 Examples: >
|
|
|
1926 echo abs(1.456)
|
|
|
1927 < 1.456 >
|
|
|
1928 echo abs(-5.456)
|
|
|
1929 < 5.456 >
|
|
|
1930 echo abs(-4)
|
|
|
1931 < 4
|
|
|
1932 {only available when compiled with the |+float| feature}
|
|
|
1933
|
|
82
|
1934 add({list}, {expr}) *add()*
|
|
685
|
1935 Append the item {expr} to |List| {list}. Returns the
|
|
|
1936 resulting |List|. Examples: >
|
|
82
|
1937 :let alist = add([1, 2, 3], item)
|
|
|
1938 :call add(mylist, "woodstock")
|
|
685
|
1939 < Note that when {expr} is a |List| it is appended as a single
|
|
692
|
1940 item. Use |extend()| to concatenate |Lists|.
|
|
85
|
1941 Use |insert()| to add an item at another position.
|
|
55
|
1942
|
|
82
|
1943
|
|
|
1944 append({lnum}, {expr}) *append()*
|
|
685
|
1945 When {expr} is a |List|: Append each item of the |List| as a
|
|
|
1946 text line below line {lnum} in the current buffer.
|
|
153
|
1947 Otherwise append {expr} as one text line below line {lnum} in
|
|
|
1948 the current buffer.
|
|
|
1949 {lnum} can be zero to insert a line before the first one.
|
|
82
|
1950 Returns 1 for failure ({lnum} out of range or out of memory),
|
|
1621
|
1951 0 for success. Example: >
|
|
55
|
1952 :let failed = append(line('$'), "# THE END")
|
|
82
|
1953 :let failed = append(0, ["Chapter 1", "the beginning"])
|
|
55
|
1954 <
|
|
7
|
1955 *argc()*
|
|
|
1956 argc() The result is the number of files in the argument list of the
|
|
|
1957 current window. See |arglist|.
|
|
|
1958
|
|
|
1959 *argidx()*
|
|
|
1960 argidx() The result is the current index in the argument list. 0 is
|
|
|
1961 the first file. argc() - 1 is the last one. See |arglist|.
|
|
|
1962
|
|
|
1963 *argv()*
|
|
818
|
1964 argv([{nr}]) The result is the {nr}th file in the argument list of the
|
|
7
|
1965 current window. See |arglist|. "argv(0)" is the first one.
|
|
|
1966 Example: >
|
|
|
1967 :let i = 0
|
|
|
1968 :while i < argc()
|
|
1621
|
1969 : let f = escape(fnameescape(argv(i)), '.')
|
|
7
|
1970 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
|
|
|
1971 : let i = i + 1
|
|
|
1972 :endwhile
|
|
818
|
1973 < Without the {nr} argument a |List| with the whole |arglist| is
|
|
|
1974 returned.
|
|
|
1975
|
|
1621
|
1976 atan({expr}) *atan()*
|
|
|
1977 Return the principal value of the arc tangent of {expr}, in
|
|
|
1978 the range [-pi/2, +pi/2] radians, as a |Float|.
|
|
|
1979 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
1980 Examples: >
|
|
|
1981 :echo atan(100)
|
|
|
1982 < 1.560797 >
|
|
|
1983 :echo atan(-4.01)
|
|
|
1984 < -1.326405
|
|
|
1985 {only available when compiled with the |+float| feature}
|
|
|
1986
|
|
7
|
1987 *browse()*
|
|
|
1988 browse({save}, {title}, {initdir}, {default})
|
|
|
1989 Put up a file requester. This only works when "has("browse")"
|
|
|
1990 returns non-zero (only in some GUI versions).
|
|
|
1991 The input fields are:
|
|
|
1992 {save} when non-zero, select file to write
|
|
|
1993 {title} title for the requester
|
|
|
1994 {initdir} directory to start browsing in
|
|
|
1995 {default} default file name
|
|
|
1996 When the "Cancel" button is hit, something went wrong, or
|
|
|
1997 browsing is not possible, an empty string is returned.
|
|
|
1998
|
|
29
|
1999 *browsedir()*
|
|
|
2000 browsedir({title}, {initdir})
|
|
|
2001 Put up a directory requester. This only works when
|
|
|
2002 "has("browse")" returns non-zero (only in some GUI versions).
|
|
|
2003 On systems where a directory browser is not supported a file
|
|
|
2004 browser is used. In that case: select a file in the directory
|
|
|
2005 to be used.
|
|
|
2006 The input fields are:
|
|
|
2007 {title} title for the requester
|
|
|
2008 {initdir} directory to start browsing in
|
|
|
2009 When the "Cancel" button is hit, something went wrong, or
|
|
|
2010 browsing is not possible, an empty string is returned.
|
|
|
2011
|
|
7
|
2012 bufexists({expr}) *bufexists()*
|
|
|
2013 The result is a Number, which is non-zero if a buffer called
|
|
|
2014 {expr} exists.
|
|
9
|
2015 If the {expr} argument is a number, buffer numbers are used.
|
|
7
|
2016 If the {expr} argument is a string it must match a buffer name
|
|
9
|
2017 exactly. The name can be:
|
|
|
2018 - Relative to the current directory.
|
|
|
2019 - A full path.
|
|
1621
|
2020 - The name of a buffer with 'buftype' set to "nofile".
|
|
9
|
2021 - A URL name.
|
|
7
|
2022 Unlisted buffers will be found.
|
|
|
2023 Note that help files are listed by their short name in the
|
|
|
2024 output of |:buffers|, but bufexists() requires using their
|
|
|
2025 long name to be able to find them.
|
|
1621
|
2026 bufexists() may report a buffer exists, but to use the name
|
|
|
2027 with a |:buffer| command you may need to use |expand()|. Esp
|
|
|
2028 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
|
|
7
|
2029 Use "bufexists(0)" to test for the existence of an alternate
|
|
|
2030 file name.
|
|
|
2031 *buffer_exists()*
|
|
|
2032 Obsolete name: buffer_exists().
|
|
|
2033
|
|
|
2034 buflisted({expr}) *buflisted()*
|
|
|
2035 The result is a Number, which is non-zero if a buffer called
|
|
|
2036 {expr} exists and is listed (has the 'buflisted' option set).
|
|
9
|
2037 The {expr} argument is used like with |bufexists()|.
|
|
7
|
2038
|
|
|
2039 bufloaded({expr}) *bufloaded()*
|
|
|
2040 The result is a Number, which is non-zero if a buffer called
|
|
|
2041 {expr} exists and is loaded (shown in a window or hidden).
|
|
9
|
2042 The {expr} argument is used like with |bufexists()|.
|
|
7
|
2043
|
|
|
2044 bufname({expr}) *bufname()*
|
|
|
2045 The result is the name of a buffer, as it is displayed by the
|
|
|
2046 ":ls" command.
|
|
|
2047 If {expr} is a Number, that buffer number's name is given.
|
|
|
2048 Number zero is the alternate buffer for the current window.
|
|
|
2049 If {expr} is a String, it is used as a |file-pattern| to match
|
|
1621
|
2050 with the buffer names. This is always done like 'magic' is
|
|
7
|
2051 set and 'cpoptions' is empty. When there is more than one
|
|
|
2052 match an empty string is returned.
|
|
|
2053 "" or "%" can be used for the current buffer, "#" for the
|
|
|
2054 alternate buffer.
|
|
|
2055 A full match is preferred, otherwise a match at the start, end
|
|
1156
|
2056 or middle of the buffer name is accepted. If you only want a
|
|
|
2057 full match then put "^" at the start and "$" at the end of the
|
|
|
2058 pattern.
|
|
7
|
2059 Listed buffers are found first. If there is a single match
|
|
|
2060 with a listed buffer, that one is returned. Next unlisted
|
|
|
2061 buffers are searched for.
|
|
|
2062 If the {expr} is a String, but you want to use it as a buffer
|
|
|
2063 number, force it to be a Number by adding zero to it: >
|
|
|
2064 :echo bufname("3" + 0)
|
|
|
2065 < If the buffer doesn't exist, or doesn't have a name, an empty
|
|
|
2066 string is returned. >
|
|
|
2067 bufname("#") alternate buffer name
|
|
|
2068 bufname(3) name of buffer 3
|
|
|
2069 bufname("%") name of current buffer
|
|
|
2070 bufname("file2") name of buffer where "file2" matches.
|
|
|
2071 < *buffer_name()*
|
|
|
2072 Obsolete name: buffer_name().
|
|
|
2073
|
|
|
2074 *bufnr()*
|
|
707
|
2075 bufnr({expr} [, {create}])
|
|
|
2076 The result is the number of a buffer, as it is displayed by
|
|
7
|
2077 the ":ls" command. For the use of {expr}, see |bufname()|
|
|
707
|
2078 above.
|
|
|
2079 If the buffer doesn't exist, -1 is returned. Or, if the
|
|
|
2080 {create} argument is present and not zero, a new, unlisted,
|
|
|
2081 buffer is created and its number is returned.
|
|
7
|
2082 bufnr("$") is the last buffer: >
|
|
|
2083 :let last_buffer = bufnr("$")
|
|
|
2084 < The result is a Number, which is the highest buffer number
|
|
|
2085 of existing buffers. Note that not all buffers with a smaller
|
|
|
2086 number necessarily exist, because ":bwipeout" may have removed
|
|
|
2087 them. Use bufexists() to test for the existence of a buffer.
|
|
|
2088 *buffer_number()*
|
|
|
2089 Obsolete name: buffer_number().
|
|
|
2090 *last_buffer_nr()*
|
|
|
2091 Obsolete name for bufnr("$"): last_buffer_nr().
|
|
|
2092
|
|
|
2093 bufwinnr({expr}) *bufwinnr()*
|
|
|
2094 The result is a Number, which is the number of the first
|
|
|
2095 window associated with buffer {expr}. For the use of {expr},
|
|
1621
|
2096 see |bufname()| above. If buffer {expr} doesn't exist or
|
|
7
|
2097 there is no such window, -1 is returned. Example: >
|
|
|
2098
|
|
|
2099 echo "A window containing buffer 1 is " . (bufwinnr(1))
|
|
|
2100
|
|
|
2101 < The number can be used with |CTRL-W_w| and ":wincmd w"
|
|
|
2102 |:wincmd|.
|
|
1156
|
2103 Only deals with the current tab page.
|
|
7
|
2104
|
|
|
2105
|
|
|
2106 byte2line({byte}) *byte2line()*
|
|
|
2107 Return the line number that contains the character at byte
|
|
|
2108 count {byte} in the current buffer. This includes the
|
|
|
2109 end-of-line character, depending on the 'fileformat' option
|
|
|
2110 for the current buffer. The first character has byte count
|
|
|
2111 one.
|
|
|
2112 Also see |line2byte()|, |go| and |:goto|.
|
|
|
2113 {not available when compiled without the |+byte_offset|
|
|
|
2114 feature}
|
|
|
2115
|
|
18
|
2116 byteidx({expr}, {nr}) *byteidx()*
|
|
|
2117 Return byte index of the {nr}'th character in the string
|
|
|
2118 {expr}. Use zero for the first character, it returns zero.
|
|
|
2119 This function is only useful when there are multibyte
|
|
|
2120 characters, otherwise the returned value is equal to {nr}.
|
|
|
2121 Composing characters are counted as a separate character.
|
|
|
2122 Example : >
|
|
|
2123 echo matchstr(str, ".", byteidx(str, 3))
|
|
|
2124 < will display the fourth character. Another way to do the
|
|
|
2125 same: >
|
|
|
2126 let s = strpart(str, byteidx(str, 3))
|
|
|
2127 echo strpart(s, 0, byteidx(s, 1))
|
|
|
2128 < If there are less than {nr} characters -1 is returned.
|
|
|
2129 If there are exactly {nr} characters the length of the string
|
|
|
2130 is returned.
|
|
|
2131
|
|
102
|
2132 call({func}, {arglist} [, {dict}]) *call()* *E699*
|
|
685
|
2133 Call function {func} with the items in |List| {arglist} as
|
|
79
|
2134 arguments.
|
|
685
|
2135 {func} can either be a |Funcref| or the name of a function.
|
|
79
|
2136 a:firstline and a:lastline are set to the cursor line.
|
|
|
2137 Returns the return value of the called function.
|
|
102
|
2138 {dict} is for functions with the "dict" attribute. It will be
|
|
|
2139 used to set the local variable "self". |Dictionary-function|
|
|
79
|
2140
|
|
1621
|
2141 ceil({expr}) *ceil()*
|
|
|
2142 Return the smallest integral value greater than or equal to
|
|
|
2143 {expr} as a |Float| (round up).
|
|
|
2144 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
2145 Examples: >
|
|
|
2146 echo ceil(1.456)
|
|
|
2147 < 2.0 >
|
|
|
2148 echo ceil(-5.456)
|
|
|
2149 < -5.0 >
|
|
|
2150 echo ceil(4.0)
|
|
|
2151 < 4.0
|
|
|
2152 {only available when compiled with the |+float| feature}
|
|
|
2153
|
|
777
|
2154 changenr() *changenr()*
|
|
|
2155 Return the number of the most recent change. This is the same
|
|
|
2156 number as what is displayed with |:undolist| and can be used
|
|
|
2157 with the |:undo| command.
|
|
|
2158 When a change was made it is the number of that change. After
|
|
|
2159 redo it is the number of the redone change. After undo it is
|
|
|
2160 one less than the number of the undone change.
|
|
|
2161
|
|
7
|
2162 char2nr({expr}) *char2nr()*
|
|
|
2163 Return number value of the first char in {expr}. Examples: >
|
|
|
2164 char2nr(" ") returns 32
|
|
|
2165 char2nr("ABC") returns 65
|
|
|
2166 < The current 'encoding' is used. Example for "utf-8": >
|
|
1156
|
2167 char2nr("á") returns 225
|
|
|
2168 char2nr("á"[0]) returns 195
|
|
1621
|
2169 < |nr2char()| does the opposite.
|
|
7
|
2170
|
|
|
2171 cindent({lnum}) *cindent()*
|
|
|
2172 Get the amount of indent for line {lnum} according the C
|
|
|
2173 indenting rules, as with 'cindent'.
|
|
|
2174 The indent is counted in spaces, the value of 'tabstop' is
|
|
|
2175 relevant. {lnum} is used just like in |getline()|.
|
|
|
2176 When {lnum} is invalid or Vim was not compiled the |+cindent|
|
|
|
2177 feature, -1 is returned.
|
|
548
|
2178 See |C-indenting|.
|
|
7
|
2179
|
|
1326
|
2180 clearmatches() *clearmatches()*
|
|
|
2181 Clears all matches previously defined by |matchadd()| and the
|
|
|
2182 |:match| commands.
|
|
|
2183
|
|
7
|
2184 *col()*
|
|
24
|
2185 col({expr}) The result is a Number, which is the byte index of the column
|
|
7
|
2186 position given with {expr}. The accepted positions are:
|
|
|
2187 . the cursor position
|
|
|
2188 $ the end of the cursor line (the result is the
|
|
|
2189 number of characters in the cursor line plus one)
|
|
|
2190 'x position of mark x (if the mark is not set, 0 is
|
|
|
2191 returned)
|
|
1317
|
2192 Additionally {expr} can be [lnum, col]: a |List| with the line
|
|
|
2193 and column number. Most useful when the column is "$", to get
|
|
1621
|
2194 the last column of a specific line. When "lnum" or "col" is
|
|
1317
|
2195 out of range then col() returns zero.
|
|
1156
|
2196 To get the line number use |line()|. To get both use
|
|
703
|
2197 |getpos()|.
|
|
7
|
2198 For the screen column position use |virtcol()|.
|
|
|
2199 Note that only marks in the current file can be used.
|
|
|
2200 Examples: >
|
|
|
2201 col(".") column of cursor
|
|
|
2202 col("$") length of cursor line plus one
|
|
|
2203 col("'t") column of mark t
|
|
|
2204 col("'" . markname) column of mark markname
|
|
1621
|
2205 < The first column is 1. 0 is returned for an error.
|
|
1156
|
2206 For an uppercase mark the column may actually be in another
|
|
|
2207 buffer.
|
|
7
|
2208 For the cursor position, when 'virtualedit' is active, the
|
|
|
2209 column is one higher if the cursor is after the end of the
|
|
|
2210 line. This can be used to obtain the column in Insert mode: >
|
|
|
2211 :imap <F2> <C-O>:let save_ve = &ve<CR>
|
|
|
2212 \<C-O>:set ve=all<CR>
|
|
|
2213 \<C-O>:echo col(".") . "\n" <Bar>
|
|
|
2214 \let &ve = save_ve<CR>
|
|
|
2215 <
|
|
464
|
2216
|
|
724
|
2217 complete({startcol}, {matches}) *complete()* *E785*
|
|
|
2218 Set the matches for Insert mode completion.
|
|
|
2219 Can only be used in Insert mode. You need to use a mapping
|
|
1156
|
2220 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or
|
|
|
2221 with an expression mapping.
|
|
724
|
2222 {startcol} is the byte offset in the line where the completed
|
|
|
2223 text start. The text up to the cursor is the original text
|
|
|
2224 that will be replaced by the matches. Use col('.') for an
|
|
|
2225 empty string. "col('.') - 1" will replace one character by a
|
|
|
2226 match.
|
|
|
2227 {matches} must be a |List|. Each |List| item is one match.
|
|
|
2228 See |complete-items| for the kind of items that are possible.
|
|
|
2229 Note that the after calling this function you need to avoid
|
|
|
2230 inserting anything that would completion to stop.
|
|
|
2231 The match can be selected with CTRL-N and CTRL-P as usual with
|
|
|
2232 Insert mode completion. The popup menu will appear if
|
|
|
2233 specified, see |ins-completion-menu|.
|
|
|
2234 Example: >
|
|
1156
|
2235 inoremap <F5> <C-R>=ListMonths()<CR>
|
|
724
|
2236
|
|
|
2237 func! ListMonths()
|
|
|
2238 call complete(col('.'), ['January', 'February', 'March',
|
|
|
2239 \ 'April', 'May', 'June', 'July', 'August', 'September',
|
|
|
2240 \ 'October', 'November', 'December'])
|
|
|
2241 return ''
|
|
|
2242 endfunc
|
|
|
2243 < This isn't very useful, but it shows how it works. Note that
|
|
|
2244 an empty string is returned to avoid a zero being inserted.
|
|
|
2245
|
|
464
|
2246 complete_add({expr}) *complete_add()*
|
|
|
2247 Add {expr} to the list of matches. Only to be used by the
|
|
|
2248 function specified with the 'completefunc' option.
|
|
|
2249 Returns 0 for failure (empty string or out of memory),
|
|
|
2250 1 when the match was added, 2 when the match was already in
|
|
|
2251 the list.
|
|
1621
|
2252 See |complete-functions| for an explanation of {expr}. It is
|
|
786
|
2253 the same as one item in the list that 'omnifunc' would return.
|
|
464
|
2254
|
|
|
2255 complete_check() *complete_check()*
|
|
|
2256 Check for a key typed while looking for completion matches.
|
|
|
2257 This is to be used when looking for matches takes some time.
|
|
|
2258 Returns non-zero when searching for matches is to be aborted,
|
|
|
2259 zero otherwise.
|
|
|
2260 Only to be used by the function specified with the
|
|
|
2261 'completefunc' option.
|
|
|
2262
|
|
7
|
2263 *confirm()*
|
|
|
2264 confirm({msg} [, {choices} [, {default} [, {type}]]])
|
|
|
2265 Confirm() offers the user a dialog, from which a choice can be
|
|
|
2266 made. It returns the number of the choice. For the first
|
|
|
2267 choice this is 1.
|
|
|
2268 Note: confirm() is only supported when compiled with dialog
|
|
|
2269 support, see |+dialog_con| and |+dialog_gui|.
|
|
|
2270 {msg} is displayed in a |dialog| with {choices} as the
|
|
|
2271 alternatives. When {choices} is missing or empty, "&OK" is
|
|
|
2272 used (and translated).
|
|
|
2273 {msg} is a String, use '\n' to include a newline. Only on
|
|
|
2274 some systems the string is wrapped when it doesn't fit.
|
|
|
2275 {choices} is a String, with the individual choices separated
|
|
|
2276 by '\n', e.g. >
|
|
|
2277 confirm("Save changes?", "&Yes\n&No\n&Cancel")
|
|
|
2278 < The letter after the '&' is the shortcut key for that choice.
|
|
|
2279 Thus you can type 'c' to select "Cancel". The shortcut does
|
|
|
2280 not need to be the first letter: >
|
|
|
2281 confirm("file has been modified", "&Save\nSave &All")
|
|
|
2282 < For the console, the first letter of each choice is used as
|
|
|
2283 the default shortcut key.
|
|
|
2284 The optional {default} argument is the number of the choice
|
|
|
2285 that is made if the user hits <CR>. Use 1 to make the first
|
|
|
2286 choice the default one. Use 0 to not set a default. If
|
|
|
2287 {default} is omitted, 1 is used.
|
|
1621
|
2288 The optional {type} argument gives the type of dialog. This
|
|
7
|
2289 is only used for the icon of the Win32 GUI. It can be one of
|
|
|
2290 these values: "Error", "Question", "Info", "Warning" or
|
|
|
2291 "Generic". Only the first character is relevant. When {type}
|
|
|
2292 is omitted, "Generic" is used.
|
|
|
2293 If the user aborts the dialog by pressing <Esc>, CTRL-C,
|
|
|
2294 or another valid interrupt key, confirm() returns 0.
|
|
|
2295
|
|
|
2296 An example: >
|
|
|
2297 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
|
|
|
2298 :if choice == 0
|
|
|
2299 : echo "make up your mind!"
|
|
|
2300 :elseif choice == 3
|
|
|
2301 : echo "tasteful"
|
|
|
2302 :else
|
|
|
2303 : echo "I prefer bananas myself."
|
|
|
2304 :endif
|
|
|
2305 < In a GUI dialog, buttons are used. The layout of the buttons
|
|
|
2306 depends on the 'v' flag in 'guioptions'. If it is included,
|
|
1621
|
2307 the buttons are always put vertically. Otherwise, confirm()
|
|
7
|
2308 tries to put the buttons in one horizontal line. If they
|
|
|
2309 don't fit, a vertical layout is used anyway. For some systems
|
|
|
2310 the horizontal layout is always used.
|
|
|
2311
|
|
55
|
2312 *copy()*
|
|
1621
|
2313 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
|
|
55
|
2314 different from using {expr} directly.
|
|
685
|
2315 When {expr} is a |List| a shallow copy is created. This means
|
|
|
2316 that the original |List| can be changed without changing the
|
|
1621
|
2317 copy, and vice versa. But the items are identical, thus
|
|
|
2318 changing an item changes the contents of both |Lists|. Also
|
|
685
|
2319 see |deepcopy()|.
|
|
55
|
2320
|
|
1621
|
2321 cos({expr}) *cos()*
|
|
|
2322 Return the cosine of {expr}, measured in radians, as a |Float|.
|
|
|
2323 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
2324 Examples: >
|
|
|
2325 :echo cos(100)
|
|
|
2326 < 0.862319 >
|
|
|
2327 :echo cos(-4.01)
|
|
|
2328 < -0.646043
|
|
|
2329 {only available when compiled with the |+float| feature}
|
|
|
2330
|
|
|
2331
|
|
102
|
2332 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
|
|
79
|
2333 Return the number of times an item with value {expr} appears
|
|
685
|
2334 in |List| or |Dictionary| {comp}.
|
|
102
|
2335 If {start} is given then start with the item with this index.
|
|
685
|
2336 {start} can only be used with a |List|.
|
|
79
|
2337 When {ic} is given and it's non-zero then case is ignored.
|
|
|
2338
|
|
|
2339
|
|
7
|
2340 *cscope_connection()*
|
|
|
2341 cscope_connection([{num} , {dbpath} [, {prepend}]])
|
|
|
2342 Checks for the existence of a |cscope| connection. If no
|
|
|
2343 parameters are specified, then the function returns:
|
|
|
2344 0, if cscope was not available (not compiled in), or
|
|
|
2345 if there are no cscope connections;
|
|
|
2346 1, if there is at least one cscope connection.
|
|
|
2347
|
|
|
2348 If parameters are specified, then the value of {num}
|
|
|
2349 determines how existence of a cscope connection is checked:
|
|
|
2350
|
|
|
2351 {num} Description of existence check
|
|
|
2352 ----- ------------------------------
|
|
|
2353 0 Same as no parameters (e.g., "cscope_connection()").
|
|
|
2354 1 Ignore {prepend}, and use partial string matches for
|
|
|
2355 {dbpath}.
|
|
|
2356 2 Ignore {prepend}, and use exact string matches for
|
|
|
2357 {dbpath}.
|
|
|
2358 3 Use {prepend}, use partial string matches for both
|
|
|
2359 {dbpath} and {prepend}.
|
|
|
2360 4 Use {prepend}, use exact string matches for both
|
|
|
2361 {dbpath} and {prepend}.
|
|
|
2362
|
|
|
2363 Note: All string comparisons are case sensitive!
|
|
|
2364
|
|
|
2365 Examples. Suppose we had the following (from ":cs show"): >
|
|
|
2366
|
|
|
2367 # pid database name prepend path
|
|
|
2368 0 27664 cscope.out /usr/local
|
|
|
2369 <
|
|
|
2370 Invocation Return Val ~
|
|
|
2371 ---------- ---------- >
|
|
|
2372 cscope_connection() 1
|
|
|
2373 cscope_connection(1, "out") 1
|
|
|
2374 cscope_connection(2, "out") 0
|
|
|
2375 cscope_connection(3, "out") 0
|
|
|
2376 cscope_connection(3, "out", "local") 1
|
|
|
2377 cscope_connection(4, "out") 0
|
|
|
2378 cscope_connection(4, "out", "local") 0
|
|
|
2379 cscope_connection(4, "cscope.out", "/usr/local") 1
|
|
|
2380 <
|
|
703
|
2381 cursor({lnum}, {col} [, {off}]) *cursor()*
|
|
|
2382 cursor({list})
|
|
1156
|
2383 Positions the cursor at the column (byte count) {col} in the
|
|
|
2384 line {lnum}. The first column is one.
|
|
703
|
2385 When there is one argument {list} this is used as a |List|
|
|
707
|
2386 with two or three items {lnum}, {col} and {off}. This is like
|
|
|
2387 the return value of |getpos()|, but without the first item.
|
|
7
|
2388 Does not change the jumplist.
|
|
|
2389 If {lnum} is greater than the number of lines in the buffer,
|
|
|
2390 the cursor will be positioned at the last line in the buffer.
|
|
|
2391 If {lnum} is zero, the cursor will stay in the current line.
|
|
493
|
2392 If {col} is greater than the number of bytes in the line,
|
|
7
|
2393 the cursor will be positioned at the last character in the
|
|
|
2394 line.
|
|
|
2395 If {col} is zero, the cursor will stay in the current column.
|
|
703
|
2396 When 'virtualedit' is used {off} specifies the offset in
|
|
|
2397 screen columns from the start of the character. E.g., a
|
|
1266
|
2398 position within a <Tab> or after the last character.
|
|
7
|
2399
|
|
55
|
2400
|
|
164
|
2401 deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
|
|
1621
|
2402 Make a copy of {expr}. For Numbers and Strings this isn't
|
|
55
|
2403 different from using {expr} directly.
|
|
685
|
2404 When {expr} is a |List| a full copy is created. This means
|
|
|
2405 that the original |List| can be changed without changing the
|
|
1621
|
2406 copy, and vice versa. When an item is a |List|, a copy for it
|
|
55
|
2407 is made, recursively. Thus changing an item in the copy does
|
|
685
|
2408 not change the contents of the original |List|.
|
|
|
2409 When {noref} is omitted or zero a contained |List| or
|
|
|
2410 |Dictionary| is only copied once. All references point to
|
|
|
2411 this single copy. With {noref} set to 1 every occurrence of a
|
|
|
2412 |List| or |Dictionary| results in a new copy. This also means
|
|
|
2413 that a cyclic reference causes deepcopy() to fail.
|
|
114
|
2414 *E724*
|
|
|
2415 Nesting is possible up to 100 levels. When there is an item
|
|
164
|
2416 that refers back to a higher level making a deep copy with
|
|
|
2417 {noref} set to 1 will fail.
|
|
55
|
2418 Also see |copy()|.
|
|
|
2419
|
|
|
2420 delete({fname}) *delete()*
|
|
|
2421 Deletes the file by the name {fname}. The result is a Number,
|
|
7
|
2422 which is 0 if the file was deleted successfully, and non-zero
|
|
|
2423 when the deletion failed.
|
|
685
|
2424 Use |remove()| to delete an item from a |List|.
|
|
7
|
2425
|
|
|
2426 *did_filetype()*
|
|
|
2427 did_filetype() Returns non-zero when autocommands are being executed and the
|
|
|
2428 FileType event has been triggered at least once. Can be used
|
|
|
2429 to avoid triggering the FileType event again in the scripts
|
|
|
2430 that detect the file type. |FileType|
|
|
|
2431 When editing another file, the counter is reset, thus this
|
|
|
2432 really checks if the FileType event has been triggered for the
|
|
|
2433 current buffer. This allows an autocommand that starts
|
|
|
2434 editing another buffer to set 'filetype' and load a syntax
|
|
|
2435 file.
|
|
|
2436
|
|
32
|
2437 diff_filler({lnum}) *diff_filler()*
|
|
|
2438 Returns the number of filler lines above line {lnum}.
|
|
|
2439 These are the lines that were inserted at this point in
|
|
|
2440 another diff'ed window. These filler lines are shown in the
|
|
|
2441 display but don't exist in the buffer.
|
|
|
2442 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
2443 line, "'m" mark m, etc.
|
|
|
2444 Returns 0 if the current window is not in diff mode.
|
|
|
2445
|
|
|
2446 diff_hlID({lnum}, {col}) *diff_hlID()*
|
|
|
2447 Returns the highlight ID for diff mode at line {lnum} column
|
|
|
2448 {col} (byte index). When the current line does not have a
|
|
|
2449 diff change zero is returned.
|
|
|
2450 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
2451 line, "'m" mark m, etc.
|
|
|
2452 {col} is 1 for the leftmost column, {lnum} is 1 for the first
|
|
|
2453 line.
|
|
|
2454 The highlight ID can be used with |synIDattr()| to obtain
|
|
|
2455 syntax information about the highlighting.
|
|
|
2456
|
|
85
|
2457 empty({expr}) *empty()*
|
|
|
2458 Return the Number 1 if {expr} is empty, zero otherwise.
|
|
685
|
2459 A |List| or |Dictionary| is empty when it does not have any
|
|
1621
|
2460 items. A Number is empty when its value is zero.
|
|
685
|
2461 For a long |List| this is much faster then comparing the
|
|
|
2462 length with zero.
|
|
85
|
2463
|
|
7
|
2464 escape({string}, {chars}) *escape()*
|
|
|
2465 Escape the characters in {chars} that occur in {string} with a
|
|
|
2466 backslash. Example: >
|
|
|
2467 :echo escape('c:\program files\vim', ' \')
|
|
|
2468 < results in: >
|
|
|
2469 c:\\program\ files\\vim
|
|
1621
|
2470 < Also see |shellescape()|.
|
|
|
2471
|
|
|
2472 *eval()*
|
|
95
|
2473 eval({string}) Evaluate {string} and return the result. Especially useful to
|
|
|
2474 turn the result of |string()| back into the original value.
|
|
1621
|
2475 This works for Numbers, Floats, Strings and composites of
|
|
|
2476 them. Also works for |Funcref|s that refer to existing
|
|
|
2477 functions.
|
|
95
|
2478
|
|
7
|
2479 eventhandler() *eventhandler()*
|
|
|
2480 Returns 1 when inside an event handler. That is that Vim got
|
|
|
2481 interrupted while waiting for the user to type a character,
|
|
|
2482 e.g., when dropping a file on Vim. This means interactive
|
|
|
2483 commands cannot be used. Otherwise zero is returned.
|
|
|
2484
|
|
|
2485 executable({expr}) *executable()*
|
|
|
2486 This function checks if an executable with the name {expr}
|
|
|
2487 exists. {expr} must be the name of the program without any
|
|
10
|
2488 arguments.
|
|
|
2489 executable() uses the value of $PATH and/or the normal
|
|
|
2490 searchpath for programs. *PATHEXT*
|
|
|
2491 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
|
|
|
2492 optionally be included. Then the extensions in $PATHEXT are
|
|
1621
|
2493 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
|
|
|
2494 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
|
|
10
|
2495 used. A dot by itself can be used in $PATHEXT to try using
|
|
1621
|
2496 the name without an extension. When 'shell' looks like a
|
|
10
|
2497 Unix shell, then the name is also tried without adding an
|
|
|
2498 extension.
|
|
|
2499 On MS-DOS and MS-Windows it only checks if the file exists and
|
|
|
2500 is not a directory, not if it's really executable.
|
|
819
|
2501 On MS-Windows an executable in the same directory as Vim is
|
|
|
2502 always found. Since this directory is added to $PATH it
|
|
|
2503 should also work to execute it |win32-PATH|.
|
|
7
|
2504 The result is a Number:
|
|
|
2505 1 exists
|
|
|
2506 0 does not exist
|
|
|
2507 -1 not implemented on this system
|
|
|
2508
|
|
|
2509 *exists()*
|
|
|
2510 exists({expr}) The result is a Number, which is non-zero if {expr} is
|
|
|
2511 defined, zero otherwise. The {expr} argument is a string,
|
|
|
2512 which contains one of these:
|
|
|
2513 &option-name Vim option (only checks if it exists,
|
|
|
2514 not if it really works)
|
|
|
2515 +option-name Vim option that works.
|
|
|
2516 $ENVNAME environment variable (could also be
|
|
|
2517 done by comparing with an empty
|
|
|
2518 string)
|
|
|
2519 *funcname built-in function (see |functions|)
|
|
|
2520 or user defined function (see
|
|
|
2521 |user-functions|).
|
|
|
2522 varname internal variable (see
|
|
1621
|
2523 |internal-variables|). Also works
|
|
685
|
2524 for |curly-braces-names|, |Dictionary|
|
|
|
2525 entries, |List| items, etc. Beware
|
|
|
2526 that this may cause functions to be
|
|
158
|
2527 invoked cause an error message for an
|
|
|
2528 invalid expression.
|
|
7
|
2529 :cmdname Ex command: built-in command, user
|
|
|
2530 command or command modifier |:command|.
|
|
|
2531 Returns:
|
|
|
2532 1 for match with start of a command
|
|
|
2533 2 full match with a command
|
|
|
2534 3 matches several user commands
|
|
|
2535 To check for a supported command
|
|
|
2536 always check the return value to be 2.
|
|
864
|
2537 :2match The |:2match| command.
|
|
|
2538 :3match The |:3match| command.
|
|
7
|
2539 #event autocommand defined for this event
|
|
|
2540 #event#pattern autocommand defined for this event and
|
|
|
2541 pattern (the pattern is taken
|
|
|
2542 literally and compared to the
|
|
|
2543 autocommand patterns character by
|
|
|
2544 character)
|
|
613
|
2545 #group autocommand group exists
|
|
|
2546 #group#event autocommand defined for this group and
|
|
|
2547 event.
|
|
|
2548 #group#event#pattern
|
|
856
|
2549 autocommand defined for this group,
|
|
613
|
2550 event and pattern.
|
|
615
|
2551 ##event autocommand for this event is
|
|
|
2552 supported.
|
|
7
|
2553 For checking for a supported feature use |has()|.
|
|
|
2554
|
|
|
2555 Examples: >
|
|
|
2556 exists("&shortname")
|
|
|
2557 exists("$HOSTNAME")
|
|
|
2558 exists("*strftime")
|
|
|
2559 exists("*s:MyFunc")
|
|
|
2560 exists("bufcount")
|
|
|
2561 exists(":Make")
|
|
613
|
2562 exists("#CursorHold")
|
|
7
|
2563 exists("#BufReadPre#*.gz")
|
|
613
|
2564 exists("#filetypeindent")
|
|
|
2565 exists("#filetypeindent#FileType")
|
|
|
2566 exists("#filetypeindent#FileType#*")
|
|
615
|
2567 exists("##ColorScheme")
|
|
7
|
2568 < There must be no space between the symbol (&/$/*/#) and the
|
|
|
2569 name.
|
|
867
|
2570 There must be no extra characters after the name, although in
|
|
|
2571 a few cases this is ignored. That may become more strict in
|
|
|
2572 the future, thus don't count on it!
|
|
|
2573 Working example: >
|
|
|
2574 exists(":make")
|
|
|
2575 < NOT working example: >
|
|
|
2576 exists(":make install")
|
|
859
|
2577
|
|
|
2578 < Note that the argument must be a string, not the name of the
|
|
|
2579 variable itself. For example: >
|
|
7
|
2580 exists(bufcount)
|
|
|
2581 < This doesn't check for existence of the "bufcount" variable,
|
|
853
|
2582 but gets the value of "bufcount", and checks if that exists.
|
|
7
|
2583
|
|
|
2584 expand({expr} [, {flag}]) *expand()*
|
|
|
2585 Expand wildcards and the following special keywords in {expr}.
|
|
|
2586 The result is a String.
|
|
|
2587
|
|
|
2588 When there are several matches, they are separated by <NL>
|
|
|
2589 characters. [Note: in version 5.0 a space was used, which
|
|
|
2590 caused problems when a file name contains a space]
|
|
|
2591
|
|
1621
|
2592 If the expansion fails, the result is an empty string. A name
|
|
7
|
2593 for a non-existing file is not included.
|
|
|
2594
|
|
|
2595 When {expr} starts with '%', '#' or '<', the expansion is done
|
|
|
2596 like for the |cmdline-special| variables with their associated
|
|
|
2597 modifiers. Here is a short overview:
|
|
|
2598
|
|
|
2599 % current file name
|
|
|
2600 # alternate file name
|
|
|
2601 #n alternate file name n
|
|
|
2602 <cfile> file name under the cursor
|
|
|
2603 <afile> autocmd file name
|
|
|
2604 <abuf> autocmd buffer number (as a String!)
|
|
|
2605 <amatch> autocmd matched name
|
|
|
2606 <sfile> sourced script file name
|
|
|
2607 <cword> word under the cursor
|
|
|
2608 <cWORD> WORD under the cursor
|
|
|
2609 <client> the {clientid} of the last received
|
|
|
2610 message |server2client()|
|
|
|
2611 Modifiers:
|
|
|
2612 :p expand to full path
|
|
|
2613 :h head (last path component removed)
|
|
|
2614 :t tail (last path component only)
|
|
|
2615 :r root (one extension removed)
|
|
|
2616 :e extension only
|
|
|
2617
|
|
|
2618 Example: >
|
|
|
2619 :let &tags = expand("%:p:h") . "/tags"
|
|
|
2620 < Note that when expanding a string that starts with '%', '#' or
|
|
|
2621 '<', any following text is ignored. This does NOT work: >
|
|
|
2622 :let doesntwork = expand("%:h.bak")
|
|
|
2623 < Use this: >
|
|
|
2624 :let doeswork = expand("%:h") . ".bak"
|
|
|
2625 < Also note that expanding "<cfile>" and others only returns the
|
|
|
2626 referenced file name without further expansion. If "<cfile>"
|
|
|
2627 is "~/.cshrc", you need to do another expand() to have the
|
|
|
2628 "~/" expanded into the path of the home directory: >
|
|
|
2629 :echo expand(expand("<cfile>"))
|
|
|
2630 <
|
|
|
2631 There cannot be white space between the variables and the
|
|
|
2632 following modifier. The |fnamemodify()| function can be used
|
|
|
2633 to modify normal file names.
|
|
|
2634
|
|
|
2635 When using '%' or '#', and the current or alternate file name
|
|
|
2636 is not defined, an empty string is used. Using "%:p" in a
|
|
|
2637 buffer with no name, results in the current directory, with a
|
|
|
2638 '/' added.
|
|
|
2639
|
|
|
2640 When {expr} does not start with '%', '#' or '<', it is
|
|
|
2641 expanded like a file name is expanded on the command line.
|
|
|
2642 'suffixes' and 'wildignore' are used, unless the optional
|
|
|
2643 {flag} argument is given and it is non-zero. Names for
|
|
444
|
2644 non-existing files are included. The "**" item can be used to
|
|
|
2645 search in a directory tree. For example, to find all "README"
|
|
|
2646 files in the current directory and below: >
|
|
|
2647 :echo expand("**/README")
|
|
|
2648 <
|
|
7
|
2649 Expand() can also be used to expand variables and environment
|
|
|
2650 variables that are only known in a shell. But this can be
|
|
1621
|
2651 slow, because a shell must be started. See |expr-env-expand|.
|
|
7
|
2652 The expanded variable is still handled like a list of file
|
|
1621
|
2653 names. When an environment variable cannot be expanded, it is
|
|
7
|
2654 left unchanged. Thus ":echo expand('$FOOBAR')" results in
|
|
|
2655 "$FOOBAR".
|
|
|
2656
|
|
|
2657 See |glob()| for finding existing files. See |system()| for
|
|
|
2658 getting the raw output of an external command.
|
|
|
2659
|
|
102
|
2660 extend({expr1}, {expr2} [, {expr3}]) *extend()*
|
|
692
|
2661 {expr1} and {expr2} must be both |Lists| or both
|
|
|
2662 |Dictionaries|.
|
|
|
2663
|
|
|
2664 If they are |Lists|: Append {expr2} to {expr1}.
|
|
102
|
2665 If {expr3} is given insert the items of {expr2} before item
|
|
|
2666 {expr3} in {expr1}. When {expr3} is zero insert before the
|
|
|
2667 first item. When {expr3} is equal to len({expr1}) then
|
|
|
2668 {expr2} is appended.
|
|
79
|
2669 Examples: >
|
|
|
2670 :echo sort(extend(mylist, [7, 5]))
|
|
|
2671 :call extend(mylist, [2, 3], 1)
|
|
1621
|
2672 < Use |add()| to concatenate one item to a list. To concatenate
|
|
82
|
2673 two lists into a new list use the + operator: >
|
|
79
|
2674 :let newlist = [1, 2, 3] + [4, 5]
|
|
102
|
2675 <
|
|
692
|
2676 If they are |Dictionaries|:
|
|
102
|
2677 Add all entries from {expr2} to {expr1}.
|
|
|
2678 If a key exists in both {expr1} and {expr2} then {expr3} is
|
|
|
2679 used to decide what to do:
|
|
|
2680 {expr3} = "keep": keep the value of {expr1}
|
|
|
2681 {expr3} = "force": use the value of {expr2}
|
|
856
|
2682 {expr3} = "error": give an error message *E737*
|
|
102
|
2683 When {expr3} is omitted then "force" is assumed.
|
|
|
2684
|
|
|
2685 {expr1} is changed when {expr2} is not empty. If necessary
|
|
|
2686 make a copy of {expr1} first.
|
|
|
2687 {expr2} remains unchanged.
|
|
|
2688 Returns {expr1}.
|
|
|
2689
|
|
79
|
2690
|
|
842
|
2691 feedkeys({string} [, {mode}]) *feedkeys()*
|
|
|
2692 Characters in {string} are queued for processing as if they
|
|
1621
|
2693 come from a mapping or were typed by the user. They are added
|
|
1156
|
2694 to the end of the typeahead buffer, thus if a mapping is still
|
|
842
|
2695 being executed these characters come after them.
|
|
|
2696 The function does not wait for processing of keys contained in
|
|
|
2697 {string}.
|
|
|
2698 To include special keys into {string}, use double-quotes
|
|
|
2699 and "\..." notation |expr-quote|. For example,
|
|
1215
|
2700 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
|
|
842
|
2701 feedkeys('\<CR>') pushes 5 characters.
|
|
|
2702 If {mode} is absent, keys are remapped.
|
|
|
2703 {mode} is a String, which can contain these character flags:
|
|
843
|
2704 'm' Remap keys. This is default.
|
|
|
2705 'n' Do not remap keys.
|
|
|
2706 't' Handle keys as if typed; otherwise they are handled as
|
|
|
2707 if coming from a mapping. This matters for undo,
|
|
|
2708 opening folds, etc.
|
|
842
|
2709 Return value is always 0.
|
|
|
2710
|
|
7
|
2711 filereadable({file}) *filereadable()*
|
|
|
2712 The result is a Number, which is TRUE when a file with the
|
|
|
2713 name {file} exists, and can be read. If {file} doesn't exist,
|
|
|
2714 or is a directory, the result is FALSE. {file} is any
|
|
|
2715 expression, which is used as a String.
|
|
1156
|
2716 If you don't care about the file being readable you can use
|
|
|
2717 |glob()|.
|
|
7
|
2718 *file_readable()*
|
|
|
2719 Obsolete name: file_readable().
|
|
|
2720
|
|
95
|
2721
|
|
1156
|
2722 filewritable({file}) *filewritable()*
|
|
|
2723 The result is a Number, which is 1 when a file with the
|
|
|
2724 name {file} exists, and can be written. If {file} doesn't
|
|
1621
|
2725 exist, or is not writable, the result is 0. If {file} is a
|
|
1156
|
2726 directory, and we can write to it, the result is 2.
|
|
|
2727
|
|
|
2728
|
|
102
|
2729 filter({expr}, {string}) *filter()*
|
|
685
|
2730 {expr} must be a |List| or a |Dictionary|.
|
|
102
|
2731 For each item in {expr} evaluate {string} and when the result
|
|
685
|
2732 is zero remove the item from the |List| or |Dictionary|.
|
|
102
|
2733 Inside {string} |v:val| has the value of the current item.
|
|
685
|
2734 For a |Dictionary| |v:key| has the key of the current item.
|
|
102
|
2735 Examples: >
|
|
|
2736 :call filter(mylist, 'v:val !~ "OLD"')
|
|
|
2737 < Removes the items where "OLD" appears. >
|
|
|
2738 :call filter(mydict, 'v:key >= 8')
|
|
|
2739 < Removes the items with a key below 8. >
|
|
|
2740 :call filter(var, 0)
|
|
685
|
2741 < Removes all the items, thus clears the |List| or |Dictionary|.
|
|
99
|
2742
|
|
102
|
2743 Note that {string} is the result of expression and is then
|
|
|
2744 used as an expression again. Often it is good to use a
|
|
|
2745 |literal-string| to avoid having to double backslashes.
|
|
|
2746
|
|
685
|
2747 The operation is done in-place. If you want a |List| or
|
|
|
2748 |Dictionary| to remain unmodified make a copy first: >
|
|
650
|
2749 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
|
|
102
|
2750
|
|
685
|
2751 < Returns {expr}, the |List| or |Dictionary| that was filtered.
|
|
648
|
2752 When an error is encountered while evaluating {string} no
|
|
|
2753 further items in {expr} are processed.
|
|
95
|
2754
|
|
|
2755
|
|
19
|
2756 finddir({name}[, {path}[, {count}]]) *finddir()*
|
|
1095
|
2757 Find directory {name} in {path}. Supports both downwards and
|
|
|
2758 upwards recursive directory searches. See |file-searching|
|
|
|
2759 for the syntax of {path}.
|
|
|
2760 Returns the path of the first found match. When the found
|
|
|
2761 directory is below the current directory a relative path is
|
|
|
2762 returned. Otherwise a full path is returned.
|
|
19
|
2763 If {path} is omitted or empty then 'path' is used.
|
|
|
2764 If the optional {count} is given, find {count}'s occurrence of
|
|
794
|
2765 {name} in {path} instead of the first one.
|
|
809
|
2766 When {count} is negative return all the matches in a |List|.
|
|
19
|
2767 This is quite similar to the ex-command |:find|.
|
|
794
|
2768 {only available when compiled with the +file_in_path feature}
|
|
|
2769
|
|
|
2770 findfile({name}[, {path}[, {count}]]) *findfile()*
|
|
|
2771 Just like |finddir()|, but find a file instead of a directory.
|
|
|
2772 Uses 'suffixesadd'.
|
|
19
|
2773 Example: >
|
|
|
2774 :echo findfile("tags.vim", ".;")
|
|
1156
|
2775 < Searches from the directory of the current file upwards until
|
|
|
2776 it finds the file "tags.vim".
|
|
7
|
2777
|
|
1621
|
2778 float2nr({expr}) *float2nr()*
|
|
|
2779 Convert {expr} to a Number by omitting the part after the
|
|
|
2780 decimal point.
|
|
|
2781 {expr} must evaluate to a |Float| or a Number.
|
|
|
2782 When the value of {expr} is out of range for a |Number| the
|
|
|
2783 result is truncated to 0x7fffffff or -0x7fffffff. NaN results
|
|
|
2784 in -0x80000000.
|
|
|
2785 Examples: >
|
|
|
2786 echo float2nr(3.95)
|
|
|
2787 < 3 >
|
|
|
2788 echo float2nr(-23.45)
|
|
|
2789 < -23 >
|
|
|
2790 echo float2nr(1.0e100)
|
|
|
2791 < 2147483647 >
|
|
|
2792 echo float2nr(-1.0e150)
|
|
|
2793 < -2147483647 >
|
|
|
2794 echo float2nr(1.0e-100)
|
|
|
2795 < 0
|
|
|
2796 {only available when compiled with the |+float| feature}
|
|
|
2797
|
|
|
2798
|
|
|
2799 floor({expr}) *floor()*
|
|
|
2800 Return the largest integral value less than or equal to
|
|
|
2801 {expr} as a |Float| (round down).
|
|
|
2802 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
2803 Examples: >
|
|
|
2804 echo floor(1.856)
|
|
|
2805 < 1.0 >
|
|
|
2806 echo floor(-5.456)
|
|
|
2807 < -6.0 >
|
|
|
2808 echo floor(4.0)
|
|
|
2809 < 4.0
|
|
|
2810 {only available when compiled with the |+float| feature}
|
|
|
2811
|
|
1586
|
2812 fnameescape({string}) *fnameescape()*
|
|
1621
|
2813 Escape {string} for use as file name command argument. All
|
|
1586
|
2814 characters that have a special meaning, such as '%' and '|'
|
|
|
2815 are escaped with a backslash.
|
|
1621
|
2816 For most systems the characters escaped are
|
|
|
2817 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
|
|
|
2818 appears in a filename, it depends on the value of 'isfname'.
|
|
1586
|
2819 Example: >
|
|
|
2820 :let fname = 'some str%nge|name'
|
|
|
2821 :exe "edit " . fnameescape(fname)
|
|
|
2822 < results in executing: >
|
|
|
2823 edit some\ str\%nge\|name
|
|
|
2824
|
|
7
|
2825 fnamemodify({fname}, {mods}) *fnamemodify()*
|
|
|
2826 Modify file name {fname} according to {mods}. {mods} is a
|
|
|
2827 string of characters like it is used for file names on the
|
|
|
2828 command line. See |filename-modifiers|.
|
|
|
2829 Example: >
|
|
|
2830 :echo fnamemodify("main.c", ":p:h")
|
|
|
2831 < results in: >
|
|
|
2832 /home/mool/vim/vim/src
|
|
1621
|
2833 < Note: Environment variables don't work in {fname}, use
|
|
7
|
2834 |expand()| first then.
|
|
|
2835
|
|
|
2836 foldclosed({lnum}) *foldclosed()*
|
|
|
2837 The result is a Number. If the line {lnum} is in a closed
|
|
|
2838 fold, the result is the number of the first line in that fold.
|
|
|
2839 If the line {lnum} is not in a closed fold, -1 is returned.
|
|
|
2840
|
|
|
2841 foldclosedend({lnum}) *foldclosedend()*
|
|
|
2842 The result is a Number. If the line {lnum} is in a closed
|
|
|
2843 fold, the result is the number of the last line in that fold.
|
|
|
2844 If the line {lnum} is not in a closed fold, -1 is returned.
|
|
|
2845
|
|
|
2846 foldlevel({lnum}) *foldlevel()*
|
|
|
2847 The result is a Number, which is the foldlevel of line {lnum}
|
|
1621
|
2848 in the current buffer. For nested folds the deepest level is
|
|
7
|
2849 returned. If there is no fold at line {lnum}, zero is
|
|
|
2850 returned. It doesn't matter if the folds are open or closed.
|
|
|
2851 When used while updating folds (from 'foldexpr') -1 is
|
|
|
2852 returned for lines where folds are still to be updated and the
|
|
|
2853 foldlevel is unknown. As a special case the level of the
|
|
|
2854 previous line is usually available.
|
|
|
2855
|
|
|
2856 *foldtext()*
|
|
|
2857 foldtext() Returns a String, to be displayed for a closed fold. This is
|
|
|
2858 the default function used for the 'foldtext' option and should
|
|
|
2859 only be called from evaluating 'foldtext'. It uses the
|
|
|
2860 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
|
|
|
2861 The returned string looks like this: >
|
|
|
2862 +-- 45 lines: abcdef
|
|
1621
|
2863 < The number of dashes depends on the foldlevel. The "45" is
|
|
7
|
2864 the number of lines in the fold. "abcdef" is the text in the
|
|
|
2865 first non-blank line of the fold. Leading white space, "//"
|
|
|
2866 or "/*" and the text from the 'foldmarker' and 'commentstring'
|
|
|
2867 options is removed.
|
|
|
2868 {not available when compiled without the |+folding| feature}
|
|
|
2869
|
|
29
|
2870 foldtextresult({lnum}) *foldtextresult()*
|
|
|
2871 Returns the text that is displayed for the closed fold at line
|
|
|
2872 {lnum}. Evaluates 'foldtext' in the appropriate context.
|
|
|
2873 When there is no closed fold at {lnum} an empty string is
|
|
|
2874 returned.
|
|
|
2875 {lnum} is used like with |getline()|. Thus "." is the current
|
|
|
2876 line, "'m" mark m, etc.
|
|
|
2877 Useful when exporting folded text, e.g., to HTML.
|
|
|
2878 {not available when compiled without the |+folding| feature}
|
|
|
2879
|
|
7
|
2880 *foreground()*
|
|
1621
|
2881 foreground() Move the Vim window to the foreground. Useful when sent from
|
|
7
|
2882 a client to a Vim server. |remote_send()|
|
|
|
2883 On Win32 systems this might not work, the OS does not always
|
|
|
2884 allow a window to bring itself to the foreground. Use
|
|
|
2885 |remote_foreground()| instead.
|
|
|
2886 {only in the Win32, Athena, Motif and GTK GUI versions and the
|
|
|
2887 Win32 console version}
|
|
|
2888
|
|
82
|
2889
|
|
85
|
2890 function({name}) *function()* *E700*
|
|
685
|
2891 Return a |Funcref| variable that refers to function {name}.
|
|
55
|
2892 {name} can be a user defined function or an internal function.
|
|
|
2893
|
|
82
|
2894
|
|
1405
|
2895 garbagecollect([at_exit]) *garbagecollect()*
|
|
692
|
2896 Cleanup unused |Lists| and |Dictionaries| that have circular
|
|
370
|
2897 references. There is hardly ever a need to invoke this
|
|
|
2898 function, as it is automatically done when Vim runs out of
|
|
|
2899 memory or is waiting for the user to press a key after
|
|
|
2900 'updatetime'. Items without circular references are always
|
|
|
2901 freed when they become unused.
|
|
685
|
2902 This is useful if you have deleted a very big |List| and/or
|
|
|
2903 |Dictionary| with circular references in a script that runs
|
|
|
2904 for a long time.
|
|
1405
|
2905 When the optional "at_exit" argument is one, garbage
|
|
|
2906 collection will also be done when exiting Vim, if it wasn't
|
|
|
2907 done before. This is useful when checking for memory leaks.
|
|
370
|
2908
|
|
140
|
2909 get({list}, {idx} [, {default}]) *get()*
|
|
685
|
2910 Get item {idx} from |List| {list}. When this item is not
|
|
82
|
2911 available return {default}. Return zero when {default} is
|
|
|
2912 omitted.
|
|
102
|
2913 get({dict}, {key} [, {default}])
|
|
685
|
2914 Get item with key {key} from |Dictionary| {dict}. When this
|
|
102
|
2915 item is not available return {default}. Return zero when
|
|
|
2916 {default} is omitted.
|
|
|
2917
|
|
435
|
2918 *getbufline()*
|
|
|
2919 getbufline({expr}, {lnum} [, {end}])
|
|
685
|
2920 Return a |List| with the lines starting from {lnum} to {end}
|
|
|
2921 (inclusive) in the buffer {expr}. If {end} is omitted, a
|
|
|
2922 |List| with only the line {lnum} is returned.
|
|
435
|
2923
|
|
|
2924 For the use of {expr}, see |bufname()| above.
|
|
|
2925
|
|
448
|
2926 For {lnum} and {end} "$" can be used for the last line of the
|
|
|
2927 buffer. Otherwise a number must be used.
|
|
435
|
2928
|
|
|
2929 When {lnum} is smaller than 1 or bigger than the number of
|
|
685
|
2930 lines in the buffer, an empty |List| is returned.
|
|
435
|
2931
|
|
|
2932 When {end} is greater than the number of lines in the buffer,
|
|
|
2933 it is treated as {end} is set to the number of lines in the
|
|
685
|
2934 buffer. When {end} is before {lnum} an empty |List| is
|
|
435
|
2935 returned.
|
|
|
2936
|
|
448
|
2937 This function works only for loaded buffers. For unloaded and
|
|
685
|
2938 non-existing buffers, an empty |List| is returned.
|
|
435
|
2939
|
|
|
2940 Example: >
|
|
|
2941 :let lines = getbufline(bufnr("myfile"), 1, "$")
|
|
82
|
2942
|
|
|
2943 getbufvar({expr}, {varname}) *getbufvar()*
|
|
|
2944 The result is the value of option or local buffer variable
|
|
|
2945 {varname} in buffer {expr}. Note that the name without "b:"
|
|
|
2946 must be used.
|
|
216
|
2947 This also works for a global or buffer-local option, but it
|
|
|
2948 doesn't work for a global variable, window-local variable or
|
|
|
2949 window-local option.
|
|
82
|
2950 For the use of {expr}, see |bufname()| above.
|
|
|
2951 When the buffer or variable doesn't exist an empty string is
|
|
|
2952 returned, there is no error message.
|
|
|
2953 Examples: >
|
|
|
2954 :let bufmodified = getbufvar(1, "&mod")
|
|
|
2955 :echo "todo myvar = " . getbufvar("todo", "myvar")
|
|
|
2956 <
|
|
7
|
2957 getchar([expr]) *getchar()*
|
|
867
|
2958 Get a single character from the user or input stream.
|
|
7
|
2959 If [expr] is omitted, wait until a character is available.
|
|
|
2960 If [expr] is 0, only get a character when one is available.
|
|
867
|
2961 Return zero otherwise.
|
|
7
|
2962 If [expr] is 1, only check if a character is available, it is
|
|
867
|
2963 not consumed. Return zero if no character available.
|
|
|
2964
|
|
|
2965 Without {expr} and when {expr} is 0 a whole character or
|
|
|
2966 special key is returned. If it is an 8-bit character, the
|
|
|
2967 result is a number. Use nr2char() to convert it to a String.
|
|
|
2968 Otherwise a String is returned with the encoded character.
|
|
|
2969 For a special key it's a sequence of bytes starting with 0x80
|
|
872
|
2970 (decimal: 128). This is the same value as the string
|
|
|
2971 "\<Key>", e.g., "\<Left>". The returned value is also a
|
|
|
2972 String when a modifier (shift, control, alt) was used that is
|
|
|
2973 not included in the character.
|
|
867
|
2974
|
|
|
2975 When {expr} is 1 only the first byte is returned. For a
|
|
872
|
2976 one-byte character it is the character itself as a number.
|
|
|
2977 Use nr2char() to convert it to a String.
|
|
867
|
2978
|
|
1029
|
2979 When the user clicks a mouse button, the mouse event will be
|
|
|
2980 returned. The position can then be found in |v:mouse_col|,
|
|
|
2981 |v:mouse_lnum| and |v:mouse_win|. This example positions the
|
|
|
2982 mouse as it would normally happen: >
|
|
|
2983 let c = getchar()
|
|
1621
|
2984 if c == "\<LeftMouse>" && v:mouse_win > 0
|
|
1029
|
2985 exe v:mouse_win . "wincmd w"
|
|
|
2986 exe v:mouse_lnum
|
|
|
2987 exe "normal " . v:mouse_col . "|"
|
|
|
2988 endif
|
|
|
2989 <
|
|
7
|
2990 There is no prompt, you will somehow have to make clear to the
|
|
|
2991 user that a character has to be typed.
|
|
|
2992 There is no mapping for the character.
|
|
|
2993 Key codes are replaced, thus when the user presses the <Del>
|
|
|
2994 key you get the code for the <Del> key, not the raw character
|
|
|
2995 sequence. Examples: >
|
|
|
2996 getchar() == "\<Del>"
|
|
|
2997 getchar() == "\<S-Left>"
|
|
|
2998 < This example redefines "f" to ignore case: >
|
|
|
2999 :nmap f :call FindChar()<CR>
|
|
|
3000 :function FindChar()
|
|
|
3001 : let c = nr2char(getchar())
|
|
|
3002 : while col('.') < col('$') - 1
|
|
|
3003 : normal l
|
|
|
3004 : if getline('.')[col('.') - 1] ==? c
|
|
|
3005 : break
|
|
|
3006 : endif
|
|
|
3007 : endwhile
|
|
|
3008 :endfunction
|
|
|
3009
|
|
|
3010 getcharmod() *getcharmod()*
|
|
|
3011 The result is a Number which is the state of the modifiers for
|
|
|
3012 the last obtained character with getchar() or in another way.
|
|
|
3013 These values are added together:
|
|
|
3014 2 shift
|
|
|
3015 4 control
|
|
|
3016 8 alt (meta)
|
|
|
3017 16 mouse double click
|
|
|
3018 32 mouse triple click
|
|
|
3019 64 mouse quadruple click
|
|
|
3020 128 Macintosh only: command
|
|
|
3021 Only the modifiers that have not been included in the
|
|
1621
|
3022 character itself are obtained. Thus Shift-a results in "A"
|
|
7
|
3023 with no modifier.
|
|
|
3024
|
|
|
3025 getcmdline() *getcmdline()*
|
|
|
3026 Return the current command-line. Only works when the command
|
|
|
3027 line is being edited, thus requires use of |c_CTRL-\_e| or
|
|
|
3028 |c_CTRL-R_=|.
|
|
|
3029 Example: >
|
|
|
3030 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
|
|
531
|
3031 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
|
|
7
|
3032
|
|
95
|
3033 getcmdpos() *getcmdpos()*
|
|
7
|
3034 Return the position of the cursor in the command line as a
|
|
|
3035 byte count. The first column is 1.
|
|
|
3036 Only works when editing the command line, thus requires use of
|
|
|
3037 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
|
|
531
|
3038 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
|
|
|
3039
|
|
|
3040 getcmdtype() *getcmdtype()*
|
|
|
3041 Return the current command-line type. Possible return values
|
|
|
3042 are:
|
|
532
|
3043 : normal Ex command
|
|
|
3044 > debug mode command |debug-mode|
|
|
|
3045 / forward search command
|
|
|
3046 ? backward search command
|
|
|
3047 @ |input()| command
|
|
|
3048 - |:insert| or |:append| command
|
|
531
|
3049 Only works when editing the command line, thus requires use of
|
|
|
3050 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string
|
|
|
3051 otherwise.
|
|
|
3052 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
|
|
7
|
3053
|
|
|
3054 *getcwd()*
|
|
|
3055 getcwd() The result is a String, which is the name of the current
|
|
|
3056 working directory.
|
|
|
3057
|
|
|
3058 getfsize({fname}) *getfsize()*
|
|
|
3059 The result is a Number, which is the size in bytes of the
|
|
|
3060 given file {fname}.
|
|
|
3061 If {fname} is a directory, 0 is returned.
|
|
|
3062 If the file {fname} can't be found, -1 is returned.
|
|
1293
|
3063 If the size of {fname} is too big to fit in a Number then -2
|
|
|
3064 is returned.
|
|
7
|
3065
|
|
37
|
3066 getfontname([{name}]) *getfontname()*
|
|
|
3067 Without an argument returns the name of the normal font being
|
|
|
3068 used. Like what is used for the Normal highlight group
|
|
|
3069 |hl-Normal|.
|
|
|
3070 With an argument a check is done whether {name} is a valid
|
|
|
3071 font name. If not then an empty string is returned.
|
|
|
3072 Otherwise the actual font name is returned, or {name} if the
|
|
|
3073 GUI does not support obtaining the real name.
|
|
824
|
3074 Only works when the GUI is running, thus not in your vimrc or
|
|
819
|
3075 gvimrc file. Use the |GUIEnter| autocommand to use this
|
|
|
3076 function just after the GUI has started.
|
|
37
|
3077 Note that the GTK 2 GUI accepts any font name, thus checking
|
|
|
3078 for a valid name does not work.
|
|
|
3079
|
|
20
|
3080 getfperm({fname}) *getfperm()*
|
|
|
3081 The result is a String, which is the read, write, and execute
|
|
|
3082 permissions of the given file {fname}.
|
|
|
3083 If {fname} does not exist or its directory cannot be read, an
|
|
|
3084 empty string is returned.
|
|
|
3085 The result is of the form "rwxrwxrwx", where each group of
|
|
|
3086 "rwx" flags represent, in turn, the permissions of the owner
|
|
|
3087 of the file, the group the file belongs to, and other users.
|
|
|
3088 If a user does not have a given permission the flag for this
|
|
|
3089 is replaced with the string "-". Example: >
|
|
|
3090 :echo getfperm("/etc/passwd")
|
|
|
3091 < This will hopefully (from a security point of view) display
|
|
|
3092 the string "rw-r--r--" or even "rw-------".
|
|
205
|
3093
|
|
7
|
3094 getftime({fname}) *getftime()*
|
|
|
3095 The result is a Number, which is the last modification time of
|
|
|
3096 the given file {fname}. The value is measured as seconds
|
|
|
3097 since 1st Jan 1970, and may be passed to strftime(). See also
|
|
|
3098 |localtime()| and |strftime()|.
|
|
|
3099 If the file {fname} can't be found -1 is returned.
|
|
|
3100
|
|
20
|
3101 getftype({fname}) *getftype()*
|
|
|
3102 The result is a String, which is a description of the kind of
|
|
|
3103 file of the given file {fname}.
|
|
|
3104 If {fname} does not exist an empty string is returned.
|
|
|
3105 Here is a table over different kinds of files and their
|
|
|
3106 results:
|
|
|
3107 Normal file "file"
|
|
|
3108 Directory "dir"
|
|
|
3109 Symbolic link "link"
|
|
|
3110 Block device "bdev"
|
|
|
3111 Character device "cdev"
|
|
|
3112 Socket "socket"
|
|
|
3113 FIFO "fifo"
|
|
|
3114 All other "other"
|
|
|
3115 Example: >
|
|
|
3116 getftype("/home")
|
|
|
3117 < Note that a type such as "link" will only be returned on
|
|
|
3118 systems that support it. On some systems only "dir" and
|
|
|
3119 "file" are returned.
|
|
|
3120
|
|
7
|
3121 *getline()*
|
|
82
|
3122 getline({lnum} [, {end}])
|
|
|
3123 Without {end} the result is a String, which is line {lnum}
|
|
|
3124 from the current buffer. Example: >
|
|
7
|
3125 getline(1)
|
|
|
3126 < When {lnum} is a String that doesn't start with a
|
|
|
3127 digit, line() is called to translate the String into a Number.
|
|
|
3128 To get the line under the cursor: >
|
|
|
3129 getline(".")
|
|
|
3130 < When {lnum} is smaller than 1 or bigger than the number of
|
|
|
3131 lines in the buffer, an empty string is returned.
|
|
|
3132
|
|
685
|
3133 When {end} is given the result is a |List| where each item is
|
|
|
3134 a line from the current buffer in the range {lnum} to {end},
|
|
82
|
3135 including line {end}.
|
|
|
3136 {end} is used in the same way as {lnum}.
|
|
|
3137 Non-existing lines are silently omitted.
|
|
685
|
3138 When {end} is before {lnum} an empty |List| is returned.
|
|
82
|
3139 Example: >
|
|
|
3140 :let start = line('.')
|
|
|
3141 :let end = search("^$") - 1
|
|
|
3142 :let lines = getline(start, end)
|
|
|
3143
|
|
1156
|
3144 < To get lines from another buffer see |getbufline()|
|
|
|
3145
|
|
647
|
3146 getloclist({nr}) *getloclist()*
|
|
|
3147 Returns a list with all the entries in the location list for
|
|
|
3148 window {nr}. When {nr} is zero the current window is used.
|
|
|
3149 For a location list window, the displayed location list is
|
|
648
|
3150 returned. For an invalid window number {nr}, an empty list is
|
|
|
3151 returned. Otherwise, same as getqflist().
|
|
82
|
3152
|
|
1326
|
3153 getmatches() *getmatches()*
|
|
|
3154 Returns a |List| with all matches previously defined by
|
|
|
3155 |matchadd()| and the |:match| commands. |getmatches()| is
|
|
|
3156 useful in combination with |setmatches()|, as |setmatches()|
|
|
|
3157 can restore a list of matches saved by |getmatches()|.
|
|
|
3158 Example: >
|
|
|
3159 :echo getmatches()
|
|
|
3160 < [{'group': 'MyGroup1', 'pattern': 'TODO',
|
|
|
3161 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
|
|
|
3162 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
|
|
|
3163 :let m = getmatches()
|
|
|
3164 :call clearmatches()
|
|
|
3165 :echo getmatches()
|
|
|
3166 < [] >
|
|
|
3167 :call setmatches(m)
|
|
|
3168 :echo getmatches()
|
|
|
3169 < [{'group': 'MyGroup1', 'pattern': 'TODO',
|
|
|
3170 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
|
|
|
3171 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
|
|
|
3172 :unlet m
|
|
|
3173 <
|
|
|
3174
|
|
230
|
3175 getqflist() *getqflist()*
|
|
|
3176 Returns a list with all the current quickfix errors. Each
|
|
|
3177 list item is a dictionary with these entries:
|
|
|
3178 bufnr number of buffer that has the file name, use
|
|
|
3179 bufname() to get the name
|
|
|
3180 lnum line number in the buffer (first line is 1)
|
|
|
3181 col column number (first column is 1)
|
|
233
|
3182 vcol non-zero: "col" is visual column
|
|
|
3183 zero: "col" is byte index
|
|
230
|
3184 nr error number
|
|
1065
|
3185 pattern search pattern used to locate the error
|
|
230
|
3186 text description of the error
|
|
|
3187 type type of the error, 'E', '1', etc.
|
|
|
3188 valid non-zero: recognized error message
|
|
|
3189
|
|
515
|
3190 When there is no error list or it's empty an empty list is
|
|
1065
|
3191 returned. Quickfix list entries with non-existing buffer
|
|
|
3192 number are returned with "bufnr" set to zero.
|
|
515
|
3193
|
|
230
|
3194 Useful application: Find pattern matches in multiple files and
|
|
|
3195 do something with them: >
|
|
|
3196 :vimgrep /theword/jg *.c
|
|
|
3197 :for d in getqflist()
|
|
|
3198 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
|
|
|
3199 :endfor
|
|
|
3200
|
|
|
3201
|
|
282
|
3202 getreg([{regname} [, 1]]) *getreg()*
|
|
7
|
3203 The result is a String, which is the contents of register
|
|
236
|
3204 {regname}. Example: >
|
|
7
|
3205 :let cliptext = getreg('*')
|
|
|
3206 < getreg('=') returns the last evaluated value of the expression
|
|
236
|
3207 register. (For use in maps.)
|
|
282
|
3208 getreg('=', 1) returns the expression itself, so that it can
|
|
|
3209 be restored with |setreg()|. For other registers the extra
|
|
|
3210 argument is ignored, thus you can always give it.
|
|
7
|
3211 If {regname} is not specified, |v:register| is used.
|
|
|
3212
|
|
82
|
3213
|
|
7
|
3214 getregtype([{regname}]) *getregtype()*
|
|
|
3215 The result is a String, which is type of register {regname}.
|
|
|
3216 The value will be one of:
|
|
|
3217 "v" for |characterwise| text
|
|
|
3218 "V" for |linewise| text
|
|
|
3219 "<CTRL-V>{width}" for |blockwise-visual| text
|
|
|
3220 0 for an empty or unknown register
|
|
|
3221 <CTRL-V> is one character with value 0x16.
|
|
|
3222 If {regname} is not specified, |v:register| is used.
|
|
|
3223
|
|
831
|
3224 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()*
|
|
1156
|
3225 Get the value of window-local variable {varname} in window
|
|
|
3226 {winnr} in tab page {tabnr}.
|
|
|
3227 When {varname} starts with "&" get the value of a window-local
|
|
|
3228 option.
|
|
831
|
3229 Tabs are numbered starting with one. For the current tabpage
|
|
|
3230 use |getwinvar()|.
|
|
|
3231 When {winnr} is zero the current window is used.
|
|
|
3232 This also works for a global option, buffer-local option and
|
|
|
3233 window-local option, but it doesn't work for a global variable
|
|
|
3234 or buffer-local variable.
|
|
1156
|
3235 When {varname} is empty a dictionary with all window-local
|
|
|
3236 variables is returned.
|
|
|
3237 Note that {varname} must be the name without "w:".
|
|
831
|
3238 Examples: >
|
|
|
3239 :let list_is_on = gettabwinvar(1, 2, '&list')
|
|
|
3240 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
|
|
1266
|
3241 <
|
|
7
|
3242 *getwinposx()*
|
|
|
3243 getwinposx() The result is a Number, which is the X coordinate in pixels of
|
|
|
3244 the left hand side of the GUI Vim window. The result will be
|
|
|
3245 -1 if the information is not available.
|
|
|
3246
|
|
|
3247 *getwinposy()*
|
|
|
3248 getwinposy() The result is a Number, which is the Y coordinate in pixels of
|
|
1621
|
3249 the top of the GUI Vim window. The result will be -1 if the
|
|
7
|
3250 information is not available.
|
|
|
3251
|
|
831
|
3252 getwinvar({winnr}, {varname}) *getwinvar()*
|
|
|
3253 Like |gettabwinvar()| for the current tabpage.
|
|
7
|
3254 Examples: >
|
|
|
3255 :let list_is_on = getwinvar(2, '&list')
|
|
|
3256 :echo "myvar = " . getwinvar(1, 'myvar')
|
|
|
3257 <
|
|
|
3258 *glob()*
|
|
1156
|
3259 glob({expr}) Expand the file wildcards in {expr}. See |wildcards| for the
|
|
|
3260 use of special characters.
|
|
|
3261 The result is a String.
|
|
7
|
3262 When there are several matches, they are separated by <NL>
|
|
|
3263 characters.
|
|
1621
|
3264 The 'wildignore' option applies: Names matching one of the
|
|
|
3265 patterns in 'wildignore' will be skipped.
|
|
7
|
3266 If the expansion fails, the result is an empty string.
|
|
|
3267 A name for a non-existing file is not included.
|
|
|
3268
|
|
|
3269 For most systems backticks can be used to get files names from
|
|
|
3270 any external command. Example: >
|
|
|
3271 :let tagfiles = glob("`find . -name tags -print`")
|
|
|
3272 :let &tags = substitute(tagfiles, "\n", ",", "g")
|
|
|
3273 < The result of the program inside the backticks should be one
|
|
1621
|
3274 item per line. Spaces inside an item are allowed.
|
|
7
|
3275
|
|
|
3276 See |expand()| for expanding special Vim variables. See
|
|
|
3277 |system()| for getting the raw output of an external command.
|
|
|
3278
|
|
|
3279 globpath({path}, {expr}) *globpath()*
|
|
|
3280 Perform glob() on all directories in {path} and concatenate
|
|
|
3281 the results. Example: >
|
|
|
3282 :echo globpath(&rtp, "syntax/c.vim")
|
|
|
3283 < {path} is a comma-separated list of directory names. Each
|
|
|
3284 directory name is prepended to {expr} and expanded like with
|
|
|
3285 glob(). A path separator is inserted when needed.
|
|
|
3286 To add a comma inside a directory name escape it with a
|
|
|
3287 backslash. Note that on MS-Windows a directory may have a
|
|
|
3288 trailing backslash, remove it if you put a comma after it.
|
|
|
3289 If the expansion fails for one of the directories, there is no
|
|
|
3290 error message.
|
|
|
3291 The 'wildignore' option applies: Names matching one of the
|
|
|
3292 patterns in 'wildignore' will be skipped.
|
|
|
3293
|
|
444
|
3294 The "**" item can be used to search in a directory tree.
|
|
|
3295 For example, to find all "README.txt" files in the directories
|
|
|
3296 in 'runtimepath' and below: >
|
|
|
3297 :echo globpath(&rtp, "**/README.txt")
|
|
|
3298 <
|
|
7
|
3299 *has()*
|
|
|
3300 has({feature}) The result is a Number, which is 1 if the feature {feature} is
|
|
|
3301 supported, zero otherwise. The {feature} argument is a
|
|
|
3302 string. See |feature-list| below.
|
|
|
3303 Also see |exists()|.
|
|
|
3304
|
|
102
|
3305
|
|
|
3306 has_key({dict}, {key}) *has_key()*
|
|
685
|
3307 The result is a Number, which is 1 if |Dictionary| {dict} has
|
|
|
3308 an entry with key {key}. Zero otherwise.
|
|
102
|
3309
|
|
1104
|
3310 haslocaldir() *haslocaldir()*
|
|
|
3311 The result is a Number, which is 1 when the current
|
|
1621
|
3312 window has set a local path via |:lcd|, and 0 otherwise.
|
|
102
|
3313
|
|
782
|
3314 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
|
|
7
|
3315 The result is a Number, which is 1 if there is a mapping that
|
|
|
3316 contains {what} in somewhere in the rhs (what it is mapped to)
|
|
|
3317 and this mapping exists in one of the modes indicated by
|
|
|
3318 {mode}.
|
|
782
|
3319 When {abbr} is there and it is non-zero use abbreviations
|
|
786
|
3320 instead of mappings. Don't forget to specify Insert and/or
|
|
|
3321 Command-line mode.
|
|
7
|
3322 Both the global mappings and the mappings local to the current
|
|
|
3323 buffer are checked for a match.
|
|
|
3324 If no matching mapping is found 0 is returned.
|
|
|
3325 The following characters are recognized in {mode}:
|
|
|
3326 n Normal mode
|
|
|
3327 v Visual mode
|
|
|
3328 o Operator-pending mode
|
|
|
3329 i Insert mode
|
|
|
3330 l Language-Argument ("r", "f", "t", etc.)
|
|
|
3331 c Command-line mode
|
|
|
3332 When {mode} is omitted, "nvo" is used.
|
|
|
3333
|
|
|
3334 This function is useful to check if a mapping already exists
|
|
1621
|
3335 to a function in a Vim script. Example: >
|
|
7
|
3336 :if !hasmapto('\ABCdoit')
|
|
|
3337 : map <Leader>d \ABCdoit
|
|
|
3338 :endif
|
|
|
3339 < This installs the mapping to "\ABCdoit" only if there isn't
|
|
|
3340 already a mapping to "\ABCdoit".
|
|
|
3341
|
|
|
3342 histadd({history}, {item}) *histadd()*
|
|
|
3343 Add the String {item} to the history {history} which can be
|
|
|
3344 one of: *hist-names*
|
|
|
3345 "cmd" or ":" command line history
|
|
|
3346 "search" or "/" search pattern history
|
|
1621
|
3347 "expr" or "=" typed expression history
|
|
7
|
3348 "input" or "@" input line history
|
|
|
3349 If {item} does already exist in the history, it will be
|
|
|
3350 shifted to become the newest entry.
|
|
|
3351 The result is a Number: 1 if the operation was successful,
|
|
|
3352 otherwise 0 is returned.
|
|
|
3353
|
|
|
3354 Example: >
|
|
|
3355 :call histadd("input", strftime("%Y %b %d"))
|
|
|
3356 :let date=input("Enter date: ")
|
|
|
3357 < This function is not available in the |sandbox|.
|
|
|
3358
|
|
|
3359 histdel({history} [, {item}]) *histdel()*
|
|
236
|
3360 Clear {history}, i.e. delete all its entries. See |hist-names|
|
|
7
|
3361 for the possible values of {history}.
|
|
|
3362
|
|
|
3363 If the parameter {item} is given as String, this is seen
|
|
1621
|
3364 as regular expression. All entries matching that expression
|
|
7
|
3365 will be removed from the history (if there are any).
|
|
|
3366 Upper/lowercase must match, unless "\c" is used |/\c|.
|
|
|
3367 If {item} is a Number, it will be interpreted as index, see
|
|
|
3368 |:history-indexing|. The respective entry will be removed
|
|
|
3369 if it exists.
|
|
|
3370
|
|
|
3371 The result is a Number: 1 for a successful operation,
|
|
|
3372 otherwise 0 is returned.
|
|
|
3373
|
|
|
3374 Examples:
|
|
|
3375 Clear expression register history: >
|
|
|
3376 :call histdel("expr")
|
|
|
3377 <
|
|
|
3378 Remove all entries starting with "*" from the search history: >
|
|
|
3379 :call histdel("/", '^\*')
|
|
|
3380 <
|
|
|
3381 The following three are equivalent: >
|
|
|
3382 :call histdel("search", histnr("search"))
|
|
|
3383 :call histdel("search", -1)
|
|
|
3384 :call histdel("search", '^'.histget("search", -1).'$')
|
|
|
3385 <
|
|
|
3386 To delete the last search pattern and use the last-but-one for
|
|
|
3387 the "n" command and 'hlsearch': >
|
|
|
3388 :call histdel("search", -1)
|
|
|
3389 :let @/ = histget("search", -1)
|
|
|
3390
|
|
|
3391 histget({history} [, {index}]) *histget()*
|
|
|
3392 The result is a String, the entry with Number {index} from
|
|
|
3393 {history}. See |hist-names| for the possible values of
|
|
|
3394 {history}, and |:history-indexing| for {index}. If there is
|
|
|
3395 no such entry, an empty String is returned. When {index} is
|
|
|
3396 omitted, the most recent item from the history is used.
|
|
|
3397
|
|
|
3398 Examples:
|
|
|
3399 Redo the second last search from history. >
|
|
|
3400 :execute '/' . histget("search", -2)
|
|
|
3401
|
|
|
3402 < Define an Ex command ":H {num}" that supports re-execution of
|
|
|
3403 the {num}th entry from the output of |:history|. >
|
|
|
3404 :command -nargs=1 H execute histget("cmd", 0+<args>)
|
|
|
3405 <
|
|
|
3406 histnr({history}) *histnr()*
|
|
|
3407 The result is the Number of the current entry in {history}.
|
|
|
3408 See |hist-names| for the possible values of {history}.
|
|
|
3409 If an error occurred, -1 is returned.
|
|
|
3410
|
|
|
3411 Example: >
|
|
|
3412 :let inp_index = histnr("expr")
|
|
|
3413 <
|
|
|
3414 hlexists({name}) *hlexists()*
|
|
|
3415 The result is a Number, which is non-zero if a highlight group
|
|
|
3416 called {name} exists. This is when the group has been
|
|
|
3417 defined in some way. Not necessarily when highlighting has
|
|
|
3418 been defined for it, it may also have been used for a syntax
|
|
|
3419 item.
|
|
|
3420 *highlight_exists()*
|
|
|
3421 Obsolete name: highlight_exists().
|
|
|
3422
|
|
|
3423 *hlID()*
|
|
|
3424 hlID({name}) The result is a Number, which is the ID of the highlight group
|
|
|
3425 with name {name}. When the highlight group doesn't exist,
|
|
|
3426 zero is returned.
|
|
|
3427 This can be used to retrieve information about the highlight
|
|
1621
|
3428 group. For example, to get the background color of the
|
|
7
|
3429 "Comment" group: >
|
|
|
3430 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
|
|
|
3431 < *highlightID()*
|
|
|
3432 Obsolete name: highlightID().
|
|
|
3433
|
|
|
3434 hostname() *hostname()*
|
|
|
3435 The result is a String, which is the name of the machine on
|
|
236
|
3436 which Vim is currently running. Machine names greater than
|
|
7
|
3437 256 characters long are truncated.
|
|
|
3438
|
|
|
3439 iconv({expr}, {from}, {to}) *iconv()*
|
|
|
3440 The result is a String, which is the text {expr} converted
|
|
|
3441 from encoding {from} to encoding {to}.
|
|
|
3442 When the conversion fails an empty string is returned.
|
|
|
3443 The encoding names are whatever the iconv() library function
|
|
|
3444 can accept, see ":!man 3 iconv".
|
|
|
3445 Most conversions require Vim to be compiled with the |+iconv|
|
|
|
3446 feature. Otherwise only UTF-8 to latin1 conversion and back
|
|
|
3447 can be done.
|
|
|
3448 This can be used to display messages with special characters,
|
|
|
3449 no matter what 'encoding' is set to. Write the message in
|
|
|
3450 UTF-8 and use: >
|
|
|
3451 echo iconv(utf8_str, "utf-8", &enc)
|
|
|
3452 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
|
|
|
3453 from/to UCS-2 is automatically changed to use UTF-8. You
|
|
|
3454 cannot use UCS-2 in a string anyway, because of the NUL bytes.
|
|
|
3455 {only available when compiled with the +multi_byte feature}
|
|
|
3456
|
|
|
3457 *indent()*
|
|
|
3458 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
|
|
|
3459 current buffer. The indent is counted in spaces, the value
|
|
|
3460 of 'tabstop' is relevant. {lnum} is used just like in
|
|
|
3461 |getline()|.
|
|
|
3462 When {lnum} is invalid -1 is returned.
|
|
|
3463
|
|
79
|
3464
|
|
95
|
3465 index({list}, {expr} [, {start} [, {ic}]]) *index()*
|
|
685
|
3466 Return the lowest index in |List| {list} where the item has a
|
|
79
|
3467 value equal to {expr}.
|
|
153
|
3468 If {start} is given then start looking at the item with index
|
|
|
3469 {start} (may be negative for an item relative to the end).
|
|
79
|
3470 When {ic} is given and it is non-zero, ignore case. Otherwise
|
|
|
3471 case must match.
|
|
|
3472 -1 is returned when {expr} is not found in {list}.
|
|
|
3473 Example: >
|
|
|
3474 :let idx = index(words, "the")
|
|
87
|
3475 :if index(numbers, 123) >= 0
|
|
79
|
3476
|
|
|
3477
|
|
531
|
3478 input({prompt} [, {text} [, {completion}]]) *input()*
|
|
7
|
3479 The result is a String, which is whatever the user typed on
|
|
|
3480 the command-line. The parameter is either a prompt string, or
|
|
|
3481 a blank string (for no prompt). A '\n' can be used in the
|
|
531
|
3482 prompt to start a new line.
|
|
|
3483 The highlighting set with |:echohl| is used for the prompt.
|
|
|
3484 The input is entered just like a command-line, with the same
|
|
1621
|
3485 editing commands and mappings. There is a separate history
|
|
531
|
3486 for lines typed for input().
|
|
|
3487 Example: >
|
|
|
3488 :if input("Coffee or beer? ") == "beer"
|
|
|
3489 : echo "Cheers!"
|
|
|
3490 :endif
|
|
|
3491 <
|
|
532
|
3492 If the optional {text} is present and not empty, this is used
|
|
|
3493 for the default reply, as if the user typed this. Example: >
|
|
531
|
3494 :let color = input("Color? ", "white")
|
|
|
3495
|
|
|
3496 < The optional {completion} argument specifies the type of
|
|
|
3497 completion supported for the input. Without it completion is
|
|
1621
|
3498 not performed. The supported completion types are the same as
|
|
531
|
3499 that can be supplied to a user-defined command using the
|
|
1621
|
3500 "-complete=" argument. Refer to |:command-completion| for
|
|
531
|
3501 more information. Example: >
|
|
|
3502 let fname = input("File: ", "", "file")
|
|
|
3503 <
|
|
|
3504 NOTE: This function must not be used in a startup file, for
|
|
|
3505 the versions that only run in GUI mode (e.g., the Win32 GUI).
|
|
7
|
3506 Note: When input() is called from within a mapping it will
|
|
|
3507 consume remaining characters from that mapping, because a
|
|
|
3508 mapping is handled like the characters were typed.
|
|
|
3509 Use |inputsave()| before input() and |inputrestore()|
|
|
|
3510 after input() to avoid that. Another solution is to avoid
|
|
|
3511 that further characters follow in the mapping, e.g., by using
|
|
|
3512 |:execute| or |:normal|.
|
|
|
3513
|
|
531
|
3514 Example with a mapping: >
|
|
7
|
3515 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
|
|
|
3516 :function GetFoo()
|
|
|
3517 : call inputsave()
|
|
|
3518 : let g:Foo = input("enter search pattern: ")
|
|
|
3519 : call inputrestore()
|
|
|
3520 :endfunction
|
|
|
3521
|
|
|
3522 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
|
|
|
3523 Like input(), but when the GUI is running and text dialogs are
|
|
|
3524 supported, a dialog window pops up to input the text.
|
|
|
3525 Example: >
|
|
|
3526 :let n = inputdialog("value for shiftwidth", &sw)
|
|
|
3527 :if n != ""
|
|
|
3528 : let &sw = n
|
|
|
3529 :endif
|
|
|
3530 < When the dialog is cancelled {cancelreturn} is returned. When
|
|
|
3531 omitted an empty string is returned.
|
|
|
3532 Hitting <Enter> works like pressing the OK button. Hitting
|
|
|
3533 <Esc> works like pressing the Cancel button.
|
|
531
|
3534 NOTE: Command-line completion is not supported.
|
|
7
|
3535
|
|
519
|
3536 inputlist({textlist}) *inputlist()*
|
|
819
|
3537 {textlist} must be a |List| of strings. This |List| is
|
|
|
3538 displayed, one string per line. The user will be prompted to
|
|
|
3539 enter a number, which is returned.
|
|
519
|
3540 The user can also select an item by clicking on it with the
|
|
1621
|
3541 mouse. For the first string 0 is returned. When clicking
|
|
519
|
3542 above the first item a negative number is returned. When
|
|
|
3543 clicking on the prompt one more than the length of {textlist}
|
|
|
3544 is returned.
|
|
|
3545 Make sure {textlist} has less then 'lines' entries, otherwise
|
|
1621
|
3546 it won't work. It's a good idea to put the entry number at
|
|
1156
|
3547 the start of the string. And put a prompt in the first item.
|
|
|
3548 Example: >
|
|
519
|
3549 let color = inputlist(['Select color:', '1. red',
|
|
|
3550 \ '2. green', '3. blue'])
|
|
|
3551
|
|
7
|
3552 inputrestore() *inputrestore()*
|
|
|
3553 Restore typeahead that was saved with a previous inputsave().
|
|
|
3554 Should be called the same number of times inputsave() is
|
|
|
3555 called. Calling it more often is harmless though.
|
|
|
3556 Returns 1 when there is nothing to restore, 0 otherwise.
|
|
|
3557
|
|
|
3558 inputsave() *inputsave()*
|
|
|
3559 Preserve typeahead (also from mappings) and clear it, so that
|
|
|
3560 a following prompt gets input from the user. Should be
|
|
|
3561 followed by a matching inputrestore() after the prompt. Can
|
|
|
3562 be used several times, in which case there must be just as
|
|
|
3563 many inputrestore() calls.
|
|
|
3564 Returns 1 when out of memory, 0 otherwise.
|
|
|
3565
|
|
|
3566 inputsecret({prompt} [, {text}]) *inputsecret()*
|
|
|
3567 This function acts much like the |input()| function with but
|
|
|
3568 two exceptions:
|
|
|
3569 a) the user's response will be displayed as a sequence of
|
|
|
3570 asterisks ("*") thereby keeping the entry secret, and
|
|
|
3571 b) the user's response will not be recorded on the input
|
|
|
3572 |history| stack.
|
|
|
3573 The result is a String, which is whatever the user actually
|
|
|
3574 typed on the command-line in response to the issued prompt.
|
|
531
|
3575 NOTE: Command-line completion is not supported.
|
|
7
|
3576
|
|
55
|
3577 insert({list}, {item} [, {idx}]) *insert()*
|
|
685
|
3578 Insert {item} at the start of |List| {list}.
|
|
55
|
3579 If {idx} is specified insert {item} before the item with index
|
|
1621
|
3580 {idx}. If {idx} is zero it goes before the first item, just
|
|
55
|
3581 like omitting {idx}. A negative {idx} is also possible, see
|
|
|
3582 |list-index|. -1 inserts just before the last item.
|
|
685
|
3583 Returns the resulting |List|. Examples: >
|
|
55
|
3584 :let mylist = insert([2, 3, 5], 1)
|
|
|
3585 :call insert(mylist, 4, -1)
|
|
|
3586 :call insert(mylist, 6, len(mylist))
|
|
82
|
3587 < The last example can be done simpler with |add()|.
|
|
685
|
3588 Note that when {item} is a |List| it is inserted as a single
|
|
692
|
3589 item. Use |extend()| to concatenate |Lists|.
|
|
55
|
3590
|
|
7
|
3591 isdirectory({directory}) *isdirectory()*
|
|
|
3592 The result is a Number, which is non-zero when a directory
|
|
|
3593 with the name {directory} exists. If {directory} doesn't
|
|
|
3594 exist, or isn't a directory, the result is FALSE. {directory}
|
|
|
3595 is any expression, which is used as a String.
|
|
|
3596
|
|
819
|
3597 islocked({expr}) *islocked()* *E786*
|
|
148
|
3598 The result is a Number, which is non-zero when {expr} is the
|
|
|
3599 name of a locked variable.
|
|
685
|
3600 {expr} must be the name of a variable, |List| item or
|
|
|
3601 |Dictionary| entry, not the variable itself! Example: >
|
|
148
|
3602 :let alist = [0, ['a', 'b'], 2, 3]
|
|
|
3603 :lockvar 1 alist
|
|
|
3604 :echo islocked('alist') " 1
|
|
|
3605 :echo islocked('alist[1]') " 0
|
|
|
3606
|
|
|
3607 < When {expr} is a variable that does not exist you get an error
|
|
843
|
3608 message. Use |exists()| to check for existence.
|
|
148
|
3609
|
|
140
|
3610 items({dict}) *items()*
|
|
685
|
3611 Return a |List| with all the key-value pairs of {dict}. Each
|
|
|
3612 |List| item is a list with two items: the key of a {dict}
|
|
|
3613 entry and the value of this entry. The |List| is in arbitrary
|
|
|
3614 order.
|
|
140
|
3615
|
|
95
|
3616
|
|
|
3617 join({list} [, {sep}]) *join()*
|
|
|
3618 Join the items in {list} together into one String.
|
|
|
3619 When {sep} is specified it is put in between the items. If
|
|
|
3620 {sep} is omitted a single space is used.
|
|
|
3621 Note that {sep} is not added at the end. You might want to
|
|
|
3622 add it there too: >
|
|
|
3623 let lines = join(mylist, "\n") . "\n"
|
|
692
|
3624 < String items are used as-is. |Lists| and |Dictionaries| are
|
|
95
|
3625 converted into a string like with |string()|.
|
|
|
3626 The opposite function is |split()|.
|
|
|
3627
|
|
99
|
3628 keys({dict}) *keys()*
|
|
685
|
3629 Return a |List| with all the keys of {dict}. The |List| is in
|
|
99
|
3630 arbitrary order.
|
|
|
3631
|
|
85
|
3632 *len()* *E701*
|
|
55
|
3633 len({expr}) The result is a Number, which is the length of the argument.
|
|
|
3634 When {expr} is a String or a Number the length in bytes is
|
|
|
3635 used, as with |strlen()|.
|
|
685
|
3636 When {expr} is a |List| the number of items in the |List| is
|
|
55
|
3637 returned.
|
|
685
|
3638 When {expr} is a |Dictionary| the number of entries in the
|
|
|
3639 |Dictionary| is returned.
|
|
55
|
3640 Otherwise an error is given.
|
|
|
3641
|
|
7
|
3642 *libcall()* *E364* *E368*
|
|
|
3643 libcall({libname}, {funcname}, {argument})
|
|
|
3644 Call function {funcname} in the run-time library {libname}
|
|
|
3645 with single argument {argument}.
|
|
|
3646 This is useful to call functions in a library that you
|
|
|
3647 especially made to be used with Vim. Since only one argument
|
|
|
3648 is possible, calling standard library functions is rather
|
|
|
3649 limited.
|
|
|
3650 The result is the String returned by the function. If the
|
|
|
3651 function returns NULL, this will appear as an empty string ""
|
|
|
3652 to Vim.
|
|
|
3653 If the function returns a number, use libcallnr()!
|
|
|
3654 If {argument} is a number, it is passed to the function as an
|
|
|
3655 int; if {argument} is a string, it is passed as a
|
|
|
3656 null-terminated string.
|
|
|
3657 This function will fail in |restricted-mode|.
|
|
|
3658
|
|
|
3659 libcall() allows you to write your own 'plug-in' extensions to
|
|
|
3660 Vim without having to recompile the program. It is NOT a
|
|
|
3661 means to call system functions! If you try to do so Vim will
|
|
|
3662 very probably crash.
|
|
|
3663
|
|
|
3664 For Win32, the functions you write must be placed in a DLL
|
|
|
3665 and use the normal C calling convention (NOT Pascal which is
|
|
|
3666 used in Windows System DLLs). The function must take exactly
|
|
|
3667 one parameter, either a character pointer or a long integer,
|
|
|
3668 and must return a character pointer or NULL. The character
|
|
|
3669 pointer returned must point to memory that will remain valid
|
|
|
3670 after the function has returned (e.g. in static data in the
|
|
|
3671 DLL). If it points to allocated memory, that memory will
|
|
|
3672 leak away. Using a static buffer in the function should work,
|
|
|
3673 it's then freed when the DLL is unloaded.
|
|
|
3674
|
|
|
3675 WARNING: If the function returns a non-valid pointer, Vim may
|
|
1621
|
3676 crash! This also happens if the function returns a number,
|
|
7
|
3677 because Vim thinks it's a pointer.
|
|
|
3678 For Win32 systems, {libname} should be the filename of the DLL
|
|
|
3679 without the ".DLL" suffix. A full path is only required if
|
|
|
3680 the DLL is not in the usual places.
|
|
|
3681 For Unix: When compiling your own plugins, remember that the
|
|
|
3682 object code must be compiled as position-independent ('PIC').
|
|
|
3683 {only in Win32 on some Unix versions, when the |+libcall|
|
|
|
3684 feature is present}
|
|
|
3685 Examples: >
|
|
|
3686 :echo libcall("libc.so", "getenv", "HOME")
|
|
|
3687 <
|
|
|
3688 *libcallnr()*
|
|
|
3689 libcallnr({libname}, {funcname}, {argument})
|
|
|
3690 Just like libcall(), but used for a function that returns an
|
|
|
3691 int instead of a string.
|
|
|
3692 {only in Win32 on some Unix versions, when the |+libcall|
|
|
|
3693 feature is present}
|
|
1621
|
3694 Examples: >
|
|
|
3695 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
|
|
7
|
3696 :call libcallnr("libc.so", "printf", "Hello World!\n")
|
|
|
3697 :call libcallnr("libc.so", "sleep", 10)
|
|
|
3698 <
|
|
|
3699 *line()*
|
|
|
3700 line({expr}) The result is a Number, which is the line number of the file
|
|
|
3701 position given with {expr}. The accepted positions are:
|
|
|
3702 . the cursor position
|
|
|
3703 $ the last line in the current buffer
|
|
|
3704 'x position of mark x (if the mark is not set, 0 is
|
|
|
3705 returned)
|
|
665
|
3706 w0 first line visible in current window
|
|
|
3707 w$ last line visible in current window
|
|
1609
|
3708 v In Visual mode: the start of the Visual area (the
|
|
|
3709 cursor is the end). When not in Visual mode
|
|
|
3710 returns the cursor position. Differs from |'<| in
|
|
|
3711 that it's updated right away.
|
|
1156
|
3712 Note that a mark in another file can be used. The line number
|
|
|
3713 then applies to another buffer.
|
|
703
|
3714 To get the column number use |col()|. To get both use
|
|
|
3715 |getpos()|.
|
|
7
|
3716 Examples: >
|
|
|
3717 line(".") line number of the cursor
|
|
|
3718 line("'t") line number of mark t
|
|
|
3719 line("'" . marker) line number of mark marker
|
|
|
3720 < *last-position-jump*
|
|
|
3721 This autocommand jumps to the last known position in a file
|
|
|
3722 just after opening it, if the '" mark is set: >
|
|
1621
|
3723 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g'\"" | endif
|
|
9
|
3724
|
|
7
|
3725 line2byte({lnum}) *line2byte()*
|
|
|
3726 Return the byte count from the start of the buffer for line
|
|
|
3727 {lnum}. This includes the end-of-line character, depending on
|
|
|
3728 the 'fileformat' option for the current buffer. The first
|
|
|
3729 line returns 1.
|
|
|
3730 This can also be used to get the byte count for the line just
|
|
|
3731 below the last line: >
|
|
|
3732 line2byte(line("$") + 1)
|
|
|
3733 < This is the file size plus one.
|
|
|
3734 When {lnum} is invalid, or the |+byte_offset| feature has been
|
|
|
3735 disabled at compile time, -1 is returned.
|
|
|
3736 Also see |byte2line()|, |go| and |:goto|.
|
|
|
3737
|
|
|
3738 lispindent({lnum}) *lispindent()*
|
|
|
3739 Get the amount of indent for line {lnum} according the lisp
|
|
|
3740 indenting rules, as with 'lisp'.
|
|
|
3741 The indent is counted in spaces, the value of 'tabstop' is
|
|
|
3742 relevant. {lnum} is used just like in |getline()|.
|
|
|
3743 When {lnum} is invalid or Vim was not compiled the
|
|
|
3744 |+lispindent| feature, -1 is returned.
|
|
|
3745
|
|
|
3746 localtime() *localtime()*
|
|
|
3747 Return the current time, measured as seconds since 1st Jan
|
|
|
3748 1970. See also |strftime()| and |getftime()|.
|
|
|
3749
|
|
95
|
3750
|
|
1621
|
3751 log10({expr}) *log10()*
|
|
|
3752 Return the logarithm of Float {expr} to base 10 as a |Float|.
|
|
|
3753 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
3754 Examples: >
|
|
|
3755 :echo log10(1000)
|
|
|
3756 < 3.0 >
|
|
|
3757 :echo log10(0.01)
|
|
|
3758 < -2.0
|
|
|
3759 {only available when compiled with the |+float| feature}
|
|
|
3760
|
|
102
|
3761 map({expr}, {string}) *map()*
|
|
685
|
3762 {expr} must be a |List| or a |Dictionary|.
|
|
102
|
3763 Replace each item in {expr} with the result of evaluating
|
|
|
3764 {string}.
|
|
|
3765 Inside {string} |v:val| has the value of the current item.
|
|
685
|
3766 For a |Dictionary| |v:key| has the key of the current item.
|
|
102
|
3767 Example: >
|
|
|
3768 :call map(mylist, '"> " . v:val . " <"')
|
|
95
|
3769 < This puts "> " before and " <" after each item in "mylist".
|
|
102
|
3770
|
|
158
|
3771 Note that {string} is the result of an expression and is then
|
|
102
|
3772 used as an expression again. Often it is good to use a
|
|
158
|
3773 |literal-string| to avoid having to double backslashes. You
|
|
|
3774 still have to double ' quotes
|
|
102
|
3775
|
|
685
|
3776 The operation is done in-place. If you want a |List| or
|
|
|
3777 |Dictionary| to remain unmodified make a copy first: >
|
|
99
|
3778 :let tlist = map(copy(mylist), ' & . "\t"')
|
|
102
|
3779
|
|
685
|
3780 < Returns {expr}, the |List| or |Dictionary| that was filtered.
|
|
648
|
3781 When an error is encountered while evaluating {string} no
|
|
|
3782 further items in {expr} are processed.
|
|
95
|
3783
|
|
|
3784
|
|
782
|
3785 maparg({name}[, {mode} [, {abbr}]]) *maparg()*
|
|
7
|
3786 Return the rhs of mapping {name} in mode {mode}. When there
|
|
|
3787 is no mapping for {name}, an empty String is returned.
|
|
644
|
3788 {mode} can be one of these strings:
|
|
7
|
3789 "n" Normal
|
|
|
3790 "v" Visual
|
|
|
3791 "o" Operator-pending
|
|
|
3792 "i" Insert
|
|
|
3793 "c" Cmd-line
|
|
|
3794 "l" langmap |language-mapping|
|
|
|
3795 "" Normal, Visual and Operator-pending
|
|
644
|
3796 When {mode} is omitted, the modes for "" are used.
|
|
782
|
3797 When {abbr} is there and it is non-zero use abbreviations
|
|
|
3798 instead of mappings.
|
|
7
|
3799 The {name} can have special key names, like in the ":map"
|
|
|
3800 command. The returned String has special characters
|
|
|
3801 translated like in the output of the ":map" command listing.
|
|
|
3802 The mappings local to the current buffer are checked first,
|
|
|
3803 then the global mappings.
|
|
626
|
3804 This function can be used to map a key even when it's already
|
|
|
3805 mapped, and have it do the original mapping too. Sketch: >
|
|
|
3806 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
|
|
|
3807
|
|
7
|
3808
|
|
782
|
3809 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
|
|
7
|
3810 Check if there is a mapping that matches with {name} in mode
|
|
|
3811 {mode}. See |maparg()| for {mode} and special names in
|
|
|
3812 {name}.
|
|
782
|
3813 When {abbr} is there and it is non-zero use abbreviations
|
|
|
3814 instead of mappings.
|
|
7
|
3815 A match happens with a mapping that starts with {name} and
|
|
|
3816 with a mapping which is equal to the start of {name}.
|
|
|
3817
|
|
1621
|
3818 matches mapping "a" "ab" "abc" ~
|
|
7
|
3819 mapcheck("a") yes yes yes
|
|
|
3820 mapcheck("abc") yes yes yes
|
|
|
3821 mapcheck("ax") yes no no
|
|
|
3822 mapcheck("b") no no no
|
|
|
3823
|
|
|
3824 The difference with maparg() is that mapcheck() finds a
|
|
|
3825 mapping that matches with {name}, while maparg() only finds a
|
|
|
3826 mapping for {name} exactly.
|
|
|
3827 When there is no mapping that starts with {name}, an empty
|
|
|
3828 String is returned. If there is one, the rhs of that mapping
|
|
|
3829 is returned. If there are several mappings that start with
|
|
|
3830 {name}, the rhs of one of them is returned.
|
|
|
3831 The mappings local to the current buffer are checked first,
|
|
|
3832 then the global mappings.
|
|
|
3833 This function can be used to check if a mapping can be added
|
|
|
3834 without being ambiguous. Example: >
|
|
|
3835 :if mapcheck("_vv") == ""
|
|
|
3836 : map _vv :set guifont=7x13<CR>
|
|
|
3837 :endif
|
|
|
3838 < This avoids adding the "_vv" mapping when there already is a
|
|
|
3839 mapping for "_v" or for "_vvv".
|
|
|
3840
|
|
19
|
3841 match({expr}, {pat}[, {start}[, {count}]]) *match()*
|
|
685
|
3842 When {expr} is a |List| then this returns the index of the
|
|
|
3843 first item where {pat} matches. Each item is used as a
|
|
692
|
3844 String, |Lists| and |Dictionaries| are used as echoed.
|
|
1621
|
3845 Otherwise, {expr} is used as a String. The result is a
|
|
95
|
3846 Number, which gives the index (byte offset) in {expr} where
|
|
|
3847 {pat} matches.
|
|
685
|
3848 A match at the first character or |List| item returns zero.
|
|
19
|
3849 If there is no match -1 is returned.
|
|
|
3850 Example: >
|
|
95
|
3851 :echo match("testing", "ing") " results in 4
|
|
714
|
3852 :echo match([1, 'x'], '\a') " results in 1
|
|
95
|
3853 < See |string-match| for how {pat} is used.
|
|
170
|
3854 *strpbrk()*
|
|
1621
|
3855 Vim doesn't have a strpbrk() function. But you can do: >
|
|
170
|
3856 :let sepidx = match(line, '[.,;: \t]')
|
|
|
3857 < *strcasestr()*
|
|
|
3858 Vim doesn't have a strcasestr() function. But you can add
|
|
|
3859 "\c" to the pattern to ignore case: >
|
|
|
3860 :let idx = match(haystack, '\cneedle')
|
|
|
3861 <
|
|
95
|
3862 If {start} is given, the search starts from byte index
|
|
685
|
3863 {start} in a String or item {start} in a |List|.
|
|
7
|
3864 The result, however, is still the index counted from the
|
|
236
|
3865 first character/item. Example: >
|
|
7
|
3866 :echo match("testing", "ing", 2)
|
|
|
3867 < result is again "4". >
|
|
|
3868 :echo match("testing", "ing", 4)
|
|
|
3869 < result is again "4". >
|
|
|
3870 :echo match("testing", "t", 2)
|
|
|
3871 < result is "3".
|
|
694
|
3872 For a String, if {start} > 0 then it is like the string starts
|
|
703
|
3873 {start} bytes later, thus "^" will match at {start}. Except
|
|
|
3874 when {count} is given, then it's like matches before the
|
|
|
3875 {start} byte are ignored (this is a bit complicated to keep it
|
|
|
3876 backwards compatible).
|
|
95
|
3877 For a String, if {start} < 0, it will be set to 0. For a list
|
|
|
3878 the index is counted from the end.
|
|
697
|
3879 If {start} is out of range ({start} > strlen({expr}) for a
|
|
|
3880 String or {start} > len({expr}) for a |List|) -1 is returned.
|
|
95
|
3881
|
|
694
|
3882 When {count} is given use the {count}'th match. When a match
|
|
697
|
3883 is found in a String the search for the next one starts one
|
|
694
|
3884 character further. Thus this example results in 1: >
|
|
|
3885 echo match("testing", "..", 0, 2)
|
|
|
3886 < In a |List| the search continues in the next item.
|
|
703
|
3887 Note that when {count} is added the way {start} works changes,
|
|
|
3888 see above.
|
|
694
|
3889
|
|
7
|
3890 See |pattern| for the patterns that are accepted.
|
|
|
3891 The 'ignorecase' option is used to set the ignore-caseness of
|
|
1621
|
3892 the pattern. 'smartcase' is NOT used. The matching is always
|
|
7
|
3893 done like 'magic' is set and 'cpoptions' is empty.
|
|
|
3894
|
|
1326
|
3895 *matchadd()* *E798* *E799* *E801*
|
|
|
3896 matchadd({group}, {pattern}[, {priority}[, {id}]])
|
|
|
3897 Defines a pattern to be highlighted in the current window (a
|
|
|
3898 "match"). It will be highlighted with {group}. Returns an
|
|
|
3899 identification number (ID), which can be used to delete the
|
|
|
3900 match using |matchdelete()|.
|
|
|
3901
|
|
|
3902 The optional {priority} argument assigns a priority to the
|
|
1621
|
3903 match. A match with a high priority will have its
|
|
1326
|
3904 highlighting overrule that of a match with a lower priority.
|
|
|
3905 A priority is specified as an integer (negative numbers are no
|
|
|
3906 exception). If the {priority} argument is not specified, the
|
|
|
3907 default priority is 10. The priority of 'hlsearch' is zero,
|
|
|
3908 hence all matches with a priority greater than zero will
|
|
|
3909 overrule it. Syntax highlighting (see 'syntax') is a separate
|
|
|
3910 mechanism, and regardless of the chosen priority a match will
|
|
|
3911 always overrule syntax highlighting.
|
|
|
3912
|
|
|
3913 The optional {id} argument allows the request for a specific
|
|
|
3914 match ID. If a specified ID is already taken, an error
|
|
|
3915 message will appear and the match will not be added. An ID
|
|
|
3916 is specified as a positive integer (zero excluded). IDs 1, 2
|
|
|
3917 and 3 are reserved for |:match|, |:2match| and |:3match|,
|
|
|
3918 respectively. If the {id} argument is not specified,
|
|
|
3919 |matchadd()| automatically chooses a free ID.
|
|
|
3920
|
|
|
3921 The number of matches is not limited, as it is the case with
|
|
|
3922 the |:match| commands.
|
|
|
3923
|
|
|
3924 Example: >
|
|
|
3925 :highlight MyGroup ctermbg=green guibg=green
|
|
|
3926 :let m = matchadd("MyGroup", "TODO")
|
|
|
3927 < Deletion of the pattern: >
|
|
|
3928 :call matchdelete(m)
|
|
|
3929
|
|
|
3930 < A list of matches defined by |matchadd()| and |:match| are
|
|
1621
|
3931 available from |getmatches()|. All matches can be deleted in
|
|
1326
|
3932 one operation by |clearmatches()|.
|
|
819
|
3933
|
|
|
3934 matcharg({nr}) *matcharg()*
|
|
856
|
3935 Selects the {nr} match item, as set with a |:match|,
|
|
819
|
3936 |:2match| or |:3match| command.
|
|
|
3937 Return a |List| with two elements:
|
|
|
3938 The name of the highlight group used
|
|
|
3939 The pattern used.
|
|
|
3940 When {nr} is not 1, 2 or 3 returns an empty |List|.
|
|
|
3941 When there is no match item set returns ['', ''].
|
|
1326
|
3942 This is useful to save and restore a |:match|.
|
|
|
3943 Highlighting matches using the |:match| commands are limited
|
|
|
3944 to three matches. |matchadd()| does not have this limitation.
|
|
|
3945
|
|
|
3946 matchdelete({id}) *matchdelete()* *E802* *E803*
|
|
|
3947 Deletes a match with ID {id} previously defined by |matchadd()|
|
|
1621
|
3948 or one of the |:match| commands. Returns 0 if successful,
|
|
1326
|
3949 otherwise -1. See example for |matchadd()|. All matches can
|
|
|
3950 be deleted in one operation by |clearmatches()|.
|
|
819
|
3951
|
|
19
|
3952 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
|
|
7
|
3953 Same as match(), but return the index of first character after
|
|
|
3954 the match. Example: >
|
|
|
3955 :echo matchend("testing", "ing")
|
|
|
3956 < results in "7".
|
|
170
|
3957 *strspn()* *strcspn()*
|
|
|
3958 Vim doesn't have a strspn() or strcspn() function, but you can
|
|
|
3959 do it with matchend(): >
|
|
|
3960 :let span = matchend(line, '[a-zA-Z]')
|
|
|
3961 :let span = matchend(line, '[^a-zA-Z]')
|
|
|
3962 < Except that -1 is returned when there are no matches.
|
|
|
3963
|
|
7
|
3964 The {start}, if given, has the same meaning as for match(). >
|
|
|
3965 :echo matchend("testing", "ing", 2)
|
|
|
3966 < results in "7". >
|
|
|
3967 :echo matchend("testing", "ing", 5)
|
|
|
3968 < result is "-1".
|
|
685
|
3969 When {expr} is a |List| the result is equal to match().
|
|
7
|
3970
|
|
158
|
3971 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
|
|
685
|
3972 Same as match(), but return a |List|. The first item in the
|
|
158
|
3973 list is the matched string, same as what matchstr() would
|
|
|
3974 return. Following items are submatches, like "\1", "\2", etc.
|
|
842
|
3975 in |:substitute|. When an optional submatch didn't match an
|
|
|
3976 empty string is used. Example: >
|
|
|
3977 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
|
|
|
3978 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
|
|
158
|
3979 When there is no match an empty list is returned.
|
|
|
3980
|
|
19
|
3981 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
|
|
1621
|
3982 Same as |match()|, but return the matched string. Example: >
|
|
7
|
3983 :echo matchstr("testing", "ing")
|
|
|
3984 < results in "ing".
|
|
|
3985 When there is no match "" is returned.
|
|
|
3986 The {start}, if given, has the same meaning as for match(). >
|
|
|
3987 :echo matchstr("testing", "ing", 2)
|
|
|
3988 < results in "ing". >
|
|
|
3989 :echo matchstr("testing", "ing", 5)
|
|
|
3990 < result is "".
|
|
685
|
3991 When {expr} is a |List| then the matching item is returned.
|
|
95
|
3992 The type isn't changed, it's not necessarily a String.
|
|
7
|
3993
|
|
87
|
3994 *max()*
|
|
|
3995 max({list}) Return the maximum value of all items in {list}.
|
|
|
3996 If {list} is not a list or one of the items in {list} cannot
|
|
|
3997 be used as a Number this results in an error.
|
|
685
|
3998 An empty |List| results in zero.
|
|
87
|
3999
|
|
|
4000 *min()*
|
|
1215
|
4001 min({list}) Return the minimum value of all items in {list}.
|
|
87
|
4002 If {list} is not a list or one of the items in {list} cannot
|
|
|
4003 be used as a Number this results in an error.
|
|
685
|
4004 An empty |List| results in zero.
|
|
87
|
4005
|
|
843
|
4006 *mkdir()* *E739*
|
|
168
|
4007 mkdir({name} [, {path} [, {prot}]])
|
|
|
4008 Create directory {name}.
|
|
|
4009 If {path} is "p" then intermediate directories are created as
|
|
|
4010 necessary. Otherwise it must be "".
|
|
|
4011 If {prot} is given it is used to set the protection bits of
|
|
|
4012 the new directory. The default is 0755 (rwxr-xr-x: r/w for
|
|
1621
|
4013 the user readable for others). Use 0700 to make it unreadable
|
|
168
|
4014 for others.
|
|
|
4015 This function is not available in the |sandbox|.
|
|
|
4016 Not available on all systems. To check use: >
|
|
|
4017 :if exists("*mkdir")
|
|
|
4018 <
|
|
7
|
4019 *mode()*
|
|
1621
|
4020 mode([expr]) Return a string that indicates the current mode.
|
|
|
4021 If [expr] is supplied and it evaluates to a non-zero number or
|
|
|
4022 a non-empty string, then the full mode is returned, otherwise
|
|
|
4023 only the first letter is returned. Note that " " and "0" are
|
|
|
4024 also non-empty strings.
|
|
|
4025
|
|
7
|
4026 n Normal
|
|
1621
|
4027 no Operator-pending
|
|
7
|
4028 v Visual by character
|
|
|
4029 V Visual by line
|
|
|
4030 CTRL-V Visual blockwise
|
|
|
4031 s Select by character
|
|
|
4032 S Select by line
|
|
|
4033 CTRL-S Select blockwise
|
|
|
4034 i Insert
|
|
1621
|
4035 R Replace |R|
|
|
|
4036 Rv Virtual Replace |gR|
|
|
7
|
4037 c Command-line
|
|
1621
|
4038 cv Vim Ex mode |gQ|
|
|
|
4039 ce Normal Ex mode |Q|
|
|
7
|
4040 r Hit-enter prompt
|
|
1621
|
4041 rm The -- more -- prompt
|
|
|
4042 r? A |:confirm| query of some sort
|
|
|
4043 ! Shell or external command is executing
|
|
|
4044 This is useful in the 'statusline' option or when used
|
|
|
4045 with |remote_expr()| In most other places it always returns
|
|
|
4046 "c" or "n".
|
|
|
4047 Also see |visualmode()|.
|
|
7
|
4048
|
|
|
4049 nextnonblank({lnum}) *nextnonblank()*
|
|
|
4050 Return the line number of the first line at or below {lnum}
|
|
|
4051 that is not blank. Example: >
|
|
|
4052 if getline(nextnonblank(1)) =~ "Java"
|
|
|
4053 < When {lnum} is invalid or there is no non-blank line at or
|
|
|
4054 below it, zero is returned.
|
|
|
4055 See also |prevnonblank()|.
|
|
|
4056
|
|
|
4057 nr2char({expr}) *nr2char()*
|
|
|
4058 Return a string with a single character, which has the number
|
|
|
4059 value {expr}. Examples: >
|
|
|
4060 nr2char(64) returns "@"
|
|
|
4061 nr2char(32) returns " "
|
|
|
4062 < The current 'encoding' is used. Example for "utf-8": >
|
|
|
4063 nr2char(300) returns I with bow character
|
|
|
4064 < Note that a NUL character in the file is specified with
|
|
|
4065 nr2char(10), because NULs are represented with newline
|
|
|
4066 characters. nr2char(0) is a real NUL and terminates the
|
|
119
|
4067 string, thus results in an empty string.
|
|
7
|
4068
|
|
1548
|
4069 *getpid()*
|
|
|
4070 getpid() Return a Number which is the process ID of the Vim process.
|
|
1621
|
4071 On Unix and MS-Windows this is a unique number, until Vim
|
|
|
4072 exits. On MS-DOS it's always zero.
|
|
1548
|
4073
|
|
703
|
4074 *getpos()*
|
|
707
|
4075 getpos({expr}) Get the position for {expr}. For possible values of {expr}
|
|
|
4076 see |line()|.
|
|
|
4077 The result is a |List| with four numbers:
|
|
|
4078 [bufnum, lnum, col, off]
|
|
|
4079 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
|
|
|
4080 is the buffer number of the mark.
|
|
|
4081 "lnum" and "col" are the position in the buffer. The first
|
|
|
4082 column is 1.
|
|
703
|
4083 The "off" number is zero, unless 'virtualedit' is used. Then
|
|
|
4084 it is the offset in screen columns from the start of the
|
|
1266
|
4085 character. E.g., a position within a <Tab> or after the last
|
|
703
|
4086 character.
|
|
|
4087 This can be used to save and restore the cursor position: >
|
|
|
4088 let save_cursor = getpos(".")
|
|
|
4089 MoveTheCursorAround
|
|
798
|
4090 call setpos('.', save_cursor)
|
|
707
|
4091 < Also see |setpos()|.
|
|
703
|
4092
|
|
819
|
4093 pathshorten({expr}) *pathshorten()*
|
|
|
4094 Shorten directory names in the path {expr} and return the
|
|
|
4095 result. The tail, the file name, is kept as-is. The other
|
|
|
4096 components in the path are reduced to single letters. Leading
|
|
|
4097 '~' and '.' characters are kept. Example: >
|
|
|
4098 :echo pathshorten('~/.vim/autoload/myfile.vim')
|
|
|
4099 < ~/.v/a/myfile.vim ~
|
|
|
4100 It doesn't matter if the path exists or not.
|
|
|
4101
|
|
1621
|
4102 pow({x}, {y}) *pow()*
|
|
|
4103 Return the power of {x} to the exponent {y} as a |Float|.
|
|
|
4104 {x} and {y} must evaluate to a |Float| or a |Number|.
|
|
|
4105 Examples: >
|
|
|
4106 :echo pow(3, 3)
|
|
|
4107 < 27.0 >
|
|
|
4108 :echo pow(2, 16)
|
|
|
4109 < 65536.0 >
|
|
|
4110 :echo pow(32, 0.20)
|
|
|
4111 < 2.0
|
|
|
4112 {only available when compiled with the |+float| feature}
|
|
|
4113
|
|
667
|
4114 prevnonblank({lnum}) *prevnonblank()*
|
|
|
4115 Return the line number of the first line at or above {lnum}
|
|
|
4116 that is not blank. Example: >
|
|
|
4117 let ind = indent(prevnonblank(v:lnum - 1))
|
|
|
4118 < When {lnum} is invalid or there is no non-blank line at or
|
|
|
4119 above it, zero is returned.
|
|
|
4120 Also see |nextnonblank()|.
|
|
|
4121
|
|
|
4122
|
|
449
|
4123 printf({fmt}, {expr1} ...) *printf()*
|
|
|
4124 Return a String with {fmt}, where "%" items are replaced by
|
|
|
4125 the formatted form of their respective arguments. Example: >
|
|
452
|
4126 printf("%4d: E%d %.30s", lnum, errno, msg)
|
|
449
|
4127 < May result in:
|
|
452
|
4128 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
|
|
449
|
4129
|
|
|
4130 Often used items are:
|
|
856
|
4131 %s string
|
|
653
|
4132 %6s string right-aligned in 6 bytes
|
|
1621
|
4133 %.9s string truncated to 9 bytes
|
|
|
4134 %c single byte
|
|
|
4135 %d decimal number
|
|
|
4136 %5d decimal number padded with spaces to 5 characters
|
|
|
4137 %x hex number
|
|
|
4138 %04x hex number padded with zeros to at least 4 characters
|
|
|
4139 %X hex number using upper case letters
|
|
|
4140 %o octal number
|
|
|
4141 %f floating point number in the form 123.456
|
|
|
4142 %e floating point number in the form 1.234e3
|
|
|
4143 %E floating point number in the form 1.234E3
|
|
|
4144 %g floating point number, as %f or %e depending on value
|
|
|
4145 %G floating point number, as %f or %E depending on value
|
|
|
4146 %% the % character itself
|
|
449
|
4147
|
|
|
4148 Conversion specifications start with '%' and end with the
|
|
|
4149 conversion type. All other characters are copied unchanged to
|
|
|
4150 the result.
|
|
|
4151
|
|
|
4152 The "%" starts a conversion specification. The following
|
|
452
|
4153 arguments appear in sequence:
|
|
|
4154
|
|
|
4155 % [flags] [field-width] [.precision] type
|
|
|
4156
|
|
856
|
4157 flags
|
|
452
|
4158 Zero or more of the following flags:
|
|
|
4159
|
|
449
|
4160 # The value should be converted to an "alternate
|
|
|
4161 form". For c, d, and s conversions, this option
|
|
|
4162 has no effect. For o conversions, the precision
|
|
|
4163 of the number is increased to force the first
|
|
|
4164 character of the output string to a zero (except
|
|
|
4165 if a zero value is printed with an explicit
|
|
|
4166 precision of zero).
|
|
|
4167 For x and X conversions, a non-zero result has
|
|
|
4168 the string "0x" (or "0X" for X conversions)
|
|
|
4169 prepended to it.
|
|
452
|
4170
|
|
449
|
4171 0 (zero) Zero padding. For all conversions the converted
|
|
|
4172 value is padded on the left with zeros rather
|
|
|
4173 than blanks. If a precision is given with a
|
|
|
4174 numeric conversion (d, o, x, and X), the 0 flag
|
|
|
4175 is ignored.
|
|
452
|
4176
|
|
449
|
4177 - A negative field width flag; the converted value
|
|
|
4178 is to be left adjusted on the field boundary.
|
|
|
4179 The converted value is padded on the right with
|
|
|
4180 blanks, rather than on the left with blanks or
|
|
|
4181 zeros. A - overrides a 0 if both are given.
|
|
452
|
4182
|
|
449
|
4183 ' ' (space) A blank should be left before a positive
|
|
|
4184 number produced by a signed conversion (d).
|
|
452
|
4185
|
|
449
|
4186 + A sign must always be placed before a number
|
|
1621
|
4187 produced by a signed conversion. A + overrides
|
|
449
|
4188 a space if both are used.
|
|
452
|
4189
|
|
|
4190 field-width
|
|
|
4191 An optional decimal digit string specifying a minimum
|
|
653
|
4192 field width. If the converted value has fewer bytes
|
|
|
4193 than the field width, it will be padded with spaces on
|
|
|
4194 the left (or right, if the left-adjustment flag has
|
|
|
4195 been given) to fill out the field width.
|
|
452
|
4196
|
|
|
4197 .precision
|
|
|
4198 An optional precision, in the form of a period '.'
|
|
|
4199 followed by an optional digit string. If the digit
|
|
|
4200 string is omitted, the precision is taken as zero.
|
|
|
4201 This gives the minimum number of digits to appear for
|
|
|
4202 d, o, x, and X conversions, or the maximum number of
|
|
653
|
4203 bytes to be printed from a string for s conversions.
|
|
1621
|
4204 For floating point it is the number of digits after
|
|
|
4205 the decimal point.
|
|
452
|
4206
|
|
|
4207 type
|
|
|
4208 A character that specifies the type of conversion to
|
|
|
4209 be applied, see below.
|
|
|
4210
|
|
449
|
4211 A field width or precision, or both, may be indicated by an
|
|
|
4212 asterisk '*' instead of a digit string. In this case, a
|
|
1621
|
4213 Number argument supplies the field width or precision. A
|
|
449
|
4214 negative field width is treated as a left adjustment flag
|
|
|
4215 followed by a positive field width; a negative precision is
|
|
|
4216 treated as though it were missing. Example: >
|
|
452
|
4217 :echo printf("%d: %.*s", nr, width, line)
|
|
449
|
4218 < This limits the length of the text used from "line" to
|
|
452
|
4219 "width" bytes.
|
|
449
|
4220
|
|
856
|
4221 The conversion specifiers and their meanings are:
|
|
452
|
4222
|
|
1621
|
4223 *printf-d* *printf-o* *printf-x* *printf-X*
|
|
|
4224 doxX The Number argument is converted to signed decimal
|
|
449
|
4225 (d), unsigned octal (o), or unsigned hexadecimal (x
|
|
|
4226 and X) notation. The letters "abcdef" are used for
|
|
|
4227 x conversions; the letters "ABCDEF" are used for X
|
|
452
|
4228 conversions.
|
|
|
4229 The precision, if any, gives the minimum number of
|
|
|
4230 digits that must appear; if the converted value
|
|
|
4231 requires fewer digits, it is padded on the left with
|
|
|
4232 zeros.
|
|
|
4233 In no case does a non-existent or small field width
|
|
|
4234 cause truncation of a numeric field; if the result of
|
|
|
4235 a conversion is wider than the field width, the field
|
|
|
4236 is expanded to contain the conversion result.
|
|
|
4237
|
|
1621
|
4238 *printf-c*
|
|
452
|
4239 c The Number argument is converted to a byte, and the
|
|
|
4240 resulting character is written.
|
|
|
4241
|
|
1621
|
4242 *printf-s*
|
|
452
|
4243 s The text of the String argument is used. If a
|
|
|
4244 precision is specified, no more bytes than the number
|
|
|
4245 specified are used.
|
|
|
4246
|
|
1621
|
4247 *printf-f* *E807*
|
|
|
4248 f The Float argument is converted into a string of the
|
|
|
4249 form 123.456. The precision specifies the number of
|
|
|
4250 digits after the decimal point. When the precision is
|
|
|
4251 zero the decimal point is omitted. When the precision
|
|
|
4252 is not specified 6 is used. A really big number
|
|
|
4253 (out of range or dividing by zero) results in "inf".
|
|
|
4254 "0.0 / 0.0" results in "nan".
|
|
|
4255 Example: >
|
|
|
4256 echo printf("%.2f", 12.115)
|
|
|
4257 < 12.12
|
|
|
4258 Note that roundoff depends on the system libraries.
|
|
|
4259 Use |round()| when in doubt.
|
|
|
4260
|
|
|
4261 *printf-e* *printf-E*
|
|
|
4262 e E The Float argument is converted into a string of the
|
|
|
4263 form 1.234e+03 or 1.234E+03 when using 'E'. The
|
|
|
4264 precision specifies the number of digits after the
|
|
|
4265 decimal point, like with 'f'.
|
|
|
4266
|
|
|
4267 *printf-g* *printf-G*
|
|
|
4268 g G The Float argument is converted like with 'f' if the
|
|
|
4269 value is between 0.001 (inclusive) and 10000000.0
|
|
|
4270 (exclusive). Otherwise 'e' is used for 'g' and 'E'
|
|
|
4271 for 'G'. When no precision is specified superfluous
|
|
|
4272 zeroes and '+' signs are removed, except for the zero
|
|
|
4273 immediately after the decimal point. Thus 10000000.0
|
|
|
4274 results in 1.0e7.
|
|
|
4275
|
|
|
4276 *printf-%*
|
|
449
|
4277 % A '%' is written. No argument is converted. The
|
|
|
4278 complete conversion specification is "%%".
|
|
452
|
4279
|
|
449
|
4280 Each argument can be Number or String and is converted
|
|
1621
|
4281 automatically to fit the conversion specifier. Any other
|
|
452
|
4282 argument type results in an error message.
|
|
449
|
4283
|
|
459
|
4284 *E766* *E767*
|
|
449
|
4285 The number of {exprN} arguments must exactly match the number
|
|
|
4286 of "%" items. If there are not sufficient or too many
|
|
452
|
4287 arguments an error is given. Up to 18 arguments can be used.
|
|
449
|
4288
|
|
|
4289
|
|
667
|
4290 pumvisible() *pumvisible()*
|
|
|
4291 Returns non-zero when the popup menu is visible, zero
|
|
|
4292 otherwise. See |ins-completion-menu|.
|
|
712
|
4293 This can be used to avoid some things that would remove the
|
|
|
4294 popup menu.
|
|
7
|
4295
|
|
114
|
4296 *E726* *E727*
|
|
99
|
4297 range({expr} [, {max} [, {stride}]]) *range()*
|
|
685
|
4298 Returns a |List| with Numbers:
|
|
99
|
4299 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
|
|
|
4300 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
|
|
|
4301 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
|
|
|
4302 {max}] (increasing {expr} with {stride} each time, not
|
|
|
4303 producing a value past {max}).
|
|
336
|
4304 When the maximum is one before the start the result is an
|
|
|
4305 empty list. When the maximum is more than one before the
|
|
|
4306 start this is an error.
|
|
99
|
4307 Examples: >
|
|
856
|
4308 range(4) " [0, 1, 2, 3]
|
|
99
|
4309 range(2, 4) " [2, 3, 4]
|
|
|
4310 range(2, 9, 3) " [2, 5, 8]
|
|
856
|
4311 range(2, -2, -1) " [2, 1, 0, -1, -2]
|
|
336
|
4312 range(0) " []
|
|
|
4313 range(2, 0) " error!
|
|
99
|
4314 <
|
|
158
|
4315 *readfile()*
|
|
168
|
4316 readfile({fname} [, {binary} [, {max}]])
|
|
685
|
4317 Read file {fname} and return a |List|, each line of the file
|
|
|
4318 as an item. Lines broken at NL characters. Macintosh files
|
|
158
|
4319 separated with CR will result in a single long line (unless a
|
|
|
4320 NL appears somewhere).
|
|
|
4321 When {binary} is equal to "b" binary mode is used:
|
|
|
4322 - When the last line ends in a NL an extra empty list item is
|
|
|
4323 added.
|
|
|
4324 - No CR characters are removed.
|
|
|
4325 Otherwise:
|
|
|
4326 - CR characters that appear before a NL are removed.
|
|
|
4327 - Whether the last line ends in a NL or not does not matter.
|
|
|
4328 All NUL characters are replaced with a NL character.
|
|
168
|
4329 When {max} is given this specifies the maximum number of lines
|
|
|
4330 to be read. Useful if you only want to check the first ten
|
|
|
4331 lines of a file: >
|
|
|
4332 :for line in readfile(fname, '', 10)
|
|
|
4333 : if line =~ 'Date' | echo line | endif
|
|
|
4334 :endfor
|
|
233
|
4335 < When {max} is negative -{max} lines from the end of the file
|
|
|
4336 are returned, or as many as there are.
|
|
|
4337 When {max} is zero the result is an empty list.
|
|
168
|
4338 Note that without {max} the whole file is read into memory.
|
|
|
4339 Also note that there is no recognition of encoding. Read a
|
|
|
4340 file into a buffer if you need to.
|
|
158
|
4341 When the file can't be opened an error message is given and
|
|
|
4342 the result is an empty list.
|
|
|
4343 Also see |writefile()|.
|
|
|
4344
|
|
794
|
4345 reltime([{start} [, {end}]]) *reltime()*
|
|
|
4346 Return an item that represents a time value. The format of
|
|
|
4347 the item depends on the system. It can be passed to
|
|
|
4348 |reltimestr()| to convert it to a string.
|
|
|
4349 Without an argument it returns the current time.
|
|
|
4350 With one argument is returns the time passed since the time
|
|
|
4351 specified in the argument.
|
|
843
|
4352 With two arguments it returns the time passed between {start}
|
|
794
|
4353 and {end}.
|
|
|
4354 The {start} and {end} arguments must be values returned by
|
|
|
4355 reltime().
|
|
|
4356 {only available when compiled with the +reltime feature}
|
|
|
4357
|
|
|
4358 reltimestr({time}) *reltimestr()*
|
|
|
4359 Return a String that represents the time value of {time}.
|
|
|
4360 This is the number of seconds, a dot and the number of
|
|
|
4361 microseconds. Example: >
|
|
|
4362 let start = reltime()
|
|
|
4363 call MyFunction()
|
|
|
4364 echo reltimestr(reltime(start))
|
|
|
4365 < Note that overhead for the commands will be added to the time.
|
|
|
4366 The accuracy depends on the system.
|
|
1156
|
4367 Leading spaces are used to make the string align nicely. You
|
|
|
4368 can use split() to remove it. >
|
|
|
4369 echo split(reltimestr(reltime(start)))[0]
|
|
|
4370 < Also see |profiling|.
|
|
794
|
4371 {only available when compiled with the +reltime feature}
|
|
|
4372
|
|
7
|
4373 *remote_expr()* *E449*
|
|
|
4374 remote_expr({server}, {string} [, {idvar}])
|
|
1621
|
4375 Send the {string} to {server}. The string is sent as an
|
|
7
|
4376 expression and the result is returned after evaluation.
|
|
714
|
4377 The result must be a String or a |List|. A |List| is turned
|
|
|
4378 into a String by joining the items with a line break in
|
|
|
4379 between (not at the end), like with join(expr, "\n").
|
|
7
|
4380 If {idvar} is present, it is taken as the name of a
|
|
|
4381 variable and a {serverid} for later use with
|
|
|
4382 remote_read() is stored there.
|
|
|
4383 See also |clientserver| |RemoteReply|.
|
|
|
4384 This function is not available in the |sandbox|.
|
|
|
4385 {only available when compiled with the |+clientserver| feature}
|
|
|
4386 Note: Any errors will cause a local error message to be issued
|
|
|
4387 and the result will be the empty string.
|
|
|
4388 Examples: >
|
|
|
4389 :echo remote_expr("gvim", "2+2")
|
|
|
4390 :echo remote_expr("gvim1", "b:current_syntax")
|
|
|
4391 <
|
|
|
4392
|
|
|
4393 remote_foreground({server}) *remote_foreground()*
|
|
|
4394 Move the Vim server with the name {server} to the foreground.
|
|
|
4395 This works like: >
|
|
|
4396 remote_expr({server}, "foreground()")
|
|
|
4397 < Except that on Win32 systems the client does the work, to work
|
|
|
4398 around the problem that the OS doesn't always allow the server
|
|
|
4399 to bring itself to the foreground.
|
|
574
|
4400 Note: This does not restore the window if it was minimized,
|
|
|
4401 like foreground() does.
|
|
7
|
4402 This function is not available in the |sandbox|.
|
|
|
4403 {only in the Win32, Athena, Motif and GTK GUI versions and the
|
|
|
4404 Win32 console version}
|
|
|
4405
|
|
|
4406
|
|
|
4407 remote_peek({serverid} [, {retvar}]) *remote_peek()*
|
|
|
4408 Returns a positive number if there are available strings
|
|
|
4409 from {serverid}. Copies any reply string into the variable
|
|
1621
|
4410 {retvar} if specified. {retvar} must be a string with the
|
|
7
|
4411 name of a variable.
|
|
|
4412 Returns zero if none are available.
|
|
|
4413 Returns -1 if something is wrong.
|
|
|
4414 See also |clientserver|.
|
|
|
4415 This function is not available in the |sandbox|.
|
|
|
4416 {only available when compiled with the |+clientserver| feature}
|
|
|
4417 Examples: >
|
|
|
4418 :let repl = ""
|
|
|
4419 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
|
|
|
4420
|
|
|
4421 remote_read({serverid}) *remote_read()*
|
|
|
4422 Return the oldest available reply from {serverid} and consume
|
|
|
4423 it. It blocks until a reply is available.
|
|
|
4424 See also |clientserver|.
|
|
|
4425 This function is not available in the |sandbox|.
|
|
|
4426 {only available when compiled with the |+clientserver| feature}
|
|
|
4427 Example: >
|
|
|
4428 :echo remote_read(id)
|
|
|
4429 <
|
|
|
4430 *remote_send()* *E241*
|
|
|
4431 remote_send({server}, {string} [, {idvar}])
|
|
1621
|
4432 Send the {string} to {server}. The string is sent as input
|
|
22
|
4433 keys and the function returns immediately. At the Vim server
|
|
|
4434 the keys are not mapped |:map|.
|
|
667
|
4435 If {idvar} is present, it is taken as the name of a variable
|
|
|
4436 and a {serverid} for later use with remote_read() is stored
|
|
|
4437 there.
|
|
7
|
4438 See also |clientserver| |RemoteReply|.
|
|
|
4439 This function is not available in the |sandbox|.
|
|
|
4440 {only available when compiled with the |+clientserver| feature}
|
|
|
4441 Note: Any errors will be reported in the server and may mess
|
|
|
4442 up the display.
|
|
|
4443 Examples: >
|
|
|
4444 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
|
|
|
4445 \ remote_read(serverid)
|
|
|
4446
|
|
|
4447 :autocmd NONE RemoteReply *
|
|
|
4448 \ echo remote_read(expand("<amatch>"))
|
|
|
4449 :echo remote_send("gvim", ":sleep 10 | echo ".
|
|
|
4450 \ 'server2client(expand("<client>"), "HELLO")<CR>')
|
|
82
|
4451 <
|
|
79
|
4452 remove({list}, {idx} [, {end}]) *remove()*
|
|
685
|
4453 Without {end}: Remove the item at {idx} from |List| {list} and
|
|
79
|
4454 return it.
|
|
|
4455 With {end}: Remove items from {idx} to {end} (inclusive) and
|
|
|
4456 return a list with these items. When {idx} points to the same
|
|
|
4457 item as {end} a list with one item is returned. When {end}
|
|
|
4458 points to an item before {idx} this is an error.
|
|
|
4459 See |list-index| for possible values of {idx} and {end}.
|
|
55
|
4460 Example: >
|
|
|
4461 :echo "last item: " . remove(mylist, -1)
|
|
79
|
4462 :call remove(mylist, 0, 9)
|
|
99
|
4463 remove({dict}, {key})
|
|
|
4464 Remove the entry from {dict} with key {key}. Example: >
|
|
|
4465 :echo "removed " . remove(dict, "one")
|
|
|
4466 < If there is no {key} in {dict} this is an error.
|
|
|
4467
|
|
|
4468 Use |delete()| to remove a file.
|
|
55
|
4469
|
|
7
|
4470 rename({from}, {to}) *rename()*
|
|
|
4471 Rename the file by the name {from} to the name {to}. This
|
|
|
4472 should also work to move files across file systems. The
|
|
|
4473 result is a Number, which is 0 if the file was renamed
|
|
|
4474 successfully, and non-zero when the renaming failed.
|
|
|
4475 This function is not available in the |sandbox|.
|
|
|
4476
|
|
18
|
4477 repeat({expr}, {count}) *repeat()*
|
|
|
4478 Repeat {expr} {count} times and return the concatenated
|
|
|
4479 result. Example: >
|
|
843
|
4480 :let separator = repeat('-', 80)
|
|
18
|
4481 < When {count} is zero or negative the result is empty.
|
|
685
|
4482 When {expr} is a |List| the result is {expr} concatenated
|
|
1621
|
4483 {count} times. Example: >
|
|
79
|
4484 :let longlist = repeat(['a', 'b'], 3)
|
|
|
4485 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
|
|
18
|
4486
|
|
82
|
4487
|
|
7
|
4488 resolve({filename}) *resolve()* *E655*
|
|
|
4489 On MS-Windows, when {filename} is a shortcut (a .lnk file),
|
|
|
4490 returns the path the shortcut points to in a simplified form.
|
|
|
4491 On Unix, repeat resolving symbolic links in all path
|
|
|
4492 components of {filename} and return the simplified result.
|
|
|
4493 To cope with link cycles, resolving of symbolic links is
|
|
|
4494 stopped after 100 iterations.
|
|
|
4495 On other systems, return the simplified {filename}.
|
|
|
4496 The simplification step is done as by |simplify()|.
|
|
|
4497 resolve() keeps a leading path component specifying the
|
|
|
4498 current directory (provided the result is still a relative
|
|
|
4499 path name) and also keeps a trailing path separator.
|
|
|
4500
|
|
82
|
4501 *reverse()*
|
|
1621
|
4502 reverse({list}) Reverse the order of items in {list} in-place. Returns
|
|
82
|
4503 {list}.
|
|
|
4504 If you want a list to remain unmodified make a copy first: >
|
|
|
4505 :let revlist = reverse(copy(mylist))
|
|
|
4506
|
|
1621
|
4507 round({expr}) *round()*
|
|
|
4508 Round off {expr} to a the nearest integral value and return it
|
|
|
4509 as a |Float|. If {expr} lies halfway between two integral
|
|
|
4510 values, then use the larger one (away from zero).
|
|
|
4511 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
4512 Examples: >
|
|
|
4513 echo round(0.456)
|
|
|
4514 < 0.0 >
|
|
|
4515 echo round(4.5)
|
|
|
4516 < 5.0 >
|
|
|
4517 echo round(-4.5)
|
|
|
4518 < -5.0
|
|
|
4519 {only available when compiled with the |+float| feature}
|
|
|
4520
|
|
|
4521
|
|
1496
|
4522 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
|
|
7
|
4523 Search for regexp pattern {pattern}. The search starts at the
|
|
119
|
4524 cursor position (you can use |cursor()| to set it).
|
|
707
|
4525
|
|
7
|
4526 {flags} is a String, which can contain these character flags:
|
|
|
4527 'b' search backward instead of forward
|
|
1621
|
4528 'c' accept a match at the cursor position
|
|
712
|
4529 'e' move to the End of the match
|
|
20
|
4530 'n' do Not move the cursor
|
|
712
|
4531 'p' return number of matching sub-pattern (see below)
|
|
|
4532 's' set the ' mark at the previous location of the cursor
|
|
7
|
4533 'w' wrap around the end of the file
|
|
|
4534 'W' don't wrap around the end of the file
|
|
|
4535 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
|
|
|
4536
|
|
444
|
4537 If the 's' flag is supplied, the ' mark is set, only if the
|
|
|
4538 cursor is moved. The 's' flag cannot be combined with the 'n'
|
|
|
4539 flag.
|
|
|
4540
|
|
1156
|
4541 'ignorecase', 'smartcase' and 'magic' are used.
|
|
|
4542
|
|
692
|
4543 When the {stopline} argument is given then the search stops
|
|
|
4544 after searching this line. This is useful to restrict the
|
|
|
4545 search to a range of lines. Examples: >
|
|
|
4546 let match = search('(', 'b', line("w0"))
|
|
|
4547 let end = search('END', '', line("w$"))
|
|
|
4548 < When {stopline} is used and it is not zero this also implies
|
|
|
4549 that the search does not wrap around the end of the file.
|
|
1496
|
4550 A zero value is equal to not giving the argument.
|
|
|
4551
|
|
|
4552 When the {timeout} argument is given the search stops when
|
|
1621
|
4553 more than this many milli seconds have passed. Thus when
|
|
1496
|
4554 {timeout} is 500 the search stops after half a second.
|
|
|
4555 The value must not be negative. A zero value is like not
|
|
|
4556 giving the argument.
|
|
|
4557 {only available when compiled with the +reltime feature}
|
|
692
|
4558
|
|
712
|
4559 If there is no match a 0 is returned and the cursor doesn't
|
|
|
4560 move. No error message is given.
|
|
714
|
4561 When a match has been found its line number is returned.
|
|
|
4562 *search()-sub-match*
|
|
|
4563 With the 'p' flag the returned value is one more than the
|
|
|
4564 first sub-match in \(\). One if none of them matched but the
|
|
|
4565 whole pattern did match.
|
|
712
|
4566 To get the column number too use |searchpos()|.
|
|
|
4567
|
|
20
|
4568 The cursor will be positioned at the match, unless the 'n'
|
|
707
|
4569 flag is used.
|
|
7
|
4570
|
|
|
4571 Example (goes over all files in the argument list): >
|
|
|
4572 :let n = 1
|
|
|
4573 :while n <= argc() " loop over all files in arglist
|
|
|
4574 : exe "argument " . n
|
|
|
4575 : " start at the last char in the file and wrap for the
|
|
|
4576 : " first search to find match at start of file
|
|
|
4577 : normal G$
|
|
|
4578 : let flags = "w"
|
|
|
4579 : while search("foo", flags) > 0
|
|
1621
|
4580 : s/foo/bar/g
|
|
7
|
4581 : let flags = "W"
|
|
|
4582 : endwhile
|
|
|
4583 : update " write the file if modified
|
|
|
4584 : let n = n + 1
|
|
|
4585 :endwhile
|
|
|
4586 <
|
|
712
|
4587 Example for using some flags: >
|
|
|
4588 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
|
|
|
4589 < This will search for the keywords "if", "else", and "endif"
|
|
|
4590 under or after the cursor. Because of the 'p' flag, it
|
|
|
4591 returns 1, 2, or 3 depending on which keyword is found, or 0
|
|
|
4592 if the search fails. With the cursor on the first word of the
|
|
|
4593 line:
|
|
|
4594 if (foo == 0) | let foo = foo + 1 | endif ~
|
|
|
4595 the function returns 1. Without the 'c' flag, the function
|
|
|
4596 finds the "endif" and returns 3. The same thing happens
|
|
|
4597 without the 'e' flag if the cursor is on the "f" of "if".
|
|
|
4598 The 'n' flag tells the function not to move the cursor.
|
|
|
4599
|
|
504
|
4600
|
|
523
|
4601 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
|
|
|
4602 Search for the declaration of {name}.
|
|
856
|
4603
|
|
523
|
4604 With a non-zero {global} argument it works like |gD|, find
|
|
|
4605 first match in the file. Otherwise it works like |gd|, find
|
|
|
4606 first match in the function.
|
|
|
4607
|
|
|
4608 With a non-zero {thisblock} argument matches in a {} block
|
|
|
4609 that ends before the cursor position are ignored. Avoids
|
|
|
4610 finding variable declarations only valid in another scope.
|
|
|
4611
|
|
504
|
4612 Moves the cursor to the found match.
|
|
|
4613 Returns zero for success, non-zero for failure.
|
|
|
4614 Example: >
|
|
|
4615 if searchdecl('myvar') == 0
|
|
|
4616 echo getline('.')
|
|
|
4617 endif
|
|
|
4618 <
|
|
7
|
4619 *searchpair()*
|
|
1496
|
4620 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
|
|
|
4621 [, {stopline} [, {timeout}]]]])
|
|
7
|
4622 Search for the match of a nested start-end pair. This can be
|
|
|
4623 used to find the "endif" that matches an "if", while other
|
|
|
4624 if/endif pairs in between are ignored.
|
|
677
|
4625 The search starts at the cursor. The default is to search
|
|
|
4626 forward, include 'b' in {flags} to search backward.
|
|
|
4627 If a match is found, the cursor is positioned at it and the
|
|
|
4628 line number is returned. If no match is found 0 or -1 is
|
|
|
4629 returned and the cursor doesn't move. No error message is
|
|
|
4630 given.
|
|
7
|
4631
|
|
|
4632 {start}, {middle} and {end} are patterns, see |pattern|. They
|
|
|
4633 must not contain \( \) pairs. Use of \%( \) is allowed. When
|
|
|
4634 {middle} is not empty, it is found when searching from either
|
|
|
4635 direction, but only when not in a nested start-end pair. A
|
|
|
4636 typical use is: >
|
|
|
4637 searchpair('\<if\>', '\<else\>', '\<endif\>')
|
|
|
4638 < By leaving {middle} empty the "else" is skipped.
|
|
|
4639
|
|
712
|
4640 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
|
|
|
4641 |search()|. Additionally:
|
|
7
|
4642 'r' Repeat until no more matches found; will find the
|
|
1621
|
4643 outer pair. Implies the 'W' flag.
|
|
|
4644 'm' Return number of matches instead of line number with
|
|
712
|
4645 the match; will be > 1 when 'r' is used.
|
|
1621
|
4646 Note: it's nearly always a good idea to use the 'W' flag, to
|
|
|
4647 avoid wrapping around the end of the file.
|
|
7
|
4648
|
|
|
4649 When a match for {start}, {middle} or {end} is found, the
|
|
|
4650 {skip} expression is evaluated with the cursor positioned on
|
|
|
4651 the start of the match. It should return non-zero if this
|
|
|
4652 match is to be skipped. E.g., because it is inside a comment
|
|
|
4653 or a string.
|
|
|
4654 When {skip} is omitted or empty, every match is accepted.
|
|
|
4655 When evaluating {skip} causes an error the search is aborted
|
|
|
4656 and -1 returned.
|
|
|
4657
|
|
1496
|
4658 For {stopline} and {timeout} see |search()|.
|
|
692
|
4659
|
|
7
|
4660 The value of 'ignorecase' is used. 'magic' is ignored, the
|
|
|
4661 patterns are used like it's on.
|
|
|
4662
|
|
|
4663 The search starts exactly at the cursor. A match with
|
|
|
4664 {start}, {middle} or {end} at the next character, in the
|
|
|
4665 direction of searching, is the first one found. Example: >
|
|
|
4666 if 1
|
|
|
4667 if 2
|
|
|
4668 endif 2
|
|
|
4669 endif 1
|
|
|
4670 < When starting at the "if 2", with the cursor on the "i", and
|
|
|
4671 searching forwards, the "endif 2" is found. When starting on
|
|
|
4672 the character just before the "if 2", the "endif 1" will be
|
|
1621
|
4673 found. That's because the "if 2" will be found first, and
|
|
7
|
4674 then this is considered to be a nested if/endif from "if 2" to
|
|
|
4675 "endif 2".
|
|
|
4676 When searching backwards and {end} is more than one character,
|
|
|
4677 it may be useful to put "\zs" at the end of the pattern, so
|
|
|
4678 that when the cursor is inside a match with the end it finds
|
|
|
4679 the matching start.
|
|
|
4680
|
|
|
4681 Example, to find the "endif" command in a Vim script: >
|
|
|
4682
|
|
|
4683 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
|
|
|
4684 \ 'getline(".") =~ "^\\s*\""')
|
|
|
4685
|
|
|
4686 < The cursor must be at or after the "if" for which a match is
|
|
|
4687 to be found. Note that single-quote strings are used to avoid
|
|
|
4688 having to double the backslashes. The skip expression only
|
|
|
4689 catches comments at the start of a line, not after a command.
|
|
|
4690 Also, a word "en" or "if" halfway a line is considered a
|
|
|
4691 match.
|
|
|
4692 Another example, to search for the matching "{" of a "}": >
|
|
|
4693
|
|
|
4694 :echo searchpair('{', '', '}', 'bW')
|
|
|
4695
|
|
|
4696 < This works when the cursor is at or before the "}" for which a
|
|
|
4697 match is to be found. To reject matches that syntax
|
|
|
4698 highlighting recognized as strings: >
|
|
|
4699
|
|
|
4700 :echo searchpair('{', '', '}', 'bW',
|
|
|
4701 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
|
|
|
4702 <
|
|
667
|
4703 *searchpairpos()*
|
|
1496
|
4704 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
|
|
|
4705 [, {stopline} [, {timeout}]]]])
|
|
685
|
4706 Same as searchpair(), but returns a |List| with the line and
|
|
|
4707 column position of the match. The first element of the |List|
|
|
|
4708 is the line number and the second element is the byte index of
|
|
667
|
4709 the column position of the match. If no match is found,
|
|
|
4710 returns [0, 0].
|
|
|
4711 >
|
|
|
4712 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
|
|
|
4713 <
|
|
|
4714 See |match-parens| for a bigger and more useful example.
|
|
|
4715
|
|
1496
|
4716 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
|
|
692
|
4717 Same as |search()|, but returns a |List| with the line and
|
|
685
|
4718 column position of the match. The first element of the |List|
|
|
|
4719 is the line number and the second element is the byte index of
|
|
|
4720 the column position of the match. If no match is found,
|
|
|
4721 returns [0, 0].
|
|
714
|
4722 Example: >
|
|
|
4723 :let [lnum, col] = searchpos('mypattern', 'n')
|
|
|
4724
|
|
|
4725 < When the 'p' flag is given then there is an extra item with
|
|
|
4726 the sub-pattern match number |search()-sub-match|. Example: >
|
|
|
4727 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
|
|
|
4728 < In this example "submatch" is 2 when a lowercase letter is
|
|
|
4729 found |/\l|, 3 when an uppercase letter is found |/\u|.
|
|
|
4730
|
|
7
|
4731 server2client( {clientid}, {string}) *server2client()*
|
|
|
4732 Send a reply string to {clientid}. The most recent {clientid}
|
|
|
4733 that sent a string can be retrieved with expand("<client>").
|
|
|
4734 {only available when compiled with the |+clientserver| feature}
|
|
|
4735 Note:
|
|
|
4736 This id has to be stored before the next command can be
|
|
236
|
4737 received. I.e. before returning from the received command and
|
|
7
|
4738 before calling any commands that waits for input.
|
|
|
4739 See also |clientserver|.
|
|
|
4740 Example: >
|
|
|
4741 :echo server2client(expand("<client>"), "HELLO")
|
|
|
4742 <
|
|
|
4743 serverlist() *serverlist()*
|
|
|
4744 Return a list of available server names, one per line.
|
|
|
4745 When there are no servers or the information is not available
|
|
|
4746 an empty string is returned. See also |clientserver|.
|
|
|
4747 {only available when compiled with the |+clientserver| feature}
|
|
|
4748 Example: >
|
|
|
4749 :echo serverlist()
|
|
|
4750 <
|
|
|
4751 setbufvar({expr}, {varname}, {val}) *setbufvar()*
|
|
|
4752 Set option or local variable {varname} in buffer {expr} to
|
|
|
4753 {val}.
|
|
|
4754 This also works for a global or local window option, but it
|
|
|
4755 doesn't work for a global or local window variable.
|
|
|
4756 For a local window option the global value is unchanged.
|
|
|
4757 For the use of {expr}, see |bufname()| above.
|
|
|
4758 Note that the variable name without "b:" must be used.
|
|
|
4759 Examples: >
|
|
|
4760 :call setbufvar(1, "&mod", 1)
|
|
|
4761 :call setbufvar("todo", "myvar", "foobar")
|
|
|
4762 < This function is not available in the |sandbox|.
|
|
|
4763
|
|
|
4764 setcmdpos({pos}) *setcmdpos()*
|
|
|
4765 Set the cursor position in the command line to byte position
|
|
1621
|
4766 {pos}. The first position is 1.
|
|
7
|
4767 Use |getcmdpos()| to obtain the current position.
|
|
|
4768 Only works while editing the command line, thus you must use
|
|
99
|
4769 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
|
|
|
4770 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
|
|
|
4771 set after the command line is set to the expression. For
|
|
|
4772 |c_CTRL-R_=| it is set after evaluating the expression but
|
|
|
4773 before inserting the resulting text.
|
|
7
|
4774 When the number is too big the cursor is put at the end of the
|
|
|
4775 line. A number smaller than one has undefined results.
|
|
|
4776 Returns 0 when successful, 1 when not editing the command
|
|
|
4777 line.
|
|
|
4778
|
|
1621
|
4779 setline({lnum}, {text}) *setline()*
|
|
|
4780 Set line {lnum} of the current buffer to {text}.
|
|
236
|
4781 {lnum} is used like with |getline()|.
|
|
1621
|
4782 When {lnum} is just below the last line the {text} will be
|
|
282
|
4783 added as a new line.
|
|
236
|
4784 If this succeeds, 0 is returned. If this fails (most likely
|
|
|
4785 because {lnum} is invalid) 1 is returned. Example: >
|
|
7
|
4786 :call setline(5, strftime("%c"))
|
|
1621
|
4787 < When {text} is a |List| then line {lnum} and following lines
|
|
282
|
4788 will be set to the items in the list. Example: >
|
|
|
4789 :call setline(5, ['aaa', 'bbb', 'ccc'])
|
|
|
4790 < This is equivalent to: >
|
|
|
4791 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']]
|
|
|
4792 : call setline(n, l)
|
|
|
4793 :endfor
|
|
7
|
4794 < Note: The '[ and '] marks are not set.
|
|
|
4795
|
|
647
|
4796 setloclist({nr}, {list} [, {action}]) *setloclist()*
|
|
|
4797 Create or replace or add to the location list for window {nr}.
|
|
|
4798 When {nr} is zero the current window is used. For a location
|
|
648
|
4799 list window, the displayed location list is modified. For an
|
|
|
4800 invalid window number {nr}, -1 is returned.
|
|
1326
|
4801 Otherwise, same as |setqflist()|.
|
|
|
4802 Also see |location-list|.
|
|
|
4803
|
|
|
4804 setmatches({list}) *setmatches()*
|
|
|
4805 Restores a list of matches saved by |getmatches()|. Returns 0
|
|
1621
|
4806 if successful, otherwise -1. All current matches are cleared
|
|
1326
|
4807 before the list is restored. See example for |getmatches()|.
|
|
230
|
4808
|
|
707
|
4809 *setpos()*
|
|
|
4810 setpos({expr}, {list})
|
|
|
4811 Set the position for {expr}. Possible values:
|
|
|
4812 . the cursor
|
|
|
4813 'x mark x
|
|
|
4814
|
|
|
4815 {list} must be a |List| with four numbers:
|
|
|
4816 [bufnum, lnum, col, off]
|
|
|
4817
|
|
1621
|
4818 "bufnum" is the buffer number. Zero can be used for the
|
|
856
|
4819 current buffer. Setting the cursor is only possible for
|
|
707
|
4820 the current buffer. To set a mark in another buffer you can
|
|
|
4821 use the |bufnr()| function to turn a file name into a buffer
|
|
|
4822 number.
|
|
798
|
4823 Does not change the jumplist.
|
|
707
|
4824
|
|
|
4825 "lnum" and "col" are the position in the buffer. The first
|
|
|
4826 column is 1. Use a zero "lnum" to delete a mark.
|
|
|
4827
|
|
|
4828 The "off" number is only used when 'virtualedit' is set. Then
|
|
|
4829 it is the offset in screen columns from the start of the
|
|
1266
|
4830 character. E.g., a position within a <Tab> or after the last
|
|
707
|
4831 character.
|
|
|
4832
|
|
1533
|
4833 Returns 0 when the position could be set, -1 otherwise.
|
|
|
4834 An error message is given if {expr} is invalid.
|
|
|
4835
|
|
707
|
4836 Also see |getpos()|
|
|
|
4837
|
|
1156
|
4838 This does not restore the preferred column for moving
|
|
|
4839 vertically. See |winrestview()| for that.
|
|
|
4840
|
|
707
|
4841
|
|
277
|
4842 setqflist({list} [, {action}]) *setqflist()*
|
|
647
|
4843 Create or replace or add to the quickfix list using the items
|
|
|
4844 in {list}. Each item in {list} is a dictionary.
|
|
|
4845 Non-dictionary items in {list} are ignored. Each dictionary
|
|
|
4846 item can contain the following entries:
|
|
230
|
4847
|
|
1065
|
4848 bufnr buffer number; must be the number of a valid
|
|
1621
|
4849 buffer
|
|
1065
|
4850 filename name of a file; only used when "bufnr" is not
|
|
1621
|
4851 present or it is invalid.
|
|
230
|
4852 lnum line number in the file
|
|
233
|
4853 pattern search pattern used to locate the error
|
|
230
|
4854 col column number
|
|
233
|
4855 vcol when non-zero: "col" is visual column
|
|
856
|
4856 when zero: "col" is byte index
|
|
233
|
4857 nr error number
|
|
230
|
4858 text description of the error
|
|
233
|
4859 type single-character error type, 'E', 'W', etc.
|
|
|
4860
|
|
|
4861 The "col", "vcol", "nr", "type" and "text" entries are
|
|
|
4862 optional. Either "lnum" or "pattern" entry can be used to
|
|
|
4863 locate a matching error line.
|
|
1065
|
4864 If the "filename" and "bufnr" entries are not present or
|
|
|
4865 neither the "lnum" or "pattern" entries are present, then the
|
|
|
4866 item will not be handled as an error line.
|
|
230
|
4867 If both "pattern" and "lnum" are present then "pattern" will
|
|
|
4868 be used.
|
|
1065
|
4869 Note that the list is not exactly the same as what
|
|
|
4870 |getqflist()| returns.
|
|
230
|
4871
|
|
277
|
4872 If {action} is set to 'a', then the items from {list} are
|
|
|
4873 added to the existing quickfix list. If there is no existing
|
|
|
4874 list, then a new list is created. If {action} is set to 'r',
|
|
|
4875 then the items from the current quickfix list are replaced
|
|
|
4876 with the items from {list}. If {action} is not present or is
|
|
|
4877 set to ' ', then a new list is created.
|
|
|
4878
|
|
230
|
4879 Returns zero for success, -1 for failure.
|
|
|
4880
|
|
|
4881 This function can be used to create a quickfix list
|
|
|
4882 independent of the 'errorformat' setting. Use a command like
|
|
|
4883 ":cc 1" to jump to the first position.
|
|
|
4884
|
|
|
4885
|
|
7
|
4886 *setreg()*
|
|
|
4887 setreg({regname}, {value} [,{options}])
|
|
|
4888 Set the register {regname} to {value}.
|
|
|
4889 If {options} contains "a" or {regname} is upper case,
|
|
|
4890 then the value is appended.
|
|
|
4891 {options} can also contains a register type specification:
|
|
|
4892 "c" or "v" |characterwise| mode
|
|
|
4893 "l" or "V" |linewise| mode
|
|
|
4894 "b" or "<CTRL-V>" |blockwise-visual| mode
|
|
|
4895 If a number immediately follows "b" or "<CTRL-V>" then this is
|
|
|
4896 used as the width of the selection - if it is not specified
|
|
|
4897 then the width of the block is set to the number of characters
|
|
1266
|
4898 in the longest line (counting a <Tab> as 1 character).
|
|
7
|
4899
|
|
|
4900 If {options} contains no register settings, then the default
|
|
|
4901 is to use character mode unless {value} ends in a <NL>.
|
|
|
4902 Setting the '=' register is not possible.
|
|
|
4903 Returns zero for success, non-zero for failure.
|
|
|
4904
|
|
|
4905 Examples: >
|
|
|
4906 :call setreg(v:register, @*)
|
|
|
4907 :call setreg('*', @%, 'ac')
|
|
|
4908 :call setreg('a', "1\n2\n3", 'b5')
|
|
|
4909
|
|
|
4910 < This example shows using the functions to save and restore a
|
|
|
4911 register. >
|
|
282
|
4912 :let var_a = getreg('a', 1)
|
|
7
|
4913 :let var_amode = getregtype('a')
|
|
|
4914 ....
|
|
|
4915 :call setreg('a', var_a, var_amode)
|
|
|
4916
|
|
|
4917 < You can also change the type of a register by appending
|
|
|
4918 nothing: >
|
|
|
4919 :call setreg('a', '', 'al')
|
|
|
4920
|
|
831
|
4921 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
|
|
|
4922 Set option or local variable {varname} in window {winnr} to
|
|
|
4923 {val}.
|
|
|
4924 Tabs are numbered starting with one. For the current tabpage
|
|
|
4925 use |setwinvar()|.
|
|
|
4926 When {winnr} is zero the current window is used.
|
|
7
|
4927 This also works for a global or local buffer option, but it
|
|
|
4928 doesn't work for a global or local buffer variable.
|
|
|
4929 For a local buffer option the global value is unchanged.
|
|
|
4930 Note that the variable name without "w:" must be used.
|
|
831
|
4931 Vim briefly goes to the tab page {tabnr}, this may trigger
|
|
|
4932 TabLeave and TabEnter autocommands.
|
|
|
4933 Examples: >
|
|
|
4934 :call settabwinvar(1, 1, "&list", 0)
|
|
|
4935 :call settabwinvar(3, 2, "myvar", "foobar")
|
|
|
4936 < This function is not available in the |sandbox|.
|
|
|
4937
|
|
|
4938 setwinvar({nr}, {varname}, {val}) *setwinvar()*
|
|
|
4939 Like |settabwinvar()| for the current tab page.
|
|
7
|
4940 Examples: >
|
|
|
4941 :call setwinvar(1, "&list", 0)
|
|
|
4942 :call setwinvar(2, "myvar", "foobar")
|
|
|
4943
|
|
985
|
4944 shellescape({string}) *shellescape()*
|
|
|
4945 Escape {string} for use as shell command argument.
|
|
|
4946 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
|
|
|
4947 will enclose {string} double quotes and double all double
|
|
|
4948 quotes within {string}.
|
|
|
4949 For other systems, it will enclose {string} in single quotes
|
|
|
4950 and replace all "'" with "'\''".
|
|
|
4951 Example: >
|
|
|
4952 :echo shellescape('c:\program files\vim')
|
|
|
4953 < results in:
|
|
|
4954 "c:\program files\vim" ~
|
|
|
4955 Example usage: >
|
|
|
4956 :call system("chmod +x -- " . shellescape(expand("%")))
|
|
|
4957
|
|
|
4958
|
|
7
|
4959 simplify({filename}) *simplify()*
|
|
|
4960 Simplify the file name as much as possible without changing
|
|
|
4961 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
|
|
|
4962 Unix) are not resolved. If the first path component in
|
|
|
4963 {filename} designates the current directory, this will be
|
|
|
4964 valid for the result as well. A trailing path separator is
|
|
|
4965 not removed either.
|
|
|
4966 Example: >
|
|
|
4967 simplify("./dir/.././/file/") == "./file/"
|
|
|
4968 < Note: The combination "dir/.." is only removed if "dir" is
|
|
|
4969 a searchable directory or does not exist. On Unix, it is also
|
|
|
4970 removed when "dir" is a symbolic link within the same
|
|
|
4971 directory. In order to resolve all the involved symbolic
|
|
|
4972 links before simplifying the path name, use |resolve()|.
|
|
|
4973
|
|
82
|
4974
|
|
1621
|
4975 sin({expr}) *sin()*
|
|
|
4976 Return the sine of {expr}, measured in radians, as a |Float|.
|
|
|
4977 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
4978 Examples: >
|
|
|
4979 :echo sin(100)
|
|
|
4980 < -0.506366 >
|
|
|
4981 :echo sin(-4.01)
|
|
|
4982 < 0.763301
|
|
|
4983 {only available when compiled with the |+float| feature}
|
|
|
4984
|
|
|
4985
|
|
85
|
4986 sort({list} [, {func}]) *sort()* *E702*
|
|
82
|
4987 Sort the items in {list} in-place. Returns {list}. If you
|
|
|
4988 want a list to remain unmodified make a copy first: >
|
|
|
4989 :let sortedlist = sort(copy(mylist))
|
|
|
4990 < Uses the string representation of each item to sort on.
|
|
692
|
4991 Numbers sort after Strings, |Lists| after Numbers.
|
|
282
|
4992 For sorting text in the current buffer use |:sort|.
|
|
82
|
4993 When {func} is given and it is one then case is ignored.
|
|
685
|
4994 When {func} is a |Funcref| or a function name, this function
|
|
|
4995 is called to compare items. The function is invoked with two
|
|
82
|
4996 items as argument and must return zero if they are equal, 1 if
|
|
|
4997 the first one sorts after the second one, -1 if the first one
|
|
|
4998 sorts before the second one. Example: >
|
|
|
4999 func MyCompare(i1, i2)
|
|
|
5000 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
|
|
|
5001 endfunc
|
|
|
5002 let sortedlist = sort(mylist, "MyCompare")
|
|
344
|
5003 <
|
|
|
5004
|
|
374
|
5005 *soundfold()*
|
|
|
5006 soundfold({word})
|
|
|
5007 Return the sound-folded equivalent of {word}. Uses the first
|
|
1621
|
5008 language in 'spelllang' for the current window that supports
|
|
375
|
5009 soundfolding. 'spell' must be set. When no sound folding is
|
|
|
5010 possible the {word} is returned unmodified.
|
|
374
|
5011 This can be used for making spelling suggestions. Note that
|
|
|
5012 the method can be quite slow.
|
|
|
5013
|
|
344
|
5014 *spellbadword()*
|
|
532
|
5015 spellbadword([{sentence}])
|
|
|
5016 Without argument: The result is the badly spelled word under
|
|
|
5017 or after the cursor. The cursor is moved to the start of the
|
|
|
5018 bad word. When no bad word is found in the cursor line the
|
|
|
5019 result is an empty string and the cursor doesn't move.
|
|
|
5020
|
|
|
5021 With argument: The result is the first word in {sentence} that
|
|
|
5022 is badly spelled. If there are no spelling mistakes the
|
|
|
5023 result is an empty string.
|
|
|
5024
|
|
|
5025 The return value is a list with two items:
|
|
|
5026 - The badly spelled word or an empty string.
|
|
|
5027 - The type of the spelling error:
|
|
856
|
5028 "bad" spelling mistake
|
|
532
|
5029 "rare" rare word
|
|
|
5030 "local" word only valid in another region
|
|
|
5031 "caps" word should start with Capital
|
|
|
5032 Example: >
|
|
|
5033 echo spellbadword("the quik brown fox")
|
|
|
5034 < ['quik', 'bad'] ~
|
|
|
5035
|
|
|
5036 The spelling information for the current window is used. The
|
|
|
5037 'spell' option must be set and the value of 'spelllang' is
|
|
|
5038 used.
|
|
344
|
5039
|
|
|
5040 *spellsuggest()*
|
|
537
|
5041 spellsuggest({word} [, {max} [, {capital}]])
|
|
685
|
5042 Return a |List| with spelling suggestions to replace {word}.
|
|
344
|
5043 When {max} is given up to this number of suggestions are
|
|
|
5044 returned. Otherwise up to 25 suggestions are returned.
|
|
|
5045
|
|
537
|
5046 When the {capital} argument is given and it's non-zero only
|
|
|
5047 suggestions with a leading capital will be given. Use this
|
|
|
5048 after a match with 'spellcapcheck'.
|
|
|
5049
|
|
344
|
5050 {word} can be a badly spelled word followed by other text.
|
|
|
5051 This allows for joining two words that were split. The
|
|
359
|
5052 suggestions also include the following text, thus you can
|
|
|
5053 replace a line.
|
|
|
5054
|
|
|
5055 {word} may also be a good word. Similar words will then be
|
|
537
|
5056 returned. {word} itself is not included in the suggestions,
|
|
|
5057 although it may appear capitalized.
|
|
344
|
5058
|
|
|
5059 The spelling information for the current window is used. The
|
|
375
|
5060 'spell' option must be set and the values of 'spelllang' and
|
|
|
5061 'spellsuggest' are used.
|
|
344
|
5062
|
|
82
|
5063
|
|
282
|
5064 split({expr} [, {pattern} [, {keepempty}]]) *split()*
|
|
685
|
5065 Make a |List| out of {expr}. When {pattern} is omitted or
|
|
|
5066 empty each white-separated sequence of characters becomes an
|
|
|
5067 item.
|
|
82
|
5068 Otherwise the string is split where {pattern} matches,
|
|
282
|
5069 removing the matched characters.
|
|
|
5070 When the first or last item is empty it is omitted, unless the
|
|
|
5071 {keepempty} argument is given and it's non-zero.
|
|
293
|
5072 Other empty items are kept when {pattern} matches at least one
|
|
|
5073 character or when {keepempty} is non-zero.
|
|
82
|
5074 Example: >
|
|
95
|
5075 :let words = split(getline('.'), '\W\+')
|
|
282
|
5076 < To split a string in individual characters: >
|
|
236
|
5077 :for c in split(mystring, '\zs')
|
|
258
|
5078 < If you want to keep the separator you can also use '\zs': >
|
|
|
5079 :echo split('abc:def:ghi', ':\zs')
|
|
|
5080 < ['abc:', 'def:', 'ghi'] ~
|
|
282
|
5081 Splitting a table where the first element can be empty: >
|
|
|
5082 :let items = split(line, ':', 1)
|
|
|
5083 < The opposite function is |join()|.
|
|
82
|
5084
|
|
|
5085
|
|
1621
|
5086 sqrt({expr}) *sqrt()*
|
|
|
5087 Return the non-negative square root of Float {expr} as a
|
|
|
5088 |Float|.
|
|
|
5089 {expr} must evaluate to a |Float| or a |Number|. When {expr}
|
|
|
5090 is negative the result is NaN (Not a Number).
|
|
|
5091 Examples: >
|
|
|
5092 :echo sqrt(100)
|
|
|
5093 < 10.0 >
|
|
|
5094 :echo sqrt(-4.01)
|
|
|
5095 < nan
|
|
|
5096 {only available when compiled with the |+float| feature}
|
|
|
5097
|
|
|
5098
|
|
|
5099 str2float( {expr}) *str2float()*
|
|
|
5100 Convert String {expr} to a Float. This mostly works the same
|
|
|
5101 as when using a floating point number in an expression, see
|
|
|
5102 |floating-point-format|. But it's a bit more permissive.
|
|
|
5103 E.g., "1e40" is accepted, while in an expression you need to
|
|
|
5104 write "1.0e40".
|
|
|
5105 Text after the number is silently ignored.
|
|
|
5106 The decimal point is always '.', no matter what the locale is
|
|
|
5107 set to. A comma ends the number: "12,345.67" is converted to
|
|
|
5108 12.0. You can strip out thousands separators with
|
|
|
5109 |substitute()|: >
|
|
|
5110 let f = str2float(substitute(text, ',', '', 'g'))
|
|
|
5111 < {only available when compiled with the |+float| feature}
|
|
|
5112
|
|
|
5113
|
|
782
|
5114 str2nr( {expr} [, {base}]) *str2nr()*
|
|
|
5115 Convert string {expr} to a number.
|
|
|
5116 {base} is the conversion base, it can be 8, 10 or 16.
|
|
|
5117 When {base} is omitted base 10 is used. This also means that
|
|
|
5118 a leading zero doesn't cause octal conversion to be used, as
|
|
|
5119 with the default String to Number conversion.
|
|
|
5120 When {base} is 16 a leading "0x" or "0X" is ignored. With a
|
|
|
5121 different base the result will be zero.
|
|
|
5122 Text after the number is silently ignored.
|
|
856
|
5123
|
|
782
|
5124
|
|
7
|
5125 strftime({format} [, {time}]) *strftime()*
|
|
|
5126 The result is a String, which is a formatted date and time, as
|
|
|
5127 specified by the {format} string. The given {time} is used,
|
|
|
5128 or the current time if no time is given. The accepted
|
|
|
5129 {format} depends on your system, thus this is not portable!
|
|
|
5130 See the manual page of the C function strftime() for the
|
|
|
5131 format. The maximum length of the result is 80 characters.
|
|
|
5132 See also |localtime()| and |getftime()|.
|
|
|
5133 The language can be changed with the |:language| command.
|
|
|
5134 Examples: >
|
|
|
5135 :echo strftime("%c") Sun Apr 27 11:49:23 1997
|
|
|
5136 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
|
|
|
5137 :echo strftime("%y%m%d %T") 970427 11:53:55
|
|
|
5138 :echo strftime("%H:%M") 11:55
|
|
|
5139 :echo strftime("%c", getftime("file.c"))
|
|
|
5140 Show mod time of file.c.
|
|
82
|
5141 < Not available on all systems. To check use: >
|
|
|
5142 :if exists("*strftime")
|
|
|
5143
|
|
133
|
5144 stridx({haystack}, {needle} [, {start}]) *stridx()*
|
|
|
5145 The result is a Number, which gives the byte index in
|
|
|
5146 {haystack} of the first occurrence of the String {needle}.
|
|
140
|
5147 If {start} is specified, the search starts at index {start}.
|
|
|
5148 This can be used to find a second match: >
|
|
|
5149 :let comma1 = stridx(line, ",")
|
|
|
5150 :let comma2 = stridx(line, ",", comma1 + 1)
|
|
|
5151 < The search is done case-sensitive.
|
|
205
|
5152 For pattern searches use |match()|.
|
|
133
|
5153 -1 is returned if the {needle} does not occur in {haystack}.
|
|
140
|
5154 See also |strridx()|.
|
|
|
5155 Examples: >
|
|
7
|
5156 :echo stridx("An Example", "Example") 3
|
|
|
5157 :echo stridx("Starting point", "Start") 0
|
|
|
5158 :echo stridx("Starting point", "start") -1
|
|
856
|
5159 < *strstr()* *strchr()*
|
|
170
|
5160 stridx() works similar to the C function strstr(). When used
|
|
|
5161 with a single character it works similar to strchr().
|
|
|
5162
|
|
55
|
5163 *string()*
|
|
95
|
5164 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
|
|
1621
|
5165 Float, String or a composition of them, then the result can be
|
|
|
5166 parsed back with |eval()|.
|
|
55
|
5167 {expr} type result ~
|
|
99
|
5168 String 'string'
|
|
95
|
5169 Number 123
|
|
1621
|
5170 Float 123.123456 or 1.123456e8
|
|
99
|
5171 Funcref function('name')
|
|
95
|
5172 List [item, item]
|
|
323
|
5173 Dictionary {key: value, key: value}
|
|
99
|
5174 Note that in String values the ' character is doubled.
|
|
1156
|
5175 Also see |strtrans()|.
|
|
55
|
5176
|
|
7
|
5177 *strlen()*
|
|
|
5178 strlen({expr}) The result is a Number, which is the length of the String
|
|
502
|
5179 {expr} in bytes.
|
|
|
5180 If you want to count the number of multi-byte characters (not
|
|
|
5181 counting composing characters) use something like this: >
|
|
7
|
5182
|
|
|
5183 :let len = strlen(substitute(str, ".", "x", "g"))
|
|
502
|
5184 <
|
|
55
|
5185 If the argument is a Number it is first converted to a String.
|
|
|
5186 For other types an error is given.
|
|
|
5187 Also see |len()|.
|
|
7
|
5188
|
|
|
5189 strpart({src}, {start}[, {len}]) *strpart()*
|
|
|
5190 The result is a String, which is part of {src}, starting from
|
|
574
|
5191 byte {start}, with the byte length {len}.
|
|
7
|
5192 When non-existing bytes are included, this doesn't result in
|
|
|
5193 an error, the bytes are simply omitted.
|
|
|
5194 If {len} is missing, the copy continues from {start} till the
|
|
|
5195 end of the {src}. >
|
|
|
5196 strpart("abcdefg", 3, 2) == "de"
|
|
|
5197 strpart("abcdefg", -2, 4) == "ab"
|
|
|
5198 strpart("abcdefg", 5, 4) == "fg"
|
|
1621
|
5199 strpart("abcdefg", 3) == "defg"
|
|
7
|
5200 < Note: To get the first character, {start} must be 0. For
|
|
|
5201 example, to get three bytes under and after the cursor: >
|
|
823
|
5202 strpart(getline("."), col(".") - 1, 3)
|
|
7
|
5203 <
|
|
140
|
5204 strridx({haystack}, {needle} [, {start}]) *strridx()*
|
|
|
5205 The result is a Number, which gives the byte index in
|
|
|
5206 {haystack} of the last occurrence of the String {needle}.
|
|
|
5207 When {start} is specified, matches beyond this index are
|
|
|
5208 ignored. This can be used to find a match before a previous
|
|
|
5209 match: >
|
|
|
5210 :let lastcomma = strridx(line, ",")
|
|
|
5211 :let comma2 = strridx(line, ",", lastcomma - 1)
|
|
|
5212 < The search is done case-sensitive.
|
|
133
|
5213 For pattern searches use |match()|.
|
|
|
5214 -1 is returned if the {needle} does not occur in {haystack}.
|
|
22
|
5215 If the {needle} is empty the length of {haystack} is returned.
|
|
236
|
5216 See also |stridx()|. Examples: >
|
|
7
|
5217 :echo strridx("an angry armadillo", "an") 3
|
|
856
|
5218 < *strrchr()*
|
|
170
|
5219 When used with a single character it works similar to the C
|
|
|
5220 function strrchr().
|
|
|
5221
|
|
7
|
5222 strtrans({expr}) *strtrans()*
|
|
|
5223 The result is a String, which is {expr} with all unprintable
|
|
|
5224 characters translated into printable characters |'isprint'|.
|
|
|
5225 Like they are shown in a window. Example: >
|
|
|
5226 echo strtrans(@a)
|
|
|
5227 < This displays a newline in register a as "^@" instead of
|
|
|
5228 starting a new line.
|
|
|
5229
|
|
|
5230 submatch({nr}) *submatch()*
|
|
|
5231 Only for an expression in a |:substitute| command. Returns
|
|
|
5232 the {nr}'th submatch of the matched text. When {nr} is 0
|
|
|
5233 the whole matched text is returned.
|
|
|
5234 Example: >
|
|
|
5235 :s/\d\+/\=submatch(0) + 1/
|
|
|
5236 < This finds the first number in the line and adds one to it.
|
|
|
5237 A line break is included as a newline character.
|
|
|
5238
|
|
|
5239 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
|
|
|
5240 The result is a String, which is a copy of {expr}, in which
|
|
|
5241 the first match of {pat} is replaced with {sub}. This works
|
|
|
5242 like the ":substitute" command (without any flags). But the
|
|
|
5243 matching with {pat} is always done like the 'magic' option is
|
|
|
5244 set and 'cpoptions' is empty (to make scripts portable).
|
|
1156
|
5245 'ignorecase' is still relevant. 'smartcase' is not used.
|
|
7
|
5246 See |string-match| for how {pat} is used.
|
|
|
5247 And a "~" in {sub} is not replaced with the previous {sub}.
|
|
|
5248 Note that some codes in {sub} have a special meaning
|
|
1621
|
5249 |sub-replace-special|. For example, to replace something with
|
|
7
|
5250 "\n" (two characters), use "\\\\n" or '\\n'.
|
|
|
5251 When {pat} does not match in {expr}, {expr} is returned
|
|
|
5252 unmodified.
|
|
|
5253 When {flags} is "g", all matches of {pat} in {expr} are
|
|
|
5254 replaced. Otherwise {flags} should be "".
|
|
|
5255 Example: >
|
|
|
5256 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
|
|
|
5257 < This removes the last component of the 'path' option. >
|
|
|
5258 :echo substitute("testing", ".*", "\\U\\0", "")
|
|
|
5259 < results in "TESTING".
|
|
|
5260
|
|
32
|
5261 synID({lnum}, {col}, {trans}) *synID()*
|
|
7
|
5262 The result is a Number, which is the syntax ID at the position
|
|
32
|
5263 {lnum} and {col} in the current window.
|
|
7
|
5264 The syntax ID can be used with |synIDattr()| and
|
|
|
5265 |synIDtrans()| to obtain syntax information about text.
|
|
419
|
5266
|
|
32
|
5267 {col} is 1 for the leftmost column, {lnum} is 1 for the first
|
|
419
|
5268 line. 'synmaxcol' applies, in a longer line zero is returned.
|
|
|
5269
|
|
7
|
5270 When {trans} is non-zero, transparent items are reduced to the
|
|
1621
|
5271 item that they reveal. This is useful when wanting to know
|
|
7
|
5272 the effective color. When {trans} is zero, the transparent
|
|
|
5273 item is returned. This is useful when wanting to know which
|
|
|
5274 syntax item is effective (e.g. inside parens).
|
|
|
5275 Warning: This function can be very slow. Best speed is
|
|
|
5276 obtained by going through the file in forward direction.
|
|
|
5277
|
|
|
5278 Example (echoes the name of the syntax item under the cursor): >
|
|
|
5279 :echo synIDattr(synID(line("."), col("."), 1), "name")
|
|
|
5280 <
|
|
|
5281 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
|
|
|
5282 The result is a String, which is the {what} attribute of
|
|
|
5283 syntax ID {synID}. This can be used to obtain information
|
|
|
5284 about a syntax item.
|
|
|
5285 {mode} can be "gui", "cterm" or "term", to get the attributes
|
|
1621
|
5286 for that mode. When {mode} is omitted, or an invalid value is
|
|
7
|
5287 used, the attributes for the currently active highlighting are
|
|
|
5288 used (GUI, cterm or term).
|
|
|
5289 Use synIDtrans() to follow linked highlight groups.
|
|
|
5290 {what} result
|
|
|
5291 "name" the name of the syntax item
|
|
|
5292 "fg" foreground color (GUI: color name used to set
|
|
|
5293 the color, cterm: color number as a string,
|
|
|
5294 term: empty string)
|
|
|
5295 "bg" background color (like "fg")
|
|
|
5296 "fg#" like "fg", but for the GUI and the GUI is
|
|
|
5297 running the name in "#RRGGBB" form
|
|
|
5298 "bg#" like "fg#" for "bg"
|
|
|
5299 "bold" "1" if bold
|
|
|
5300 "italic" "1" if italic
|
|
|
5301 "reverse" "1" if reverse
|
|
|
5302 "inverse" "1" if inverse (= reverse)
|
|
|
5303 "underline" "1" if underlined
|
|
205
|
5304 "undercurl" "1" if undercurled
|
|
7
|
5305
|
|
|
5306 Example (echoes the color of the syntax item under the
|
|
|
5307 cursor): >
|
|
|
5308 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
|
|
|
5309 <
|
|
|
5310 synIDtrans({synID}) *synIDtrans()*
|
|
|
5311 The result is a Number, which is the translated syntax ID of
|
|
|
5312 {synID}. This is the syntax group ID of what is being used to
|
|
|
5313 highlight the character. Highlight links given with
|
|
|
5314 ":highlight link" are followed.
|
|
|
5315
|
|
1500
|
5316 synstack({lnum}, {col}) *synstack()*
|
|
|
5317 Return a |List|, which is the stack of syntax items at the
|
|
|
5318 position {lnum} and {col} in the current window. Each item in
|
|
|
5319 the List is an ID like what |synID()| returns.
|
|
|
5320 The first item in the List is the outer region, following are
|
|
|
5321 items contained in that one. The last one is what |synID()|
|
|
|
5322 returns, unless not the whole item is highlighted or it is a
|
|
|
5323 transparent item.
|
|
|
5324 This function is useful for debugging a syntax file.
|
|
|
5325 Example that shows the syntax stack under the cursor: >
|
|
|
5326 for id in synstack(line("."), col("."))
|
|
|
5327 echo synIDattr(id, "name")
|
|
|
5328 endfor
|
|
|
5329
|
|
24
|
5330 system({expr} [, {input}]) *system()* *E677*
|
|
|
5331 Get the output of the shell command {expr}.
|
|
|
5332 When {input} is given, this string is written to a file and
|
|
|
5333 passed as stdin to the command. The string is written as-is,
|
|
|
5334 you need to take care of using the correct line separators
|
|
170
|
5335 yourself. Pipes are not used.
|
|
24
|
5336 Note: newlines in {expr} may cause the command to fail. The
|
|
|
5337 characters in 'shellquote' and 'shellxquote' may also cause
|
|
|
5338 trouble.
|
|
7
|
5339 This is not to be used for interactive commands.
|
|
|
5340 The result is a String. Example: >
|
|
|
5341
|
|
|
5342 :let files = system("ls")
|
|
|
5343
|
|
|
5344 < To make the result more system-independent, the shell output
|
|
|
5345 is filtered to replace <CR> with <NL> for Macintosh, and
|
|
|
5346 <CR><NL> with <NL> for DOS-like systems.
|
|
|
5347 The command executed is constructed using several options:
|
|
|
5348 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
|
|
|
5349 ({tmp} is an automatically generated file name).
|
|
|
5350 For Unix and OS/2 braces are put around {expr} to allow for
|
|
|
5351 concatenated commands.
|
|
|
5352
|
|
794
|
5353 The command will be executed in "cooked" mode, so that a
|
|
|
5354 CTRL-C will interrupt the command (on Unix at least).
|
|
|
5355
|
|
7
|
5356 The resulting error code can be found in |v:shell_error|.
|
|
|
5357 This function will fail in |restricted-mode|.
|
|
625
|
5358
|
|
|
5359 Note that any wrong value in the options mentioned above may
|
|
|
5360 make the function fail. It has also been reported to fail
|
|
|
5361 when using a security agent application.
|
|
7
|
5362 Unlike ":!cmd" there is no automatic check for changed files.
|
|
|
5363 Use |:checktime| to force a check.
|
|
|
5364
|
|
205
|
5365
|
|
677
|
5366 tabpagebuflist([{arg}]) *tabpagebuflist()*
|
|
685
|
5367 The result is a |List|, where each item is the number of the
|
|
677
|
5368 buffer associated with each window in the current tab page.
|
|
|
5369 {arg} specifies the number of tab page to be used. When
|
|
|
5370 omitted the current tab page is used.
|
|
|
5371 When {arg} is invalid the number zero is returned.
|
|
|
5372 To get a list of all buffers in all tabs use this: >
|
|
|
5373 tablist = []
|
|
|
5374 for i in range(tabpagenr('$'))
|
|
|
5375 call extend(tablist, tabpagebuflist(i + 1))
|
|
|
5376 endfor
|
|
|
5377 < Note that a buffer may appear in more than one window.
|
|
|
5378
|
|
|
5379
|
|
|
5380 tabpagenr([{arg}]) *tabpagenr()*
|
|
674
|
5381 The result is a Number, which is the number of the current
|
|
|
5382 tab page. The first tab page has number 1.
|
|
|
5383 When the optional argument is "$", the number of the last tab
|
|
|
5384 page is returned (the tab page count).
|
|
|
5385 The number can be used with the |:tab| command.
|
|
|
5386
|
|
|
5387
|
|
677
|
5388 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()*
|
|
|
5389 Like |winnr()| but for tab page {arg}.
|
|
|
5390 {tabarg} specifies the number of tab page to be used.
|
|
|
5391 {arg} is used like with |winnr()|:
|
|
|
5392 - When omitted the current window number is returned. This is
|
|
|
5393 the window which will be used when going to this tab page.
|
|
|
5394 - When "$" the number of windows is returned.
|
|
|
5395 - When "#" the previous window nr is returned.
|
|
|
5396 Useful examples: >
|
|
|
5397 tabpagewinnr(1) " current window of tab page 1
|
|
|
5398 tabpagewinnr(4, '$') " number of windows in tab page 4
|
|
|
5399 < When {tabarg} is invalid zero is returned.
|
|
|
5400
|
|
805
|
5401 *tagfiles()*
|
|
|
5402 tagfiles() Returns a |List| with the file names used to search for tags
|
|
|
5403 for the current buffer. This is the 'tags' option expanded.
|
|
|
5404
|
|
|
5405
|
|
205
|
5406 taglist({expr}) *taglist()*
|
|
|
5407 Returns a list of tags matching the regular expression {expr}.
|
|
438
|
5408 Each list item is a dictionary with at least the following
|
|
|
5409 entries:
|
|
648
|
5410 name Name of the tag.
|
|
|
5411 filename Name of the file where the tag is
|
|
1156
|
5412 defined. It is either relative to the
|
|
|
5413 current directory or a full path.
|
|
205
|
5414 cmd Ex command used to locate the tag in
|
|
|
5415 the file.
|
|
648
|
5416 kind Type of the tag. The value for this
|
|
205
|
5417 entry depends on the language specific
|
|
1156
|
5418 kind values. Only available when
|
|
|
5419 using a tags file generated by
|
|
|
5420 Exuberant ctags or hdrtag.
|
|
648
|
5421 static A file specific tag. Refer to
|
|
205
|
5422 |static-tag| for more information.
|
|
1156
|
5423 More entries may be present, depending on the content of the
|
|
|
5424 tags file: access, implementation, inherits and signature.
|
|
|
5425 Refer to the ctags documentation for information about these
|
|
|
5426 fields. For C code the fields "struct", "class" and "enum"
|
|
|
5427 may appear, they give the name of the entity the tag is
|
|
|
5428 contained in.
|
|
452
|
5429
|
|
216
|
5430 The ex-command 'cmd' can be either an ex search pattern, a
|
|
|
5431 line number or a line number followed by a byte number.
|
|
205
|
5432
|
|
|
5433 If there are no matching tags, then an empty list is returned.
|
|
|
5434
|
|
|
5435 To get an exact tag match, the anchors '^' and '$' should be
|
|
|
5436 used in {expr}. Refer to |tag-regexp| for more information
|
|
|
5437 about the tag search regular expression pattern.
|
|
|
5438
|
|
|
5439 Refer to |'tags'| for information about how the tags file is
|
|
|
5440 located by Vim. Refer to |tags-file-format| for the format of
|
|
|
5441 the tags file generated by the different ctags tools.
|
|
|
5442
|
|
7
|
5443 tempname() *tempname()* *temp-file-name*
|
|
|
5444 The result is a String, which is the name of a file that
|
|
1621
|
5445 doesn't exist. It can be used for a temporary file. The name
|
|
7
|
5446 is different for at least 26 consecutive calls. Example: >
|
|
|
5447 :let tmpfile = tempname()
|
|
|
5448 :exe "redir > " . tmpfile
|
|
|
5449 < For Unix, the file will be in a private directory (only
|
|
|
5450 accessible by the current user) to avoid security problems
|
|
|
5451 (e.g., a symlink attack or other people reading your file).
|
|
|
5452 When Vim exits the directory and all files in it are deleted.
|
|
|
5453 For MS-Windows forward slashes are used when the 'shellslash'
|
|
|
5454 option is set or when 'shellcmdflag' starts with '-'.
|
|
|
5455
|
|
|
5456 tolower({expr}) *tolower()*
|
|
|
5457 The result is a copy of the String given, with all uppercase
|
|
|
5458 characters turned into lowercase (just like applying |gu| to
|
|
|
5459 the string).
|
|
|
5460
|
|
|
5461 toupper({expr}) *toupper()*
|
|
|
5462 The result is a copy of the String given, with all lowercase
|
|
|
5463 characters turned into uppercase (just like applying |gU| to
|
|
|
5464 the string).
|
|
|
5465
|
|
15
|
5466 tr({src}, {fromstr}, {tostr}) *tr()*
|
|
|
5467 The result is a copy of the {src} string with all characters
|
|
|
5468 which appear in {fromstr} replaced by the character in that
|
|
|
5469 position in the {tostr} string. Thus the first character in
|
|
|
5470 {fromstr} is translated into the first character in {tostr}
|
|
|
5471 and so on. Exactly like the unix "tr" command.
|
|
|
5472 This code also deals with multibyte characters properly.
|
|
|
5473
|
|
|
5474 Examples: >
|
|
|
5475 echo tr("hello there", "ht", "HT")
|
|
|
5476 < returns "Hello THere" >
|
|
|
5477 echo tr("<blob>", "<>", "{}")
|
|
|
5478 < returns "{blob}"
|
|
|
5479
|
|
1621
|
5480 trunc({expr}) *trunc()*
|
|
|
5481 Return the largest integral value with magnituted less than or
|
|
|
5482 equal to {expr} as a |Float| (truncate towards zero).
|
|
|
5483 {expr} must evaluate to a |Float| or a |Number|.
|
|
|
5484 Examples: >
|
|
|
5485 echo trunc(1.456)
|
|
|
5486 < 1.0 >
|
|
|
5487 echo trunc(-5.456)
|
|
|
5488 < -5.0 >
|
|
|
5489 echo trunc(4.0)
|
|
|
5490 < 4.0
|
|
|
5491 {only available when compiled with the |+float| feature}
|
|
|
5492
|
|
87
|
5493 *type()*
|
|
|
5494 type({expr}) The result is a Number, depending on the type of {expr}:
|
|
153
|
5495 Number: 0
|
|
|
5496 String: 1
|
|
|
5497 Funcref: 2
|
|
|
5498 List: 3
|
|
|
5499 Dictionary: 4
|
|
1621
|
5500 Float: 5
|
|
153
|
5501 To avoid the magic numbers it should be used this way: >
|
|
87
|
5502 :if type(myvar) == type(0)
|
|
|
5503 :if type(myvar) == type("")
|
|
|
5504 :if type(myvar) == type(function("tr"))
|
|
|
5505 :if type(myvar) == type([])
|
|
153
|
5506 :if type(myvar) == type({})
|
|
1621
|
5507 :if type(myvar) == type(0.0)
|
|
7
|
5508
|
|
140
|
5509 values({dict}) *values()*
|
|
1621
|
5510 Return a |List| with all the values of {dict}. The |List| is
|
|
685
|
5511 in arbitrary order.
|
|
140
|
5512
|
|
|
5513
|
|
7
|
5514 virtcol({expr}) *virtcol()*
|
|
|
5515 The result is a Number, which is the screen column of the file
|
|
|
5516 position given with {expr}. That is, the last screen position
|
|
|
5517 occupied by the character at that position, when the screen
|
|
|
5518 would be of unlimited width. When there is a <Tab> at the
|
|
|
5519 position, the returned Number will be the column at the end of
|
|
|
5520 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
|
|
|
5521 set to 8, it returns 8.
|
|
1317
|
5522 For the byte position use |col()|.
|
|
|
5523 For the use of {expr} see |col()|.
|
|
|
5524 When 'virtualedit' is used {expr} can be [lnum, col, off], where
|
|
703
|
5525 "off" is the offset in screen columns from the start of the
|
|
1266
|
5526 character. E.g., a position within a <Tab> or after the last
|
|
703
|
5527 character.
|
|
7
|
5528 When Virtual editing is active in the current mode, a position
|
|
|
5529 beyond the end of the line can be returned. |'virtualedit'|
|
|
|
5530 The accepted positions are:
|
|
|
5531 . the cursor position
|
|
|
5532 $ the end of the cursor line (the result is the
|
|
|
5533 number of displayed characters in the cursor line
|
|
|
5534 plus one)
|
|
|
5535 'x position of mark x (if the mark is not set, 0 is
|
|
|
5536 returned)
|
|
|
5537 Note that only marks in the current file can be used.
|
|
|
5538 Examples: >
|
|
|
5539 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
|
|
|
5540 virtcol("$") with text "foo^Lbar", returns 9
|
|
1621
|
5541 virtcol("'t") with text " there", with 't at 'h', returns 6
|
|
|
5542 < The first column is 1. 0 is returned for an error.
|
|
1156
|
5543 A more advanced example that echoes the maximum length of
|
|
|
5544 all lines: >
|
|
|
5545 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
|
|
|
5546
|
|
7
|
5547
|
|
|
5548 visualmode([expr]) *visualmode()*
|
|
|
5549 The result is a String, which describes the last Visual mode
|
|
856
|
5550 used in the current buffer. Initially it returns an empty
|
|
|
5551 string, but once Visual mode has been used, it returns "v",
|
|
|
5552 "V", or "<CTRL-V>" (a single CTRL-V character) for
|
|
|
5553 character-wise, line-wise, or block-wise Visual mode
|
|
|
5554 respectively.
|
|
7
|
5555 Example: >
|
|
|
5556 :exe "normal " . visualmode()
|
|
|
5557 < This enters the same Visual mode as before. It is also useful
|
|
|
5558 in scripts if you wish to act differently depending on the
|
|
|
5559 Visual mode that was used.
|
|
1621
|
5560 If Visual mode is active, use |mode()| to get the Visual mode
|
|
|
5561 (e.g., in a |:vmap|).
|
|
|
5562
|
|
|
5563 If [expr] is supplied and it evaluates to a non-zero number or
|
|
|
5564 a non-empty string, then the Visual mode will be cleared and
|
|
|
5565 the old value is returned. Note that " " and "0" are also
|
|
7
|
5566 non-empty strings, thus cause the mode to be cleared.
|
|
|
5567
|
|
|
5568 *winbufnr()*
|
|
|
5569 winbufnr({nr}) The result is a Number, which is the number of the buffer
|
|
236
|
5570 associated with window {nr}. When {nr} is zero, the number of
|
|
7
|
5571 the buffer in the current window is returned. When window
|
|
|
5572 {nr} doesn't exist, -1 is returned.
|
|
|
5573 Example: >
|
|
|
5574 :echo "The file in the current window is " . bufname(winbufnr(0))
|
|
|
5575 <
|
|
|
5576 *wincol()*
|
|
|
5577 wincol() The result is a Number, which is the virtual column of the
|
|
|
5578 cursor in the window. This is counting screen cells from the
|
|
|
5579 left side of the window. The leftmost column is one.
|
|
|
5580
|
|
|
5581 winheight({nr}) *winheight()*
|
|
|
5582 The result is a Number, which is the height of window {nr}.
|
|
|
5583 When {nr} is zero, the height of the current window is
|
|
|
5584 returned. When window {nr} doesn't exist, -1 is returned.
|
|
|
5585 An existing window always has a height of zero or more.
|
|
|
5586 Examples: >
|
|
|
5587 :echo "The current window has " . winheight(0) . " lines."
|
|
|
5588 <
|
|
|
5589 *winline()*
|
|
|
5590 winline() The result is a Number, which is the screen line of the cursor
|
|
1621
|
5591 in the window. This is counting screen lines from the top of
|
|
7
|
5592 the window. The first line is one.
|
|
531
|
5593 If the cursor was moved the view on the file will be updated
|
|
|
5594 first, this may cause a scroll.
|
|
7
|
5595
|
|
|
5596 *winnr()*
|
|
20
|
5597 winnr([{arg}]) The result is a Number, which is the number of the current
|
|
|
5598 window. The top window has number 1.
|
|
|
5599 When the optional argument is "$", the number of the
|
|
674
|
5600 last window is returned (the window count).
|
|
20
|
5601 When the optional argument is "#", the number of the last
|
|
|
5602 accessed window is returned (where |CTRL-W_p| goes to).
|
|
1156
|
5603 If there is no previous window or it is in another tab page 0
|
|
|
5604 is returned.
|
|
20
|
5605 The number can be used with |CTRL-W_w| and ":wincmd w"
|
|
|
5606 |:wincmd|.
|
|
1156
|
5607 Also see |tabpagewinnr()|.
|
|
7
|
5608
|
|
|
5609 *winrestcmd()*
|
|
|
5610 winrestcmd() Returns a sequence of |:resize| commands that should restore
|
|
|
5611 the current window sizes. Only works properly when no windows
|
|
712
|
5612 are opened or closed and the current window and tab page is
|
|
|
5613 unchanged.
|
|
7
|
5614 Example: >
|
|
|
5615 :let cmd = winrestcmd()
|
|
|
5616 :call MessWithWindowSizes()
|
|
|
5617 :exe cmd
|
|
712
|
5618 <
|
|
|
5619 *winrestview()*
|
|
|
5620 winrestview({dict})
|
|
|
5621 Uses the |Dictionary| returned by |winsaveview()| to restore
|
|
|
5622 the view of the current window.
|
|
|
5623 If you have changed the values the result is unpredictable.
|
|
|
5624 If the window size changed the result won't be the same.
|
|
|
5625
|
|
|
5626 *winsaveview()*
|
|
|
5627 winsaveview() Returns a |Dictionary| that contains information to restore
|
|
|
5628 the view of the current window. Use |winrestview()| to
|
|
|
5629 restore the view.
|
|
|
5630 This is useful if you have a mapping that jumps around in the
|
|
|
5631 buffer and you want to go back to the original view.
|
|
|
5632 This does not save fold information. Use the 'foldenable'
|
|
798
|
5633 option to temporarily switch off folding, so that folds are
|
|
|
5634 not opened when moving around.
|
|
712
|
5635 The return value includes:
|
|
|
5636 lnum cursor line number
|
|
|
5637 col cursor column
|
|
|
5638 coladd cursor column offset for 'virtualedit'
|
|
|
5639 curswant column for vertical movement
|
|
|
5640 topline first line in the window
|
|
|
5641 topfill filler lines, only in diff mode
|
|
|
5642 leftcol first column displayed
|
|
|
5643 skipcol columns skipped
|
|
|
5644 Note that no option values are saved.
|
|
|
5645
|
|
7
|
5646
|
|
|
5647 winwidth({nr}) *winwidth()*
|
|
|
5648 The result is a Number, which is the width of window {nr}.
|
|
|
5649 When {nr} is zero, the width of the current window is
|
|
|
5650 returned. When window {nr} doesn't exist, -1 is returned.
|
|
|
5651 An existing window always has a width of zero or more.
|
|
|
5652 Examples: >
|
|
|
5653 :echo "The current window has " . winwidth(0) . " columns."
|
|
|
5654 :if winwidth(0) <= 50
|
|
|
5655 : exe "normal 50\<C-W>|"
|
|
|
5656 :endif
|
|
|
5657 <
|
|
158
|
5658 *writefile()*
|
|
|
5659 writefile({list}, {fname} [, {binary}])
|
|
685
|
5660 Write |List| {list} to file {fname}. Each list item is
|
|
158
|
5661 separated with a NL. Each list item must be a String or
|
|
|
5662 Number.
|
|
|
5663 When {binary} is equal to "b" binary mode is used: There will
|
|
|
5664 not be a NL after the last list item. An empty item at the
|
|
|
5665 end does cause the last line in the file to end in a NL.
|
|
|
5666 All NL characters are replaced with a NUL character.
|
|
|
5667 Inserting CR characters needs to be done before passing {list}
|
|
|
5668 to writefile().
|
|
|
5669 An existing file is overwritten, if possible.
|
|
|
5670 When the write fails -1 is returned, otherwise 0. There is an
|
|
|
5671 error message if the file can't be created or when writing
|
|
|
5672 fails.
|
|
|
5673 Also see |readfile()|.
|
|
|
5674 To copy a file byte for byte: >
|
|
|
5675 :let fl = readfile("foo", "b")
|
|
|
5676 :call writefile(fl, "foocopy", "b")
|
|
|
5677 <
|
|
7
|
5678
|
|
|
5679 *feature-list*
|
|
|
5680 There are three types of features:
|
|
|
5681 1. Features that are only supported when they have been enabled when Vim
|
|
|
5682 was compiled |+feature-list|. Example: >
|
|
|
5683 :if has("cindent")
|
|
|
5684 2. Features that are only supported when certain conditions have been met.
|
|
|
5685 Example: >
|
|
|
5686 :if has("gui_running")
|
|
|
5687 < *has-patch*
|
|
|
5688 3. Included patches. First check |v:version| for the version of Vim.
|
|
|
5689 Then the "patch123" feature means that patch 123 has been included for
|
|
|
5690 this version. Example (checking version 6.2.148 or later): >
|
|
|
5691 :if v:version > 602 || v:version == 602 && has("patch148")
|
|
1156
|
5692 < Note that it's possible for patch 147 to be omitted even though 148 is
|
|
|
5693 included.
|
|
7
|
5694
|
|
|
5695 all_builtin_terms Compiled with all builtin terminals enabled.
|
|
|
5696 amiga Amiga version of Vim.
|
|
|
5697 arabic Compiled with Arabic support |Arabic|.
|
|
|
5698 arp Compiled with ARP support (Amiga).
|
|
613
|
5699 autocmd Compiled with autocommand support. |autocommand|
|
|
7
|
5700 balloon_eval Compiled with |balloon-eval| support.
|
|
435
|
5701 balloon_multiline GUI supports multiline balloons.
|
|
7
|
5702 beos BeOS version of Vim.
|
|
|
5703 browse Compiled with |:browse| support, and browse() will
|
|
|
5704 work.
|
|
|
5705 builtin_terms Compiled with some builtin terminals.
|
|
|
5706 byte_offset Compiled with support for 'o' in 'statusline'
|
|
|
5707 cindent Compiled with 'cindent' support.
|
|
|
5708 clientserver Compiled with remote invocation support |clientserver|.
|
|
|
5709 clipboard Compiled with 'clipboard' support.
|
|
|
5710 cmdline_compl Compiled with |cmdline-completion| support.
|
|
|
5711 cmdline_hist Compiled with |cmdline-history| support.
|
|
|
5712 cmdline_info Compiled with 'showcmd' and 'ruler' support.
|
|
|
5713 comments Compiled with |'comments'| support.
|
|
|
5714 cryptv Compiled with encryption support |encryption|.
|
|
|
5715 cscope Compiled with |cscope| support.
|
|
|
5716 compatible Compiled to be very Vi compatible.
|
|
|
5717 debug Compiled with "DEBUG" defined.
|
|
|
5718 dialog_con Compiled with console dialog support.
|
|
|
5719 dialog_gui Compiled with GUI dialog support.
|
|
|
5720 diff Compiled with |vimdiff| and 'diff' support.
|
|
|
5721 digraphs Compiled with support for digraphs.
|
|
|
5722 dnd Compiled with support for the "~ register |quote_~|.
|
|
|
5723 dos32 32 bits DOS (DJGPP) version of Vim.
|
|
|
5724 dos16 16 bits DOS version of Vim.
|
|
|
5725 ebcdic Compiled on a machine with ebcdic character set.
|
|
|
5726 emacs_tags Compiled with support for Emacs tags.
|
|
|
5727 eval Compiled with expression evaluation support. Always
|
|
|
5728 true, of course!
|
|
|
5729 ex_extra Compiled with extra Ex commands |+ex_extra|.
|
|
|
5730 extra_search Compiled with support for |'incsearch'| and
|
|
|
5731 |'hlsearch'|
|
|
|
5732 farsi Compiled with Farsi support |farsi|.
|
|
|
5733 file_in_path Compiled with support for |gf| and |<cfile>|
|
|
168
|
5734 filterpipe When 'shelltemp' is off pipes are used for shell
|
|
|
5735 read/write/filter commands
|
|
7
|
5736 find_in_path Compiled with support for include file searches
|
|
|
5737 |+find_in_path|.
|
|
1621
|
5738 float Compiled with support for |Float|.
|
|
7
|
5739 fname_case Case in file names matters (for Amiga, MS-DOS, and
|
|
|
5740 Windows this is not present).
|
|
|
5741 folding Compiled with |folding| support.
|
|
|
5742 footer Compiled with GUI footer support. |gui-footer|
|
|
|
5743 fork Compiled to use fork()/exec() instead of system().
|
|
|
5744 gettext Compiled with message translation |multi-lang|
|
|
|
5745 gui Compiled with GUI enabled.
|
|
|
5746 gui_athena Compiled with Athena GUI.
|
|
|
5747 gui_gtk Compiled with GTK+ GUI (any version).
|
|
|
5748 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
|
|
1621
|
5749 gui_gnome Compiled with Gnome support (gui_gtk is also defined).
|
|
7
|
5750 gui_mac Compiled with Macintosh GUI.
|
|
|
5751 gui_motif Compiled with Motif GUI.
|
|
|
5752 gui_photon Compiled with Photon GUI.
|
|
|
5753 gui_win32 Compiled with MS Windows Win32 GUI.
|
|
|
5754 gui_win32s idem, and Win32s system being used (Windows 3.1)
|
|
|
5755 gui_running Vim is running in the GUI, or it will start soon.
|
|
|
5756 hangul_input Compiled with Hangul input support. |hangul|
|
|
|
5757 iconv Can use iconv() for conversion.
|
|
|
5758 insert_expand Compiled with support for CTRL-X expansion commands in
|
|
|
5759 Insert mode.
|
|
|
5760 jumplist Compiled with |jumplist| support.
|
|
|
5761 keymap Compiled with 'keymap' support.
|
|
|
5762 langmap Compiled with 'langmap' support.
|
|
|
5763 libcall Compiled with |libcall()| support.
|
|
|
5764 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
|
|
|
5765 support.
|
|
|
5766 lispindent Compiled with support for lisp indenting.
|
|
|
5767 listcmds Compiled with commands for the buffer list |:files|
|
|
|
5768 and the argument list |arglist|.
|
|
|
5769 localmap Compiled with local mappings and abbr. |:map-local|
|
|
|
5770 mac Macintosh version of Vim.
|
|
|
5771 macunix Macintosh version of Vim, using Unix files (OS-X).
|
|
|
5772 menu Compiled with support for |:menu|.
|
|
|
5773 mksession Compiled with support for |:mksession|.
|
|
|
5774 modify_fname Compiled with file name modifiers. |filename-modifiers|
|
|
|
5775 mouse Compiled with support mouse.
|
|
|
5776 mouseshape Compiled with support for 'mouseshape'.
|
|
|
5777 mouse_dec Compiled with support for Dec terminal mouse.
|
|
|
5778 mouse_gpm Compiled with support for gpm (Linux console mouse)
|
|
|
5779 mouse_netterm Compiled with support for netterm mouse.
|
|
|
5780 mouse_pterm Compiled with support for qnx pterm mouse.
|
|
1621
|
5781 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
|
|
7
|
5782 mouse_xterm Compiled with support for xterm mouse.
|
|
|
5783 multi_byte Compiled with support for editing Korean et al.
|
|
|
5784 multi_byte_ime Compiled with support for IME input method.
|
|
|
5785 multi_lang Compiled with support for multiple languages.
|
|
14
|
5786 mzscheme Compiled with MzScheme interface |mzscheme|.
|
|
7
|
5787 netbeans_intg Compiled with support for |netbeans|.
|
|
33
|
5788 netbeans_enabled Compiled with support for |netbeans| and it's used.
|
|
7
|
5789 ole Compiled with OLE automation support for Win32.
|
|
|
5790 os2 OS/2 version of Vim.
|
|
|
5791 osfiletype Compiled with support for osfiletypes |+osfiletype|
|
|
|
5792 path_extra Compiled with up/downwards search in 'path' and 'tags'
|
|
|
5793 perl Compiled with Perl interface.
|
|
|
5794 postscript Compiled with PostScript file printing.
|
|
|
5795 printer Compiled with |:hardcopy| support.
|
|
170
|
5796 profile Compiled with |:profile| support.
|
|
7
|
5797 python Compiled with Python interface.
|
|
|
5798 qnx QNX version of Vim.
|
|
|
5799 quickfix Compiled with |quickfix| support.
|
|
857
|
5800 reltime Compiled with |reltime()| support.
|
|
7
|
5801 rightleft Compiled with 'rightleft' support.
|
|
|
5802 ruby Compiled with Ruby interface |ruby|.
|
|
|
5803 scrollbind Compiled with 'scrollbind' support.
|
|
|
5804 showcmd Compiled with 'showcmd' support.
|
|
|
5805 signs Compiled with |:sign| support.
|
|
|
5806 smartindent Compiled with 'smartindent' support.
|
|
9
|
5807 sniff Compiled with SNiFF interface support.
|
|
7
|
5808 statusline Compiled with support for 'statusline', 'rulerformat'
|
|
|
5809 and special formats of 'titlestring' and 'iconstring'.
|
|
|
5810 sun_workshop Compiled with support for Sun |workshop|.
|
|
314
|
5811 spell Compiled with spell checking support |spell|.
|
|
|
5812 syntax Compiled with syntax highlighting support |syntax|.
|
|
7
|
5813 syntax_items There are active syntax highlighting items for the
|
|
|
5814 current buffer.
|
|
|
5815 system Compiled to use system() instead of fork()/exec().
|
|
|
5816 tag_binary Compiled with binary searching in tags files
|
|
|
5817 |tag-binary-search|.
|
|
|
5818 tag_old_static Compiled with support for old static tags
|
|
|
5819 |tag-old-static|.
|
|
|
5820 tag_any_white Compiled with support for any white characters in tags
|
|
|
5821 files |tag-any-white|.
|
|
|
5822 tcl Compiled with Tcl interface.
|
|
|
5823 terminfo Compiled with terminfo instead of termcap.
|
|
|
5824 termresponse Compiled with support for |t_RV| and |v:termresponse|.
|
|
|
5825 textobjects Compiled with support for |text-objects|.
|
|
|
5826 tgetent Compiled with tgetent support, able to use a termcap
|
|
|
5827 or terminfo file.
|
|
|
5828 title Compiled with window title support |'title'|.
|
|
|
5829 toolbar Compiled with support for |gui-toolbar|.
|
|
|
5830 unix Unix version of Vim.
|
|
|
5831 user_commands User-defined commands.
|
|
|
5832 viminfo Compiled with viminfo support.
|
|
|
5833 vim_starting True while initial source'ing takes place.
|
|
|
5834 vertsplit Compiled with vertically split windows |:vsplit|.
|
|
|
5835 virtualedit Compiled with 'virtualedit' option.
|
|
|
5836 visual Compiled with Visual mode.
|
|
|
5837 visualextra Compiled with extra Visual mode commands.
|
|
|
5838 |blockwise-operators|.
|
|
|
5839 vms VMS version of Vim.
|
|
|
5840 vreplace Compiled with |gR| and |gr| commands.
|
|
|
5841 wildignore Compiled with 'wildignore' option.
|
|
|
5842 wildmenu Compiled with 'wildmenu' option.
|
|
|
5843 windows Compiled with support for more than one window.
|
|
|
5844 winaltkeys Compiled with 'winaltkeys' option.
|
|
|
5845 win16 Win16 version of Vim (MS-Windows 3.1).
|
|
|
5846 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
|
|
|
5847 win64 Win64 version of Vim (MS-Windows 64 bit).
|
|
|
5848 win32unix Win32 version of Vim, using Unix files (Cygwin)
|
|
|
5849 win95 Win32 version for MS-Windows 95/98/ME.
|
|
|
5850 writebackup Compiled with 'writebackup' default on.
|
|
|
5851 xfontset Compiled with X fontset support |xfontset|.
|
|
|
5852 xim Compiled with X input method support |xim|.
|
|
|
5853 xsmp Compiled with X session management support.
|
|
|
5854 xsmp_interact Compiled with interactive X session management support.
|
|
|
5855 xterm_clipboard Compiled with support for xterm clipboard.
|
|
|
5856 xterm_save Compiled with support for saving and restoring the
|
|
|
5857 xterm screen.
|
|
|
5858 x11 Compiled with X11 support.
|
|
|
5859
|
|
|
5860 *string-match*
|
|
|
5861 Matching a pattern in a String
|
|
|
5862
|
|
|
5863 A regexp pattern as explained at |pattern| is normally used to find a match in
|
|
|
5864 the buffer lines. When a pattern is used to find a match in a String, almost
|
|
|
5865 everything works in the same way. The difference is that a String is handled
|
|
|
5866 like it is one line. When it contains a "\n" character, this is not seen as a
|
|
|
5867 line break for the pattern. It can be matched with a "\n" in the pattern, or
|
|
|
5868 with ".". Example: >
|
|
|
5869 :let a = "aaaa\nxxxx"
|
|
|
5870 :echo matchstr(a, "..\n..")
|
|
|
5871 aa
|
|
|
5872 xx
|
|
|
5873 :echo matchstr(a, "a.x")
|
|
|
5874 a
|
|
|
5875 x
|
|
|
5876
|
|
|
5877 Don't forget that "^" will only match at the first character of the String and
|
|
|
5878 "$" at the last character of the string. They don't match after or before a
|
|
|
5879 "\n".
|
|
|
5880
|
|
|
5881 ==============================================================================
|
|
|
5882 5. Defining functions *user-functions*
|
|
|
5883
|
|
|
5884 New functions can be defined. These can be called just like builtin
|
|
|
5885 functions. The function executes a sequence of Ex commands. Normal mode
|
|
|
5886 commands can be executed with the |:normal| command.
|
|
|
5887
|
|
|
5888 The function name must start with an uppercase letter, to avoid confusion with
|
|
|
5889 builtin functions. To prevent from using the same name in different scripts
|
|
|
5890 avoid obvious, short names. A good habit is to start the function name with
|
|
|
5891 the name of the script, e.g., "HTMLcolor()".
|
|
|
5892
|
|
504
|
5893 It's also possible to use curly braces, see |curly-braces-names|. And the
|
|
|
5894 |autoload| facility is useful to define a function only when it's called.
|
|
7
|
5895
|
|
|
5896 *local-function*
|
|
|
5897 A function local to a script must start with "s:". A local script function
|
|
|
5898 can only be called from within the script and from functions, user commands
|
|
|
5899 and autocommands defined in the script. It is also possible to call the
|
|
|
5900 function from a mappings defined in the script, but then |<SID>| must be used
|
|
|
5901 instead of "s:" when the mapping is expanded outside of the script.
|
|
|
5902
|
|
|
5903 *:fu* *:function* *E128* *E129* *E123*
|
|
|
5904 :fu[nction] List all functions and their arguments.
|
|
|
5905
|
|
|
5906 :fu[nction] {name} List function {name}.
|
|
685
|
5907 {name} can also be a |Dictionary| entry that is a
|
|
|
5908 |Funcref|: >
|
|
114
|
5909 :function dict.init
|
|
504
|
5910
|
|
|
5911 :fu[nction] /{pattern} List functions with a name matching {pattern}.
|
|
|
5912 Example that lists all functions ending with "File": >
|
|
|
5913 :function /File$
|
|
482
|
5914 <
|
|
|
5915 *:function-verbose*
|
|
|
5916 When 'verbose' is non-zero, listing a function will also display where it was
|
|
|
5917 last defined. Example: >
|
|
|
5918
|
|
|
5919 :verbose function SetFileTypeSH
|
|
|
5920 function SetFileTypeSH(name)
|
|
|
5921 Last set from /usr/share/vim/vim-7.0/filetype.vim
|
|
|
5922 <
|
|
484
|
5923 See |:verbose-cmd| for more information.
|
|
482
|
5924
|
|
856
|
5925 *E124* *E125*
|
|
102
|
5926 :fu[nction][!] {name}([arguments]) [range] [abort] [dict]
|
|
7
|
5927 Define a new function by the name {name}. The name
|
|
|
5928 must be made of alphanumeric characters and '_', and
|
|
|
5929 must start with a capital or "s:" (see above).
|
|
114
|
5930
|
|
685
|
5931 {name} can also be a |Dictionary| entry that is a
|
|
|
5932 |Funcref|: >
|
|
114
|
5933 :function dict.init(arg)
|
|
1621
|
5934 < "dict" must be an existing dictionary. The entry
|
|
114
|
5935 "init" is added if it didn't exist yet. Otherwise [!]
|
|
1621
|
5936 is required to overwrite an existing function. The
|
|
114
|
5937 result is a |Funcref| to a numbered function. The
|
|
|
5938 function can only be used with a |Funcref| and will be
|
|
|
5939 deleted if there are no more references to it.
|
|
7
|
5940 *E127* *E122*
|
|
|
5941 When a function by this name already exists and [!] is
|
|
|
5942 not used an error message is given. When [!] is used,
|
|
|
5943 an existing function is silently replaced. Unless it
|
|
|
5944 is currently being executed, that is an error.
|
|
133
|
5945
|
|
|
5946 For the {arguments} see |function-argument|.
|
|
|
5947
|
|
7
|
5948 *a:firstline* *a:lastline*
|
|
|
5949 When the [range] argument is added, the function is
|
|
|
5950 expected to take care of a range itself. The range is
|
|
|
5951 passed as "a:firstline" and "a:lastline". If [range]
|
|
|
5952 is excluded, ":{range}call" will call the function for
|
|
|
5953 each line in the range, with the cursor on the start
|
|
|
5954 of each line. See |function-range-example|.
|
|
114
|
5955
|
|
7
|
5956 When the [abort] argument is added, the function will
|
|
|
5957 abort as soon as an error is detected.
|
|
114
|
5958
|
|
102
|
5959 When the [dict] argument is added, the function must
|
|
1621
|
5960 be invoked through an entry in a |Dictionary|. The
|
|
102
|
5961 local variable "self" will then be set to the
|
|
|
5962 dictionary. See |Dictionary-function|.
|
|
7
|
5963
|
|
1621
|
5964 *function-search-undo*
|
|
653
|
5965 The last used search pattern and the redo command "."
|
|
1621
|
5966 will not be changed by the function. This also
|
|
|
5967 implies that the effect of |:nohlsearch| is undone
|
|
|
5968 when the function returns.
|
|
653
|
5969
|
|
7
|
5970 *:endf* *:endfunction* *E126* *E193*
|
|
|
5971 :endf[unction] The end of a function definition. Must be on a line
|
|
|
5972 by its own, without other commands.
|
|
|
5973
|
|
|
5974 *:delf* *:delfunction* *E130* *E131*
|
|
|
5975 :delf[unction] {name} Delete function {name}.
|
|
685
|
5976 {name} can also be a |Dictionary| entry that is a
|
|
|
5977 |Funcref|: >
|
|
114
|
5978 :delfunc dict.init
|
|
1621
|
5979 < This will remove the "init" entry from "dict". The
|
|
114
|
5980 function is deleted if there are no more references to
|
|
|
5981 it.
|
|
7
|
5982 *:retu* *:return* *E133*
|
|
|
5983 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
|
|
|
5984 evaluated and returned as the result of the function.
|
|
|
5985 If "[expr]" is not given, the number 0 is returned.
|
|
|
5986 When a function ends without an explicit ":return",
|
|
|
5987 the number 0 is returned.
|
|
|
5988 Note that there is no check for unreachable lines,
|
|
|
5989 thus there is no warning if commands follow ":return".
|
|
|
5990
|
|
|
5991 If the ":return" is used after a |:try| but before the
|
|
|
5992 matching |:finally| (if present), the commands
|
|
|
5993 following the ":finally" up to the matching |:endtry|
|
|
|
5994 are executed first. This process applies to all
|
|
|
5995 nested ":try"s inside the function. The function
|
|
|
5996 returns at the outermost ":endtry".
|
|
|
5997
|
|
133
|
5998 *function-argument* *a:var*
|
|
1621
|
5999 An argument can be defined by giving its name. In the function this can then
|
|
133
|
6000 be used as "a:name" ("a:" for argument).
|
|
1156
|
6001 *a:0* *a:1* *a:000* *E740* *...*
|
|
133
|
6002 Up to 20 arguments can be given, separated by commas. After the named
|
|
|
6003 arguments an argument "..." can be specified, which means that more arguments
|
|
|
6004 may optionally be following. In the function the extra arguments can be used
|
|
|
6005 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
|
|
685
|
6006 can be 0). "a:000" is set to a |List| that contains these arguments. Note
|
|
|
6007 that "a:1" is the same as "a:000[0]".
|
|
148
|
6008 *E742*
|
|
|
6009 The a: scope and the variables in it cannot be changed, they are fixed.
|
|
685
|
6010 However, if a |List| or |Dictionary| is used, you can changes their contents.
|
|
|
6011 Thus you can pass a |List| to a function and have the function add an item to
|
|
|
6012 it. If you want to make sure the function cannot change a |List| or
|
|
|
6013 |Dictionary| use |:lockvar|.
|
|
133
|
6014
|
|
|
6015 When not using "...", the number of arguments in a function call must be equal
|
|
|
6016 to the number of named arguments. When using "...", the number of arguments
|
|
|
6017 may be larger.
|
|
|
6018
|
|
|
6019 It is also possible to define a function without any arguments. You must
|
|
|
6020 still supply the () then. The body of the function follows in the next lines,
|
|
|
6021 until the matching |:endfunction|. It is allowed to define another function
|
|
|
6022 inside a function body.
|
|
|
6023
|
|
|
6024 *local-variables*
|
|
7
|
6025 Inside a function variables can be used. These are local variables, which
|
|
|
6026 will disappear when the function returns. Global variables need to be
|
|
|
6027 accessed with "g:".
|
|
|
6028
|
|
|
6029 Example: >
|
|
|
6030 :function Table(title, ...)
|
|
|
6031 : echohl Title
|
|
|
6032 : echo a:title
|
|
|
6033 : echohl None
|
|
140
|
6034 : echo a:0 . " items:"
|
|
|
6035 : for s in a:000
|
|
|
6036 : echon ' ' . s
|
|
|
6037 : endfor
|
|
7
|
6038 :endfunction
|
|
|
6039
|
|
|
6040 This function can then be called with: >
|
|
140
|
6041 call Table("Table", "line1", "line2")
|
|
|
6042 call Table("Empty Table")
|
|
7
|
6043
|
|
1156
|
6044 To return more than one value, return a |List|: >
|
|
|
6045 :function Compute(n1, n2)
|
|
7
|
6046 : if a:n2 == 0
|
|
1156
|
6047 : return ["fail", 0]
|
|
7
|
6048 : endif
|
|
1156
|
6049 : return ["ok", a:n1 / a:n2]
|
|
7
|
6050 :endfunction
|
|
|
6051
|
|
|
6052 This function can then be called with: >
|
|
1156
|
6053 :let [success, div] = Compute(102, 6)
|
|
7
|
6054 :if success == "ok"
|
|
|
6055 : echo div
|
|
|
6056 :endif
|
|
1156
|
6057 <
|
|
786
|
6058 *:cal* *:call* *E107* *E117*
|
|
7
|
6059 :[range]cal[l] {name}([arguments])
|
|
|
6060 Call a function. The name of the function and its arguments
|
|
|
6061 are as specified with |:function|. Up to 20 arguments can be
|
|
1156
|
6062 used. The returned value is discarded.
|
|
7
|
6063 Without a range and for functions that accept a range, the
|
|
|
6064 function is called once. When a range is given the cursor is
|
|
|
6065 positioned at the start of the first line before executing the
|
|
|
6066 function.
|
|
|
6067 When a range is given and the function doesn't handle it
|
|
|
6068 itself, the function is executed for each line in the range,
|
|
|
6069 with the cursor in the first column of that line. The cursor
|
|
|
6070 is left at the last line (possibly moved by the last function
|
|
1621
|
6071 call). The arguments are re-evaluated for each line. Thus
|
|
7
|
6072 this works:
|
|
|
6073 *function-range-example* >
|
|
|
6074 :function Mynumber(arg)
|
|
|
6075 : echo line(".") . " " . a:arg
|
|
|
6076 :endfunction
|
|
|
6077 :1,5call Mynumber(getline("."))
|
|
|
6078 <
|
|
|
6079 The "a:firstline" and "a:lastline" are defined anyway, they
|
|
|
6080 can be used to do something different at the start or end of
|
|
|
6081 the range.
|
|
|
6082
|
|
|
6083 Example of a function that handles the range itself: >
|
|
|
6084
|
|
|
6085 :function Cont() range
|
|
|
6086 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
|
|
|
6087 :endfunction
|
|
|
6088 :4,8call Cont()
|
|
|
6089 <
|
|
|
6090 This function inserts the continuation character "\" in front
|
|
|
6091 of all the lines in the range, except the first one.
|
|
|
6092
|
|
1156
|
6093 When the function returns a composite value it can be further
|
|
|
6094 dereferenced, but the range will not be used then. Example: >
|
|
|
6095 :4,8call GetDict().method()
|
|
|
6096 < Here GetDict() gets the range but method() does not.
|
|
|
6097
|
|
7
|
6098 *E132*
|
|
|
6099 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
|
|
|
6100 option.
|
|
|
6101
|
|
161
|
6102
|
|
|
6103 AUTOMATICALLY LOADING FUNCTIONS ~
|
|
7
|
6104 *autoload-functions*
|
|
|
6105 When using many or large functions, it's possible to automatically define them
|
|
161
|
6106 only when they are used. There are two methods: with an autocommand and with
|
|
|
6107 the "autoload" directory in 'runtimepath'.
|
|
|
6108
|
|
|
6109
|
|
|
6110 Using an autocommand ~
|
|
|
6111
|
|
170
|
6112 This is introduced in the user manual, section |41.14|.
|
|
|
6113
|
|
161
|
6114 The autocommand is useful if you have a plugin that is a long Vim script file.
|
|
|
6115 You can define the autocommand and quickly quit the script with |:finish|.
|
|
1621
|
6116 That makes Vim startup faster. The autocommand should then load the same file
|
|
161
|
6117 again, setting a variable to skip the |:finish| command.
|
|
|
6118
|
|
|
6119 Use the FuncUndefined autocommand event with a pattern that matches the
|
|
|
6120 function(s) to be defined. Example: >
|
|
7
|
6121
|
|
|
6122 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
|
|
|
6123
|
|
|
6124 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
|
|
|
6125 "BufNet". Also see |FuncUndefined|.
|
|
|
6126
|
|
161
|
6127
|
|
|
6128 Using an autoload script ~
|
|
168
|
6129 *autoload* *E746*
|
|
170
|
6130 This is introduced in the user manual, section |41.15|.
|
|
|
6131
|
|
161
|
6132 Using a script in the "autoload" directory is simpler, but requires using
|
|
|
6133 exactly the right file name. A function that can be autoloaded has a name
|
|
|
6134 like this: >
|
|
|
6135
|
|
270
|
6136 :call filename#funcname()
|
|
161
|
6137
|
|
|
6138 When such a function is called, and it is not defined yet, Vim will search the
|
|
|
6139 "autoload" directories in 'runtimepath' for a script file called
|
|
|
6140 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
|
|
|
6141 then define the function like this: >
|
|
|
6142
|
|
270
|
6143 function filename#funcname()
|
|
161
|
6144 echo "Done!"
|
|
|
6145 endfunction
|
|
|
6146
|
|
530
|
6147 The file name and the name used before the # in the function must match
|
|
161
|
6148 exactly, and the defined function must have the name exactly as it will be
|
|
|
6149 called.
|
|
|
6150
|
|
270
|
6151 It is possible to use subdirectories. Every # in the function name works like
|
|
|
6152 a path separator. Thus when calling a function: >
|
|
|
6153
|
|
|
6154 :call foo#bar#func()
|
|
161
|
6155
|
|
|
6156 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
|
|
|
6157
|
|
168
|
6158 This also works when reading a variable that has not been set yet: >
|
|
|
6159
|
|
270
|
6160 :let l = foo#bar#lvar
|
|
168
|
6161
|
|
557
|
6162 However, when the autoload script was already loaded it won't be loaded again
|
|
|
6163 for an unknown variable.
|
|
|
6164
|
|
168
|
6165 When assigning a value to such a variable nothing special happens. This can
|
|
|
6166 be used to pass settings to the autoload script before it's loaded: >
|
|
|
6167
|
|
270
|
6168 :let foo#bar#toggle = 1
|
|
|
6169 :call foo#bar#func()
|
|
168
|
6170
|
|
164
|
6171 Note that when you make a mistake and call a function that is supposed to be
|
|
|
6172 defined in an autoload script, but the script doesn't actually define the
|
|
|
6173 function, the script will be sourced every time you try to call the function.
|
|
168
|
6174 And you will get an error message every time.
|
|
|
6175
|
|
|
6176 Also note that if you have two script files, and one calls a function in the
|
|
1621
|
6177 other and vice versa, before the used function is defined, it won't work.
|
|
168
|
6178 Avoid using the autoload functionality at the toplevel.
|
|
161
|
6179
|
|
794
|
6180 Hint: If you distribute a bunch of scripts you can pack them together with the
|
|
|
6181 |vimball| utility. Also read the user manual |distribute-script|.
|
|
|
6182
|
|
7
|
6183 ==============================================================================
|
|
|
6184 6. Curly braces names *curly-braces-names*
|
|
|
6185
|
|
|
6186 Wherever you can use a variable, you can use a "curly braces name" variable.
|
|
|
6187 This is a regular variable name with one or more expressions wrapped in braces
|
|
|
6188 {} like this: >
|
|
|
6189 my_{adjective}_variable
|
|
|
6190
|
|
|
6191 When Vim encounters this, it evaluates the expression inside the braces, puts
|
|
|
6192 that in place of the expression, and re-interprets the whole as a variable
|
|
|
6193 name. So in the above example, if the variable "adjective" was set to
|
|
|
6194 "noisy", then the reference would be to "my_noisy_variable", whereas if
|
|
|
6195 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
|
|
|
6196
|
|
|
6197 One application for this is to create a set of variables governed by an option
|
|
1621
|
6198 value. For example, the statement >
|
|
7
|
6199 echo my_{&background}_message
|
|
|
6200
|
|
|
6201 would output the contents of "my_dark_message" or "my_light_message" depending
|
|
|
6202 on the current value of 'background'.
|
|
|
6203
|
|
|
6204 You can use multiple brace pairs: >
|
|
|
6205 echo my_{adverb}_{adjective}_message
|
|
|
6206 ..or even nest them: >
|
|
|
6207 echo my_{ad{end_of_word}}_message
|
|
|
6208 where "end_of_word" is either "verb" or "jective".
|
|
|
6209
|
|
|
6210 However, the expression inside the braces must evaluate to a valid single
|
|
236
|
6211 variable name, e.g. this is invalid: >
|
|
7
|
6212 :let foo='a + b'
|
|
|
6213 :echo c{foo}d
|
|
|
6214 .. since the result of expansion is "ca + bd", which is not a variable name.
|
|
|
6215
|
|
|
6216 *curly-braces-function-names*
|
|
|
6217 You can call and define functions by an evaluated name in a similar way.
|
|
|
6218 Example: >
|
|
|
6219 :let func_end='whizz'
|
|
|
6220 :call my_func_{func_end}(parameter)
|
|
|
6221
|
|
|
6222 This would call the function "my_func_whizz(parameter)".
|
|
|
6223
|
|
|
6224 ==============================================================================
|
|
|
6225 7. Commands *expression-commands*
|
|
|
6226
|
|
|
6227 :let {var-name} = {expr1} *:let* *E18*
|
|
|
6228 Set internal variable {var-name} to the result of the
|
|
|
6229 expression {expr1}. The variable will get the type
|
|
|
6230 from the {expr}. If {var-name} didn't exist yet, it
|
|
|
6231 is created.
|
|
|
6232
|
|
85
|
6233 :let {var-name}[{idx}] = {expr1} *E689*
|
|
|
6234 Set a list item to the result of the expression
|
|
|
6235 {expr1}. {var-name} must refer to a list and {idx}
|
|
|
6236 must be a valid index in that list. For nested list
|
|
|
6237 the index can be repeated.
|
|
1621
|
6238 This cannot be used to add an item to a |List|.
|
|
|
6239 This cannot be used to set a byte in a String. You
|
|
|
6240 can do that like this: >
|
|
|
6241 :let var = var[0:2] . 'X' . var[4:]
|
|
|
6242 <
|
|
114
|
6243 *E711* *E719*
|
|
|
6244 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
|
|
685
|
6245 Set a sequence of items in a |List| to the result of
|
|
|
6246 the expression {expr1}, which must be a list with the
|
|
87
|
6247 correct number of items.
|
|
|
6248 {idx1} can be omitted, zero is used instead.
|
|
|
6249 {idx2} can be omitted, meaning the end of the list.
|
|
|
6250 When the selected range of items is partly past the
|
|
|
6251 end of the list, items will be added.
|
|
|
6252
|
|
153
|
6253 *:let+=* *:let-=* *:let.=* *E734*
|
|
114
|
6254 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
|
|
|
6255 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
|
|
|
6256 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
|
|
|
6257 These fail if {var} was not set yet and when the type
|
|
|
6258 of {var} and {expr1} don't fit the operator.
|
|
|
6259
|
|
|
6260
|
|
7
|
6261 :let ${env-name} = {expr1} *:let-environment* *:let-$*
|
|
|
6262 Set environment variable {env-name} to the result of
|
|
|
6263 the expression {expr1}. The type is always String.
|
|
114
|
6264 :let ${env-name} .= {expr1}
|
|
|
6265 Append {expr1} to the environment variable {env-name}.
|
|
|
6266 If the environment variable didn't exist yet this
|
|
|
6267 works like "=".
|
|
7
|
6268
|
|
|
6269 :let @{reg-name} = {expr1} *:let-register* *:let-@*
|
|
|
6270 Write the result of the expression {expr1} in register
|
|
|
6271 {reg-name}. {reg-name} must be a single letter, and
|
|
|
6272 must be the name of a writable register (see
|
|
|
6273 |registers|). "@@" can be used for the unnamed
|
|
|
6274 register, "@/" for the search pattern.
|
|
|
6275 If the result of {expr1} ends in a <CR> or <NL>, the
|
|
|
6276 register will be linewise, otherwise it will be set to
|
|
|
6277 characterwise.
|
|
|
6278 This can be used to clear the last search pattern: >
|
|
|
6279 :let @/ = ""
|
|
|
6280 < This is different from searching for an empty string,
|
|
|
6281 that would match everywhere.
|
|
|
6282
|
|
114
|
6283 :let @{reg-name} .= {expr1}
|
|
1621
|
6284 Append {expr1} to register {reg-name}. If the
|
|
114
|
6285 register was empty it's like setting it to {expr1}.
|
|
|
6286
|
|
1156
|
6287 :let &{option-name} = {expr1} *:let-option* *:let-&*
|
|
7
|
6288 Set option {option-name} to the result of the
|
|
68
|
6289 expression {expr1}. A String or Number value is
|
|
|
6290 always converted to the type of the option.
|
|
7
|
6291 For an option local to a window or buffer the effect
|
|
|
6292 is just like using the |:set| command: both the local
|
|
555
|
6293 value and the global value are changed.
|
|
68
|
6294 Example: >
|
|
|
6295 :let &path = &path . ',/usr/local/include'
|
|
7
|
6296
|
|
114
|
6297 :let &{option-name} .= {expr1}
|
|
|
6298 For a string option: Append {expr1} to the value.
|
|
|
6299 Does not insert a comma like |:set+=|.
|
|
|
6300
|
|
|
6301 :let &{option-name} += {expr1}
|
|
|
6302 :let &{option-name} -= {expr1}
|
|
|
6303 For a number or boolean option: Add or subtract
|
|
|
6304 {expr1}.
|
|
|
6305
|
|
7
|
6306 :let &l:{option-name} = {expr1}
|
|
114
|
6307 :let &l:{option-name} .= {expr1}
|
|
|
6308 :let &l:{option-name} += {expr1}
|
|
|
6309 :let &l:{option-name} -= {expr1}
|
|
7
|
6310 Like above, but only set the local value of an option
|
|
|
6311 (if there is one). Works like |:setlocal|.
|
|
|
6312
|
|
|
6313 :let &g:{option-name} = {expr1}
|
|
114
|
6314 :let &g:{option-name} .= {expr1}
|
|
|
6315 :let &g:{option-name} += {expr1}
|
|
|
6316 :let &g:{option-name} -= {expr1}
|
|
7
|
6317 Like above, but only set the global value of an option
|
|
|
6318 (if there is one). Works like |:setglobal|.
|
|
|
6319
|
|
85
|
6320 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
|
|
685
|
6321 {expr1} must evaluate to a |List|. The first item in
|
|
68
|
6322 the list is assigned to {name1}, the second item to
|
|
|
6323 {name2}, etc.
|
|
|
6324 The number of names must match the number of items in
|
|
685
|
6325 the |List|.
|
|
68
|
6326 Each name can be one of the items of the ":let"
|
|
|
6327 command as mentioned above.
|
|
|
6328 Example: >
|
|
|
6329 :let [s, item] = GetItem(s)
|
|
114
|
6330 < Detail: {expr1} is evaluated first, then the
|
|
|
6331 assignments are done in sequence. This matters if
|
|
|
6332 {name2} depends on {name1}. Example: >
|
|
|
6333 :let x = [0, 1]
|
|
|
6334 :let i = 0
|
|
|
6335 :let [i, x[i]] = [1, 2]
|
|
|
6336 :echo x
|
|
|
6337 < The result is [0, 2].
|
|
|
6338
|
|
|
6339 :let [{name1}, {name2}, ...] .= {expr1}
|
|
|
6340 :let [{name1}, {name2}, ...] += {expr1}
|
|
|
6341 :let [{name1}, {name2}, ...] -= {expr1}
|
|
|
6342 Like above, but append/add/subtract the value for each
|
|
685
|
6343 |List| item.
|
|
68
|
6344
|
|
|
6345 :let [{name}, ..., ; {lastname}] = {expr1}
|
|
685
|
6346 Like |:let-unpack| above, but the |List| may have more
|
|
114
|
6347 items than there are names. A list of the remaining
|
|
|
6348 items is assigned to {lastname}. If there are no
|
|
|
6349 remaining items {lastname} is set to an empty list.
|
|
68
|
6350 Example: >
|
|
|
6351 :let [a, b; rest] = ["aval", "bval", 3, 4]
|
|
|
6352 <
|
|
114
|
6353 :let [{name}, ..., ; {lastname}] .= {expr1}
|
|
|
6354 :let [{name}, ..., ; {lastname}] += {expr1}
|
|
|
6355 :let [{name}, ..., ; {lastname}] -= {expr1}
|
|
|
6356 Like above, but append/add/subtract the value for each
|
|
685
|
6357 |List| item.
|
|
7
|
6358 *E106*
|
|
1621
|
6359 :let {var-name} .. List the value of variable {var-name}. Multiple
|
|
123
|
6360 variable names may be given. Special names recognized
|
|
|
6361 here: *E738*
|
|
777
|
6362 g: global variables
|
|
|
6363 b: local buffer variables
|
|
|
6364 w: local window variables
|
|
819
|
6365 t: local tab page variables
|
|
777
|
6366 s: script-local variables
|
|
|
6367 l: local function variables
|
|
123
|
6368 v: Vim variables.
|
|
7
|
6369
|
|
55
|
6370 :let List the values of all variables. The type of the
|
|
|
6371 variable is indicated before the value:
|
|
|
6372 <nothing> String
|
|
|
6373 # Number
|
|
856
|
6374 * Funcref
|
|
7
|
6375
|
|
148
|
6376
|
|
1156
|
6377 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
|
|
148
|
6378 Remove the internal variable {name}. Several variable
|
|
|
6379 names can be given, they are all removed. The name
|
|
685
|
6380 may also be a |List| or |Dictionary| item.
|
|
7
|
6381 With [!] no error message is given for non-existing
|
|
|
6382 variables.
|
|
685
|
6383 One or more items from a |List| can be removed: >
|
|
108
|
6384 :unlet list[3] " remove fourth item
|
|
|
6385 :unlet list[3:] " remove fourth item to last
|
|
685
|
6386 < One item from a |Dictionary| can be removed at a time: >
|
|
108
|
6387 :unlet dict['two']
|
|
|
6388 :unlet dict.two
|
|
7
|
6389
|
|
148
|
6390 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
|
|
|
6391 Lock the internal variable {name}. Locking means that
|
|
|
6392 it can no longer be changed (until it is unlocked).
|
|
|
6393 A locked variable can be deleted: >
|
|
|
6394 :lockvar v
|
|
|
6395 :let v = 'asdf' " fails!
|
|
|
6396 :unlet v
|
|
|
6397 < *E741*
|
|
|
6398 If you try to change a locked variable you get an
|
|
|
6399 error message: "E741: Value of {name} is locked"
|
|
|
6400
|
|
685
|
6401 [depth] is relevant when locking a |List| or
|
|
|
6402 |Dictionary|. It specifies how deep the locking goes:
|
|
|
6403 1 Lock the |List| or |Dictionary| itself,
|
|
148
|
6404 cannot add or remove items, but can
|
|
|
6405 still change their values.
|
|
|
6406 2 Also lock the values, cannot change
|
|
685
|
6407 the items. If an item is a |List| or
|
|
|
6408 |Dictionary|, cannot add or remove
|
|
148
|
6409 items, but can still change the
|
|
|
6410 values.
|
|
685
|
6411 3 Like 2 but for the |List| /
|
|
|
6412 |Dictionary| in the |List| /
|
|
|
6413 |Dictionary|, one level deeper.
|
|
|
6414 The default [depth] is 2, thus when {name} is a |List|
|
|
|
6415 or |Dictionary| the values cannot be changed.
|
|
148
|
6416 *E743*
|
|
|
6417 For unlimited depth use [!] and omit [depth].
|
|
|
6418 However, there is a maximum depth of 100 to catch
|
|
|
6419 loops.
|
|
|
6420
|
|
685
|
6421 Note that when two variables refer to the same |List|
|
|
|
6422 and you lock one of them, the |List| will also be
|
|
819
|
6423 locked when used through the other variable.
|
|
|
6424 Example: >
|
|
148
|
6425 :let l = [0, 1, 2, 3]
|
|
|
6426 :let cl = l
|
|
|
6427 :lockvar l
|
|
|
6428 :let cl[1] = 99 " won't work!
|
|
|
6429 < You may want to make a copy of a list to avoid this.
|
|
|
6430 See |deepcopy()|.
|
|
|
6431
|
|
|
6432
|
|
|
6433 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
|
|
|
6434 Unlock the internal variable {name}. Does the
|
|
|
6435 opposite of |:lockvar|.
|
|
|
6436
|
|
|
6437
|
|
7
|
6438 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
|
|
|
6439 :en[dif] Execute the commands until the next matching ":else"
|
|
|
6440 or ":endif" if {expr1} evaluates to non-zero.
|
|
|
6441
|
|
|
6442 From Vim version 4.5 until 5.0, every Ex command in
|
|
|
6443 between the ":if" and ":endif" is ignored. These two
|
|
|
6444 commands were just to allow for future expansions in a
|
|
|
6445 backwards compatible way. Nesting was allowed. Note
|
|
|
6446 that any ":else" or ":elseif" was ignored, the "else"
|
|
|
6447 part was not executed either.
|
|
|
6448
|
|
|
6449 You can use this to remain compatible with older
|
|
|
6450 versions: >
|
|
|
6451 :if version >= 500
|
|
|
6452 : version-5-specific-commands
|
|
|
6453 :endif
|
|
|
6454 < The commands still need to be parsed to find the
|
|
|
6455 "endif". Sometimes an older Vim has a problem with a
|
|
|
6456 new command. For example, ":silent" is recognized as
|
|
|
6457 a ":substitute" command. In that case ":execute" can
|
|
|
6458 avoid problems: >
|
|
|
6459 :if version >= 600
|
|
|
6460 : execute "silent 1,$delete"
|
|
|
6461 :endif
|
|
|
6462 <
|
|
|
6463 NOTE: The ":append" and ":insert" commands don't work
|
|
|
6464 properly in between ":if" and ":endif".
|
|
|
6465
|
|
|
6466 *:else* *:el* *E581* *E583*
|
|
|
6467 :el[se] Execute the commands until the next matching ":else"
|
|
|
6468 or ":endif" if they previously were not being
|
|
|
6469 executed.
|
|
|
6470
|
|
|
6471 *:elseif* *:elsei* *E582* *E584*
|
|
|
6472 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
|
|
|
6473 is no extra ":endif".
|
|
|
6474
|
|
|
6475 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
|
|
114
|
6476 *E170* *E585* *E588* *E733*
|
|
7
|
6477 :endw[hile] Repeat the commands between ":while" and ":endwhile",
|
|
|
6478 as long as {expr1} evaluates to non-zero.
|
|
|
6479 When an error is detected from a command inside the
|
|
|
6480 loop, execution continues after the "endwhile".
|
|
75
|
6481 Example: >
|
|
|
6482 :let lnum = 1
|
|
|
6483 :while lnum <= line("$")
|
|
|
6484 :call FixLine(lnum)
|
|
|
6485 :let lnum = lnum + 1
|
|
|
6486 :endwhile
|
|
|
6487 <
|
|
7
|
6488 NOTE: The ":append" and ":insert" commands don't work
|
|
99
|
6489 properly inside a ":while" and ":for" loop.
|
|
75
|
6490
|
|
114
|
6491 :for {var} in {list} *:for* *E690* *E732*
|
|
75
|
6492 :endfo[r] *:endfo* *:endfor*
|
|
|
6493 Repeat the commands between ":for" and ":endfor" for
|
|
158
|
6494 each item in {list}. Variable {var} is set to the
|
|
79
|
6495 value of each item.
|
|
|
6496 When an error is detected for a command inside the
|
|
75
|
6497 loop, execution continues after the "endfor".
|
|
464
|
6498 Changing {list} inside the loop affects what items are
|
|
|
6499 used. Make a copy if this is unwanted: >
|
|
79
|
6500 :for item in copy(mylist)
|
|
|
6501 < When not making a copy, Vim stores a reference to the
|
|
|
6502 next item in the list, before executing the commands
|
|
1621
|
6503 with the current item. Thus the current item can be
|
|
79
|
6504 removed without effect. Removing any later item means
|
|
|
6505 it will not be found. Thus the following example
|
|
|
6506 works (an inefficient way to make a list empty): >
|
|
|
6507 :for item in mylist
|
|
75
|
6508 :call remove(mylist, 0)
|
|
|
6509 :endfor
|
|
87
|
6510 < Note that reordering the list (e.g., with sort() or
|
|
|
6511 reverse()) may have unexpected effects.
|
|
|
6512 Note that the type of each list item should be
|
|
75
|
6513 identical to avoid errors for the type of {var}
|
|
|
6514 changing. Unlet the variable at the end of the loop
|
|
|
6515 to allow multiple item types.
|
|
|
6516
|
|
|
6517 :for [{var1}, {var2}, ...] in {listlist}
|
|
|
6518 :endfo[r]
|
|
|
6519 Like ":for" above, but each item in {listlist} must be
|
|
|
6520 a list, of which each item is assigned to {var1},
|
|
|
6521 {var2}, etc. Example: >
|
|
|
6522 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
|
|
|
6523 :echo getline(lnum)[col]
|
|
|
6524 :endfor
|
|
|
6525 <
|
|
7
|
6526 *:continue* *:con* *E586*
|
|
75
|
6527 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
|
|
|
6528 to the start of the loop.
|
|
|
6529 If it is used after a |:try| inside the loop but
|
|
|
6530 before the matching |:finally| (if present), the
|
|
|
6531 commands following the ":finally" up to the matching
|
|
|
6532 |:endtry| are executed first. This process applies to
|
|
|
6533 all nested ":try"s inside the loop. The outermost
|
|
|
6534 ":endtry" then jumps back to the start of the loop.
|
|
7
|
6535
|
|
|
6536 *:break* *:brea* *E587*
|
|
75
|
6537 :brea[k] When used inside a ":while" or ":for" loop, skips to
|
|
|
6538 the command after the matching ":endwhile" or
|
|
|
6539 ":endfor".
|
|
|
6540 If it is used after a |:try| inside the loop but
|
|
|
6541 before the matching |:finally| (if present), the
|
|
|
6542 commands following the ":finally" up to the matching
|
|
|
6543 |:endtry| are executed first. This process applies to
|
|
|
6544 all nested ":try"s inside the loop. The outermost
|
|
|
6545 ":endtry" then jumps to the command after the loop.
|
|
7
|
6546
|
|
|
6547 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
|
|
|
6548 :endt[ry] Change the error handling for the commands between
|
|
|
6549 ":try" and ":endtry" including everything being
|
|
|
6550 executed across ":source" commands, function calls,
|
|
|
6551 or autocommand invocations.
|
|
|
6552
|
|
|
6553 When an error or interrupt is detected and there is
|
|
|
6554 a |:finally| command following, execution continues
|
|
|
6555 after the ":finally". Otherwise, or when the
|
|
|
6556 ":endtry" is reached thereafter, the next
|
|
|
6557 (dynamically) surrounding ":try" is checked for
|
|
|
6558 a corresponding ":finally" etc. Then the script
|
|
|
6559 processing is terminated. (Whether a function
|
|
|
6560 definition has an "abort" argument does not matter.)
|
|
|
6561 Example: >
|
|
|
6562 :try | edit too much | finally | echo "cleanup" | endtry
|
|
|
6563 :echo "impossible" " not reached, script terminated above
|
|
|
6564 <
|
|
|
6565 Moreover, an error or interrupt (dynamically) inside
|
|
|
6566 ":try" and ":endtry" is converted to an exception. It
|
|
|
6567 can be caught as if it were thrown by a |:throw|
|
|
|
6568 command (see |:catch|). In this case, the script
|
|
|
6569 processing is not terminated.
|
|
|
6570
|
|
|
6571 The value "Vim:Interrupt" is used for an interrupt
|
|
|
6572 exception. An error in a Vim command is converted
|
|
|
6573 to a value of the form "Vim({command}):{errmsg}",
|
|
|
6574 other errors are converted to a value of the form
|
|
|
6575 "Vim:{errmsg}". {command} is the full command name,
|
|
|
6576 and {errmsg} is the message that is displayed if the
|
|
|
6577 error exception is not caught, always beginning with
|
|
|
6578 the error number.
|
|
|
6579 Examples: >
|
|
|
6580 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
|
|
|
6581 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
|
|
|
6582 <
|
|
|
6583 *:cat* *:catch* *E603* *E604* *E605*
|
|
|
6584 :cat[ch] /{pattern}/ The following commands until the next ":catch",
|
|
|
6585 |:finally|, or |:endtry| that belongs to the same
|
|
|
6586 |:try| as the ":catch" are executed when an exception
|
|
|
6587 matching {pattern} is being thrown and has not yet
|
|
|
6588 been caught by a previous ":catch". Otherwise, these
|
|
|
6589 commands are skipped.
|
|
|
6590 When {pattern} is omitted all errors are caught.
|
|
|
6591 Examples: >
|
|
|
6592 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
|
|
|
6593 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
|
|
|
6594 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
|
|
|
6595 :catch /^Vim(write):/ " catch all errors in :write
|
|
|
6596 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
|
|
|
6597 :catch /my-exception/ " catch user exception
|
|
|
6598 :catch /.*/ " catch everything
|
|
|
6599 :catch " same as /.*/
|
|
|
6600 <
|
|
|
6601 Another character can be used instead of / around the
|
|
|
6602 {pattern}, so long as it does not have a special
|
|
|
6603 meaning (e.g., '|' or '"') and doesn't occur inside
|
|
|
6604 {pattern}.
|
|
|
6605 NOTE: It is not reliable to ":catch" the TEXT of
|
|
|
6606 an error message because it may vary in different
|
|
|
6607 locales.
|
|
|
6608
|
|
|
6609 *:fina* *:finally* *E606* *E607*
|
|
|
6610 :fina[lly] The following commands until the matching |:endtry|
|
|
|
6611 are executed whenever the part between the matching
|
|
|
6612 |:try| and the ":finally" is left: either by falling
|
|
|
6613 through to the ":finally" or by a |:continue|,
|
|
|
6614 |:break|, |:finish|, or |:return|, or by an error or
|
|
|
6615 interrupt or exception (see |:throw|).
|
|
|
6616
|
|
|
6617 *:th* *:throw* *E608*
|
|
|
6618 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
|
|
|
6619 If the ":throw" is used after a |:try| but before the
|
|
|
6620 first corresponding |:catch|, commands are skipped
|
|
|
6621 until the first ":catch" matching {expr1} is reached.
|
|
|
6622 If there is no such ":catch" or if the ":throw" is
|
|
|
6623 used after a ":catch" but before the |:finally|, the
|
|
|
6624 commands following the ":finally" (if present) up to
|
|
|
6625 the matching |:endtry| are executed. If the ":throw"
|
|
|
6626 is after the ":finally", commands up to the ":endtry"
|
|
|
6627 are skipped. At the ":endtry", this process applies
|
|
|
6628 again for the next dynamically surrounding ":try"
|
|
|
6629 (which may be found in a calling function or sourcing
|
|
|
6630 script), until a matching ":catch" has been found.
|
|
|
6631 If the exception is not caught, the command processing
|
|
|
6632 is terminated.
|
|
|
6633 Example: >
|
|
|
6634 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
|
|
|
6635 <
|
|
|
6636
|
|
|
6637 *:ec* *:echo*
|
|
|
6638 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
|
|
|
6639 first {expr1} starts on a new line.
|
|
|
6640 Also see |:comment|.
|
|
|
6641 Use "\n" to start a new line. Use "\r" to move the
|
|
|
6642 cursor to the first column.
|
|
|
6643 Uses the highlighting set by the |:echohl| command.
|
|
|
6644 Cannot be followed by a comment.
|
|
|
6645 Example: >
|
|
|
6646 :echo "the value of 'shell' is" &shell
|
|
1156
|
6647 < *:echo-redraw*
|
|
|
6648 A later redraw may make the message disappear again.
|
|
|
6649 And since Vim mostly postpones redrawing until it's
|
|
|
6650 finished with a sequence of commands this happens
|
|
|
6651 quite often. To avoid that a command from before the
|
|
|
6652 ":echo" causes a redraw afterwards (redraws are often
|
|
|
6653 postponed until you type something), force a redraw
|
|
|
6654 with the |:redraw| command. Example: >
|
|
7
|
6655 :new | redraw | echo "there is a new window"
|
|
|
6656 <
|
|
|
6657 *:echon*
|
|
|
6658 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
|
|
|
6659 |:comment|.
|
|
|
6660 Uses the highlighting set by the |:echohl| command.
|
|
|
6661 Cannot be followed by a comment.
|
|
|
6662 Example: >
|
|
|
6663 :echon "the value of 'shell' is " &shell
|
|
|
6664 <
|
|
|
6665 Note the difference between using ":echo", which is a
|
|
|
6666 Vim command, and ":!echo", which is an external shell
|
|
|
6667 command: >
|
|
|
6668 :!echo % --> filename
|
|
|
6669 < The arguments of ":!" are expanded, see |:_%|. >
|
|
|
6670 :!echo "%" --> filename or "filename"
|
|
|
6671 < Like the previous example. Whether you see the double
|
|
|
6672 quotes or not depends on your 'shell'. >
|
|
|
6673 :echo % --> nothing
|
|
|
6674 < The '%' is an illegal character in an expression. >
|
|
|
6675 :echo "%" --> %
|
|
|
6676 < This just echoes the '%' character. >
|
|
|
6677 :echo expand("%") --> filename
|
|
|
6678 < This calls the expand() function to expand the '%'.
|
|
|
6679
|
|
|
6680 *:echoh* *:echohl*
|
|
|
6681 :echoh[l] {name} Use the highlight group {name} for the following
|
|
|
6682 |:echo|, |:echon| and |:echomsg| commands. Also used
|
|
|
6683 for the |input()| prompt. Example: >
|
|
|
6684 :echohl WarningMsg | echo "Don't panic!" | echohl None
|
|
|
6685 < Don't forget to set the group back to "None",
|
|
|
6686 otherwise all following echo's will be highlighted.
|
|
|
6687
|
|
|
6688 *:echom* *:echomsg*
|
|
|
6689 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
|
|
|
6690 message in the |message-history|.
|
|
|
6691 Spaces are placed between the arguments as with the
|
|
|
6692 |:echo| command. But unprintable characters are
|
|
|
6693 displayed, not interpreted.
|
|
1156
|
6694 The parsing works slightly different from |:echo|,
|
|
|
6695 more like |:execute|. All the expressions are first
|
|
|
6696 evaluated and concatenated before echoing anything.
|
|
|
6697 The expressions must evaluate to a Number or String, a
|
|
|
6698 Dictionary or List causes an error.
|
|
7
|
6699 Uses the highlighting set by the |:echohl| command.
|
|
|
6700 Example: >
|
|
|
6701 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
|
|
1156
|
6702 < See |:echo-redraw| to avoid the message disappearing
|
|
|
6703 when the screen is redrawn.
|
|
7
|
6704 *:echoe* *:echoerr*
|
|
|
6705 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
|
|
|
6706 message in the |message-history|. When used in a
|
|
|
6707 script or function the line number will be added.
|
|
|
6708 Spaces are placed between the arguments as with the
|
|
1621
|
6709 :echo command. When used inside a try conditional,
|
|
7
|
6710 the message is raised as an error exception instead
|
|
|
6711 (see |try-echoerr|).
|
|
|
6712 Example: >
|
|
|
6713 :echoerr "This script just failed!"
|
|
|
6714 < If you just want a highlighted message use |:echohl|.
|
|
|
6715 And to get a beep: >
|
|
|
6716 :exe "normal \<Esc>"
|
|
|
6717 <
|
|
|
6718 *:exe* *:execute*
|
|
|
6719 :exe[cute] {expr1} .. Executes the string that results from the evaluation
|
|
|
6720 of {expr1} as an Ex command. Multiple arguments are
|
|
1621
|
6721 concatenated, with a space in between. {expr1} is
|
|
7
|
6722 used as the processed command, command line editing
|
|
|
6723 keys are not recognized.
|
|
|
6724 Cannot be followed by a comment.
|
|
|
6725 Examples: >
|
|
|
6726 :execute "buffer " nextbuf
|
|
|
6727 :execute "normal " count . "w"
|
|
|
6728 <
|
|
|
6729 ":execute" can be used to append a command to commands
|
|
|
6730 that don't accept a '|'. Example: >
|
|
|
6731 :execute '!ls' | echo "theend"
|
|
|
6732
|
|
|
6733 < ":execute" is also a nice way to avoid having to type
|
|
|
6734 control characters in a Vim script for a ":normal"
|
|
|
6735 command: >
|
|
|
6736 :execute "normal ixxx\<Esc>"
|
|
|
6737 < This has an <Esc> character, see |expr-string|.
|
|
|
6738
|
|
1621
|
6739 Be careful to correctly escape special characters in
|
|
|
6740 file names. The |fnameescape()| function can be used
|
|
|
6741 for this. Example: >
|
|
|
6742 :execute "e " . fnameescape(filename)
|
|
|
6743 <
|
|
7
|
6744 Note: The executed string may be any command-line, but
|
|
99
|
6745 you cannot start or end a "while", "for" or "if"
|
|
|
6746 command. Thus this is illegal: >
|
|
7
|
6747 :execute 'while i > 5'
|
|
|
6748 :execute 'echo "test" | break'
|
|
|
6749 <
|
|
|
6750 It is allowed to have a "while" or "if" command
|
|
|
6751 completely in the executed string: >
|
|
|
6752 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
|
|
|
6753 <
|
|
|
6754
|
|
|
6755 *:comment*
|
|
|
6756 ":execute", ":echo" and ":echon" cannot be followed by
|
|
|
6757 a comment directly, because they see the '"' as the
|
|
|
6758 start of a string. But, you can use '|' followed by a
|
|
|
6759 comment. Example: >
|
|
|
6760 :echo "foo" | "this is a comment
|
|
|
6761
|
|
|
6762 ==============================================================================
|
|
|
6763 8. Exception handling *exception-handling*
|
|
|
6764
|
|
|
6765 The Vim script language comprises an exception handling feature. This section
|
|
|
6766 explains how it can be used in a Vim script.
|
|
|
6767
|
|
|
6768 Exceptions may be raised by Vim on an error or on interrupt, see
|
|
|
6769 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
|
|
|
6770 exception by using the ":throw" command, see |throw-catch|.
|
|
|
6771
|
|
|
6772
|
|
|
6773 TRY CONDITIONALS *try-conditionals*
|
|
|
6774
|
|
|
6775 Exceptions can be caught or can cause cleanup code to be executed. You can
|
|
|
6776 use a try conditional to specify catch clauses (that catch exceptions) and/or
|
|
|
6777 a finally clause (to be executed for cleanup).
|
|
|
6778 A try conditional begins with a |:try| command and ends at the matching
|
|
|
6779 |:endtry| command. In between, you can use a |:catch| command to start
|
|
|
6780 a catch clause, or a |:finally| command to start a finally clause. There may
|
|
|
6781 be none or multiple catch clauses, but there is at most one finally clause,
|
|
|
6782 which must not be followed by any catch clauses. The lines before the catch
|
|
|
6783 clauses and the finally clause is called a try block. >
|
|
|
6784
|
|
|
6785 :try
|
|
1621
|
6786 : ...
|
|
|
6787 : ... TRY BLOCK
|
|
|
6788 : ...
|
|
7
|
6789 :catch /{pattern}/
|
|
1621
|
6790 : ...
|
|
|
6791 : ... CATCH CLAUSE
|
|
|
6792 : ...
|
|
7
|
6793 :catch /{pattern}/
|
|
1621
|
6794 : ...
|
|
|
6795 : ... CATCH CLAUSE
|
|
|
6796 : ...
|
|
7
|
6797 :finally
|
|
1621
|
6798 : ...
|
|
|
6799 : ... FINALLY CLAUSE
|
|
|
6800 : ...
|
|
7
|
6801 :endtry
|
|
|
6802
|
|
|
6803 The try conditional allows to watch code for exceptions and to take the
|
|
|
6804 appropriate actions. Exceptions from the try block may be caught. Exceptions
|
|
|
6805 from the try block and also the catch clauses may cause cleanup actions.
|
|
|
6806 When no exception is thrown during execution of the try block, the control
|
|
|
6807 is transferred to the finally clause, if present. After its execution, the
|
|
|
6808 script continues with the line following the ":endtry".
|
|
|
6809 When an exception occurs during execution of the try block, the remaining
|
|
|
6810 lines in the try block are skipped. The exception is matched against the
|
|
|
6811 patterns specified as arguments to the ":catch" commands. The catch clause
|
|
|
6812 after the first matching ":catch" is taken, other catch clauses are not
|
|
|
6813 executed. The catch clause ends when the next ":catch", ":finally", or
|
|
|
6814 ":endtry" command is reached - whatever is first. Then, the finally clause
|
|
|
6815 (if present) is executed. When the ":endtry" is reached, the script execution
|
|
|
6816 continues in the following line as usual.
|
|
|
6817 When an exception that does not match any of the patterns specified by the
|
|
|
6818 ":catch" commands is thrown in the try block, the exception is not caught by
|
|
|
6819 that try conditional and none of the catch clauses is executed. Only the
|
|
|
6820 finally clause, if present, is taken. The exception pends during execution of
|
|
|
6821 the finally clause. It is resumed at the ":endtry", so that commands after
|
|
|
6822 the ":endtry" are not executed and the exception might be caught elsewhere,
|
|
|
6823 see |try-nesting|.
|
|
|
6824 When during execution of a catch clause another exception is thrown, the
|
|
1621
|
6825 remaining lines in that catch clause are not executed. The new exception is
|
|
7
|
6826 not matched against the patterns in any of the ":catch" commands of the same
|
|
|
6827 try conditional and none of its catch clauses is taken. If there is, however,
|
|
|
6828 a finally clause, it is executed, and the exception pends during its
|
|
|
6829 execution. The commands following the ":endtry" are not executed. The new
|
|
|
6830 exception might, however, be caught elsewhere, see |try-nesting|.
|
|
|
6831 When during execution of the finally clause (if present) an exception is
|
|
1621
|
6832 thrown, the remaining lines in the finally clause are skipped. If the finally
|
|
7
|
6833 clause has been taken because of an exception from the try block or one of the
|
|
|
6834 catch clauses, the original (pending) exception is discarded. The commands
|
|
|
6835 following the ":endtry" are not executed, and the exception from the finally
|
|
|
6836 clause is propagated and can be caught elsewhere, see |try-nesting|.
|
|
|
6837
|
|
|
6838 The finally clause is also executed, when a ":break" or ":continue" for
|
|
|
6839 a ":while" loop enclosing the complete try conditional is executed from the
|
|
|
6840 try block or a catch clause. Or when a ":return" or ":finish" is executed
|
|
|
6841 from the try block or a catch clause of a try conditional in a function or
|
|
|
6842 sourced script, respectively. The ":break", ":continue", ":return", or
|
|
|
6843 ":finish" pends during execution of the finally clause and is resumed when the
|
|
|
6844 ":endtry" is reached. It is, however, discarded when an exception is thrown
|
|
|
6845 from the finally clause.
|
|
|
6846 When a ":break" or ":continue" for a ":while" loop enclosing the complete
|
|
|
6847 try conditional or when a ":return" or ":finish" is encountered in the finally
|
|
|
6848 clause, the rest of the finally clause is skipped, and the ":break",
|
|
|
6849 ":continue", ":return" or ":finish" is executed as usual. If the finally
|
|
|
6850 clause has been taken because of an exception or an earlier ":break",
|
|
|
6851 ":continue", ":return", or ":finish" from the try block or a catch clause,
|
|
|
6852 this pending exception or command is discarded.
|
|
|
6853
|
|
|
6854 For examples see |throw-catch| and |try-finally|.
|
|
|
6855
|
|
|
6856
|
|
|
6857 NESTING OF TRY CONDITIONALS *try-nesting*
|
|
|
6858
|
|
|
6859 Try conditionals can be nested arbitrarily. That is, a complete try
|
|
|
6860 conditional can be put into the try block, a catch clause, or the finally
|
|
|
6861 clause of another try conditional. If the inner try conditional does not
|
|
|
6862 catch an exception thrown in its try block or throws a new exception from one
|
|
|
6863 of its catch clauses or its finally clause, the outer try conditional is
|
|
|
6864 checked according to the rules above. If the inner try conditional is in the
|
|
|
6865 try block of the outer try conditional, its catch clauses are checked, but
|
|
1621
|
6866 otherwise only the finally clause is executed. It does not matter for
|
|
7
|
6867 nesting, whether the inner try conditional is directly contained in the outer
|
|
|
6868 one, or whether the outer one sources a script or calls a function containing
|
|
|
6869 the inner try conditional.
|
|
|
6870
|
|
|
6871 When none of the active try conditionals catches an exception, just their
|
|
|
6872 finally clauses are executed. Thereafter, the script processing terminates.
|
|
|
6873 An error message is displayed in case of an uncaught exception explicitly
|
|
|
6874 thrown by a ":throw" command. For uncaught error and interrupt exceptions
|
|
|
6875 implicitly raised by Vim, the error message(s) or interrupt message are shown
|
|
|
6876 as usual.
|
|
|
6877
|
|
|
6878 For examples see |throw-catch|.
|
|
|
6879
|
|
|
6880
|
|
|
6881 EXAMINING EXCEPTION HANDLING CODE *except-examine*
|
|
|
6882
|
|
|
6883 Exception handling code can get tricky. If you are in doubt what happens, set
|
|
|
6884 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
|
|
|
6885 script file. Then you see when an exception is thrown, discarded, caught, or
|
|
|
6886 finished. When using a verbosity level of at least 14, things pending in
|
|
|
6887 a finally clause are also shown. This information is also given in debug mode
|
|
|
6888 (see |debug-scripts|).
|
|
|
6889
|
|
|
6890
|
|
|
6891 THROWING AND CATCHING EXCEPTIONS *throw-catch*
|
|
|
6892
|
|
|
6893 You can throw any number or string as an exception. Use the |:throw| command
|
|
|
6894 and pass the value to be thrown as argument: >
|
|
|
6895 :throw 4711
|
|
|
6896 :throw "string"
|
|
|
6897 < *throw-expression*
|
|
|
6898 You can also specify an expression argument. The expression is then evaluated
|
|
|
6899 first, and the result is thrown: >
|
|
|
6900 :throw 4705 + strlen("string")
|
|
|
6901 :throw strpart("strings", 0, 6)
|
|
|
6902
|
|
|
6903 An exception might be thrown during evaluation of the argument of the ":throw"
|
|
|
6904 command. Unless it is caught there, the expression evaluation is abandoned.
|
|
|
6905 The ":throw" command then does not throw a new exception.
|
|
|
6906 Example: >
|
|
|
6907
|
|
|
6908 :function! Foo(arg)
|
|
|
6909 : try
|
|
|
6910 : throw a:arg
|
|
|
6911 : catch /foo/
|
|
|
6912 : endtry
|
|
|
6913 : return 1
|
|
|
6914 :endfunction
|
|
|
6915 :
|
|
|
6916 :function! Bar()
|
|
|
6917 : echo "in Bar"
|
|
|
6918 : return 4710
|
|
|
6919 :endfunction
|
|
|
6920 :
|
|
|
6921 :throw Foo("arrgh") + Bar()
|
|
|
6922
|
|
|
6923 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
|
|
|
6924 executed. >
|
|
|
6925 :throw Foo("foo") + Bar()
|
|
|
6926 however displays "in Bar" and throws 4711.
|
|
|
6927
|
|
|
6928 Any other command that takes an expression as argument might also be
|
|
1621
|
6929 abandoned by an (uncaught) exception during the expression evaluation. The
|
|
7
|
6930 exception is then propagated to the caller of the command.
|
|
|
6931 Example: >
|
|
|
6932
|
|
|
6933 :if Foo("arrgh")
|
|
|
6934 : echo "then"
|
|
|
6935 :else
|
|
|
6936 : echo "else"
|
|
|
6937 :endif
|
|
|
6938
|
|
|
6939 Here neither of "then" or "else" is displayed.
|
|
|
6940
|
|
|
6941 *catch-order*
|
|
|
6942 Exceptions can be caught by a try conditional with one or more |:catch|
|
|
|
6943 commands, see |try-conditionals|. The values to be caught by each ":catch"
|
|
|
6944 command can be specified as a pattern argument. The subsequent catch clause
|
|
|
6945 gets executed when a matching exception is caught.
|
|
|
6946 Example: >
|
|
|
6947
|
|
|
6948 :function! Foo(value)
|
|
|
6949 : try
|
|
|
6950 : throw a:value
|
|
|
6951 : catch /^\d\+$/
|
|
|
6952 : echo "Number thrown"
|
|
|
6953 : catch /.*/
|
|
|
6954 : echo "String thrown"
|
|
|
6955 : endtry
|
|
|
6956 :endfunction
|
|
|
6957 :
|
|
|
6958 :call Foo(0x1267)
|
|
|
6959 :call Foo('string')
|
|
|
6960
|
|
|
6961 The first call to Foo() displays "Number thrown", the second "String thrown".
|
|
|
6962 An exception is matched against the ":catch" commands in the order they are
|
|
|
6963 specified. Only the first match counts. So you should place the more
|
|
|
6964 specific ":catch" first. The following order does not make sense: >
|
|
|
6965
|
|
|
6966 : catch /.*/
|
|
|
6967 : echo "String thrown"
|
|
|
6968 : catch /^\d\+$/
|
|
|
6969 : echo "Number thrown"
|
|
|
6970
|
|
|
6971 The first ":catch" here matches always, so that the second catch clause is
|
|
|
6972 never taken.
|
|
|
6973
|
|
|
6974 *throw-variables*
|
|
|
6975 If you catch an exception by a general pattern, you may access the exact value
|
|
|
6976 in the variable |v:exception|: >
|
|
|
6977
|
|
|
6978 : catch /^\d\+$/
|
|
|
6979 : echo "Number thrown. Value is" v:exception
|
|
|
6980
|
|
|
6981 You may also be interested where an exception was thrown. This is stored in
|
|
|
6982 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
|
|
|
6983 exception most recently caught as long it is not finished.
|
|
|
6984 Example: >
|
|
|
6985
|
|
|
6986 :function! Caught()
|
|
|
6987 : if v:exception != ""
|
|
|
6988 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
|
|
|
6989 : else
|
|
|
6990 : echo 'Nothing caught'
|
|
|
6991 : endif
|
|
|
6992 :endfunction
|
|
|
6993 :
|
|
|
6994 :function! Foo()
|
|
|
6995 : try
|
|
|
6996 : try
|
|
|
6997 : try
|
|
|
6998 : throw 4711
|
|
|
6999 : finally
|
|
|
7000 : call Caught()
|
|
|
7001 : endtry
|
|
|
7002 : catch /.*/
|
|
|
7003 : call Caught()
|
|
|
7004 : throw "oops"
|
|
|
7005 : endtry
|
|
|
7006 : catch /.*/
|
|
|
7007 : call Caught()
|
|
|
7008 : finally
|
|
|
7009 : call Caught()
|
|
|
7010 : endtry
|
|
|
7011 :endfunction
|
|
|
7012 :
|
|
|
7013 :call Foo()
|
|
|
7014
|
|
|
7015 This displays >
|
|
|
7016
|
|
|
7017 Nothing caught
|
|
|
7018 Caught "4711" in function Foo, line 4
|
|
|
7019 Caught "oops" in function Foo, line 10
|
|
|
7020 Nothing caught
|
|
|
7021
|
|
|
7022 A practical example: The following command ":LineNumber" displays the line
|
|
|
7023 number in the script or function where it has been used: >
|
|
|
7024
|
|
|
7025 :function! LineNumber()
|
|
|
7026 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
|
|
|
7027 :endfunction
|
|
|
7028 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
|
|
|
7029 <
|
|
|
7030 *try-nested*
|
|
|
7031 An exception that is not caught by a try conditional can be caught by
|
|
|
7032 a surrounding try conditional: >
|
|
|
7033
|
|
|
7034 :try
|
|
|
7035 : try
|
|
|
7036 : throw "foo"
|
|
|
7037 : catch /foobar/
|
|
|
7038 : echo "foobar"
|
|
|
7039 : finally
|
|
|
7040 : echo "inner finally"
|
|
|
7041 : endtry
|
|
|
7042 :catch /foo/
|
|
|
7043 : echo "foo"
|
|
|
7044 :endtry
|
|
|
7045
|
|
|
7046 The inner try conditional does not catch the exception, just its finally
|
|
|
7047 clause is executed. The exception is then caught by the outer try
|
|
|
7048 conditional. The example displays "inner finally" and then "foo".
|
|
|
7049
|
|
|
7050 *throw-from-catch*
|
|
|
7051 You can catch an exception and throw a new one to be caught elsewhere from the
|
|
|
7052 catch clause: >
|
|
|
7053
|
|
|
7054 :function! Foo()
|
|
|
7055 : throw "foo"
|
|
|
7056 :endfunction
|
|
|
7057 :
|
|
|
7058 :function! Bar()
|
|
|
7059 : try
|
|
|
7060 : call Foo()
|
|
|
7061 : catch /foo/
|
|
|
7062 : echo "Caught foo, throw bar"
|
|
|
7063 : throw "bar"
|
|
|
7064 : endtry
|
|
|
7065 :endfunction
|
|
|
7066 :
|
|
|
7067 :try
|
|
|
7068 : call Bar()
|
|
|
7069 :catch /.*/
|
|
|
7070 : echo "Caught" v:exception
|
|
|
7071 :endtry
|
|
|
7072
|
|
|
7073 This displays "Caught foo, throw bar" and then "Caught bar".
|
|
|
7074
|
|
|
7075 *rethrow*
|
|
|
7076 There is no real rethrow in the Vim script language, but you may throw
|
|
|
7077 "v:exception" instead: >
|
|
|
7078
|
|
|
7079 :function! Bar()
|
|
|
7080 : try
|
|
|
7081 : call Foo()
|
|
|
7082 : catch /.*/
|
|
|
7083 : echo "Rethrow" v:exception
|
|
|
7084 : throw v:exception
|
|
|
7085 : endtry
|
|
|
7086 :endfunction
|
|
|
7087 < *try-echoerr*
|
|
|
7088 Note that this method cannot be used to "rethrow" Vim error or interrupt
|
|
|
7089 exceptions, because it is not possible to fake Vim internal exceptions.
|
|
|
7090 Trying so causes an error exception. You should throw your own exception
|
|
|
7091 denoting the situation. If you want to cause a Vim error exception containing
|
|
|
7092 the original error exception value, you can use the |:echoerr| command: >
|
|
|
7093
|
|
|
7094 :try
|
|
|
7095 : try
|
|
|
7096 : asdf
|
|
|
7097 : catch /.*/
|
|
|
7098 : echoerr v:exception
|
|
|
7099 : endtry
|
|
|
7100 :catch /.*/
|
|
|
7101 : echo v:exception
|
|
|
7102 :endtry
|
|
|
7103
|
|
|
7104 This code displays
|
|
|
7105
|
|
1621
|
7106 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
|
|
7
|
7107
|
|
|
7108
|
|
|
7109 CLEANUP CODE *try-finally*
|
|
|
7110
|
|
|
7111 Scripts often change global settings and restore them at their end. If the
|
|
|
7112 user however interrupts the script by pressing CTRL-C, the settings remain in
|
|
1621
|
7113 an inconsistent state. The same may happen to you in the development phase of
|
|
7
|
7114 a script when an error occurs or you explicitly throw an exception without
|
|
|
7115 catching it. You can solve these problems by using a try conditional with
|
|
|
7116 a finally clause for restoring the settings. Its execution is guaranteed on
|
|
|
7117 normal control flow, on error, on an explicit ":throw", and on interrupt.
|
|
|
7118 (Note that errors and interrupts from inside the try conditional are converted
|
|
1621
|
7119 to exceptions. When not caught, they terminate the script after the finally
|
|
7
|
7120 clause has been executed.)
|
|
|
7121 Example: >
|
|
|
7122
|
|
|
7123 :try
|
|
|
7124 : let s:saved_ts = &ts
|
|
|
7125 : set ts=17
|
|
|
7126 :
|
|
|
7127 : " Do the hard work here.
|
|
|
7128 :
|
|
|
7129 :finally
|
|
|
7130 : let &ts = s:saved_ts
|
|
|
7131 : unlet s:saved_ts
|
|
|
7132 :endtry
|
|
|
7133
|
|
|
7134 This method should be used locally whenever a function or part of a script
|
|
|
7135 changes global settings which need to be restored on failure or normal exit of
|
|
|
7136 that function or script part.
|
|
|
7137
|
|
|
7138 *break-finally*
|
|
|
7139 Cleanup code works also when the try block or a catch clause is left by
|
|
|
7140 a ":continue", ":break", ":return", or ":finish".
|
|
|
7141 Example: >
|
|
|
7142
|
|
|
7143 :let first = 1
|
|
|
7144 :while 1
|
|
|
7145 : try
|
|
|
7146 : if first
|
|
|
7147 : echo "first"
|
|
|
7148 : let first = 0
|
|
|
7149 : continue
|
|
|
7150 : else
|
|
|
7151 : throw "second"
|
|
|
7152 : endif
|
|
|
7153 : catch /.*/
|
|
|
7154 : echo v:exception
|
|
|
7155 : break
|
|
|
7156 : finally
|
|
|
7157 : echo "cleanup"
|
|
|
7158 : endtry
|
|
|
7159 : echo "still in while"
|
|
|
7160 :endwhile
|
|
|
7161 :echo "end"
|
|
|
7162
|
|
|
7163 This displays "first", "cleanup", "second", "cleanup", and "end". >
|
|
|
7164
|
|
|
7165 :function! Foo()
|
|
|
7166 : try
|
|
|
7167 : return 4711
|
|
|
7168 : finally
|
|
|
7169 : echo "cleanup\n"
|
|
|
7170 : endtry
|
|
|
7171 : echo "Foo still active"
|
|
|
7172 :endfunction
|
|
|
7173 :
|
|
|
7174 :echo Foo() "returned by Foo"
|
|
|
7175
|
|
|
7176 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
|
|
1621
|
7177 extra ":return" in the finally clause. (Above all, this would override the
|
|
7
|
7178 return value.)
|
|
|
7179
|
|
|
7180 *except-from-finally*
|
|
|
7181 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
|
|
|
7182 a finally clause is possible, but not recommended since it abandons the
|
|
|
7183 cleanup actions for the try conditional. But, of course, interrupt and error
|
|
|
7184 exceptions might get raised from a finally clause.
|
|
|
7185 Example where an error in the finally clause stops an interrupt from
|
|
|
7186 working correctly: >
|
|
|
7187
|
|
|
7188 :try
|
|
|
7189 : try
|
|
|
7190 : echo "Press CTRL-C for interrupt"
|
|
|
7191 : while 1
|
|
|
7192 : endwhile
|
|
|
7193 : finally
|
|
|
7194 : unlet novar
|
|
|
7195 : endtry
|
|
|
7196 :catch /novar/
|
|
|
7197 :endtry
|
|
|
7198 :echo "Script still running"
|
|
|
7199 :sleep 1
|
|
|
7200
|
|
|
7201 If you need to put commands that could fail into a finally clause, you should
|
|
|
7202 think about catching or ignoring the errors in these commands, see
|
|
|
7203 |catch-errors| and |ignore-errors|.
|
|
|
7204
|
|
|
7205
|
|
|
7206 CATCHING ERRORS *catch-errors*
|
|
|
7207
|
|
|
7208 If you want to catch specific errors, you just have to put the code to be
|
|
|
7209 watched in a try block and add a catch clause for the error message. The
|
|
|
7210 presence of the try conditional causes all errors to be converted to an
|
|
|
7211 exception. No message is displayed and |v:errmsg| is not set then. To find
|
|
|
7212 the right pattern for the ":catch" command, you have to know how the format of
|
|
|
7213 the error exception is.
|
|
|
7214 Error exceptions have the following format: >
|
|
|
7215
|
|
|
7216 Vim({cmdname}):{errmsg}
|
|
|
7217 or >
|
|
|
7218 Vim:{errmsg}
|
|
|
7219
|
|
|
7220 {cmdname} is the name of the command that failed; the second form is used when
|
|
1621
|
7221 the command name is not known. {errmsg} is the error message usually produced
|
|
7
|
7222 when the error occurs outside try conditionals. It always begins with
|
|
|
7223 a capital "E", followed by a two or three-digit error number, a colon, and
|
|
|
7224 a space.
|
|
|
7225
|
|
|
7226 Examples:
|
|
|
7227
|
|
|
7228 The command >
|
|
|
7229 :unlet novar
|
|
|
7230 normally produces the error message >
|
|
|
7231 E108: No such variable: "novar"
|
|
|
7232 which is converted inside try conditionals to an exception >
|
|
|
7233 Vim(unlet):E108: No such variable: "novar"
|
|
|
7234
|
|
|
7235 The command >
|
|
|
7236 :dwim
|
|
|
7237 normally produces the error message >
|
|
|
7238 E492: Not an editor command: dwim
|
|
|
7239 which is converted inside try conditionals to an exception >
|
|
|
7240 Vim:E492: Not an editor command: dwim
|
|
|
7241
|
|
|
7242 You can catch all ":unlet" errors by a >
|
|
|
7243 :catch /^Vim(unlet):/
|
|
|
7244 or all errors for misspelled command names by a >
|
|
|
7245 :catch /^Vim:E492:/
|
|
|
7246
|
|
|
7247 Some error messages may be produced by different commands: >
|
|
|
7248 :function nofunc
|
|
|
7249 and >
|
|
|
7250 :delfunction nofunc
|
|
|
7251 both produce the error message >
|
|
|
7252 E128: Function name must start with a capital: nofunc
|
|
|
7253 which is converted inside try conditionals to an exception >
|
|
|
7254 Vim(function):E128: Function name must start with a capital: nofunc
|
|
|
7255 or >
|
|
|
7256 Vim(delfunction):E128: Function name must start with a capital: nofunc
|
|
|
7257 respectively. You can catch the error by its number independently on the
|
|
|
7258 command that caused it if you use the following pattern: >
|
|
|
7259 :catch /^Vim(\a\+):E128:/
|
|
|
7260
|
|
|
7261 Some commands like >
|
|
|
7262 :let x = novar
|
|
|
7263 produce multiple error messages, here: >
|
|
|
7264 E121: Undefined variable: novar
|
|
|
7265 E15: Invalid expression: novar
|
|
|
7266 Only the first is used for the exception value, since it is the most specific
|
|
|
7267 one (see |except-several-errors|). So you can catch it by >
|
|
|
7268 :catch /^Vim(\a\+):E121:/
|
|
|
7269
|
|
|
7270 You can catch all errors related to the name "nofunc" by >
|
|
|
7271 :catch /\<nofunc\>/
|
|
|
7272
|
|
|
7273 You can catch all Vim errors in the ":write" and ":read" commands by >
|
|
|
7274 :catch /^Vim(\(write\|read\)):E\d\+:/
|
|
|
7275
|
|
|
7276 You can catch all Vim errors by the pattern >
|
|
|
7277 :catch /^Vim\((\a\+)\)\=:E\d\+:/
|
|
|
7278 <
|
|
|
7279 *catch-text*
|
|
|
7280 NOTE: You should never catch the error message text itself: >
|
|
|
7281 :catch /No such variable/
|
|
|
7282 only works in the english locale, but not when the user has selected
|
|
|
7283 a different language by the |:language| command. It is however helpful to
|
|
|
7284 cite the message text in a comment: >
|
|
|
7285 :catch /^Vim(\a\+):E108:/ " No such variable
|
|
|
7286
|
|
|
7287
|
|
|
7288 IGNORING ERRORS *ignore-errors*
|
|
|
7289
|
|
|
7290 You can ignore errors in a specific Vim command by catching them locally: >
|
|
|
7291
|
|
|
7292 :try
|
|
|
7293 : write
|
|
|
7294 :catch
|
|
|
7295 :endtry
|
|
|
7296
|
|
|
7297 But you are strongly recommended NOT to use this simple form, since it could
|
|
|
7298 catch more than you want. With the ":write" command, some autocommands could
|
|
|
7299 be executed and cause errors not related to writing, for instance: >
|
|
|
7300
|
|
|
7301 :au BufWritePre * unlet novar
|
|
|
7302
|
|
|
7303 There could even be such errors you are not responsible for as a script
|
|
|
7304 writer: a user of your script might have defined such autocommands. You would
|
|
|
7305 then hide the error from the user.
|
|
|
7306 It is much better to use >
|
|
|
7307
|
|
|
7308 :try
|
|
|
7309 : write
|
|
|
7310 :catch /^Vim(write):/
|
|
|
7311 :endtry
|
|
|
7312
|
|
|
7313 which only catches real write errors. So catch only what you'd like to ignore
|
|
|
7314 intentionally.
|
|
|
7315
|
|
|
7316 For a single command that does not cause execution of autocommands, you could
|
|
|
7317 even suppress the conversion of errors to exceptions by the ":silent!"
|
|
|
7318 command: >
|
|
|
7319 :silent! nunmap k
|
|
|
7320 This works also when a try conditional is active.
|
|
|
7321
|
|
|
7322
|
|
|
7323 CATCHING INTERRUPTS *catch-interrupt*
|
|
|
7324
|
|
|
7325 When there are active try conditionals, an interrupt (CTRL-C) is converted to
|
|
1621
|
7326 the exception "Vim:Interrupt". You can catch it like every exception. The
|
|
7
|
7327 script is not terminated, then.
|
|
|
7328 Example: >
|
|
|
7329
|
|
|
7330 :function! TASK1()
|
|
|
7331 : sleep 10
|
|
|
7332 :endfunction
|
|
|
7333
|
|
|
7334 :function! TASK2()
|
|
|
7335 : sleep 20
|
|
|
7336 :endfunction
|
|
|
7337
|
|
|
7338 :while 1
|
|
|
7339 : let command = input("Type a command: ")
|
|
|
7340 : try
|
|
|
7341 : if command == ""
|
|
|
7342 : continue
|
|
|
7343 : elseif command == "END"
|
|
|
7344 : break
|
|
|
7345 : elseif command == "TASK1"
|
|
|
7346 : call TASK1()
|
|
|
7347 : elseif command == "TASK2"
|
|
|
7348 : call TASK2()
|
|
|
7349 : else
|
|
|
7350 : echo "\nIllegal command:" command
|
|
|
7351 : continue
|
|
|
7352 : endif
|
|
|
7353 : catch /^Vim:Interrupt$/
|
|
|
7354 : echo "\nCommand interrupted"
|
|
|
7355 : " Caught the interrupt. Continue with next prompt.
|
|
|
7356 : endtry
|
|
|
7357 :endwhile
|
|
|
7358
|
|
|
7359 You can interrupt a task here by pressing CTRL-C; the script then asks for
|
|
1621
|
7360 a new command. If you press CTRL-C at the prompt, the script is terminated.
|
|
7
|
7361
|
|
|
7362 For testing what happens when CTRL-C would be pressed on a specific line in
|
|
|
7363 your script, use the debug mode and execute the |>quit| or |>interrupt|
|
|
|
7364 command on that line. See |debug-scripts|.
|
|
|
7365
|
|
|
7366
|
|
|
7367 CATCHING ALL *catch-all*
|
|
|
7368
|
|
|
7369 The commands >
|
|
|
7370
|
|
|
7371 :catch /.*/
|
|
|
7372 :catch //
|
|
|
7373 :catch
|
|
|
7374
|
|
|
7375 catch everything, error exceptions, interrupt exceptions and exceptions
|
|
|
7376 explicitly thrown by the |:throw| command. This is useful at the top level of
|
|
|
7377 a script in order to catch unexpected things.
|
|
|
7378 Example: >
|
|
|
7379
|
|
|
7380 :try
|
|
|
7381 :
|
|
|
7382 : " do the hard work here
|
|
|
7383 :
|
|
|
7384 :catch /MyException/
|
|
|
7385 :
|
|
|
7386 : " handle known problem
|
|
|
7387 :
|
|
|
7388 :catch /^Vim:Interrupt$/
|
|
|
7389 : echo "Script interrupted"
|
|
|
7390 :catch /.*/
|
|
|
7391 : echo "Internal error (" . v:exception . ")"
|
|
|
7392 : echo " - occurred at " . v:throwpoint
|
|
|
7393 :endtry
|
|
|
7394 :" end of script
|
|
|
7395
|
|
|
7396 Note: Catching all might catch more things than you want. Thus, you are
|
|
|
7397 strongly encouraged to catch only for problems that you can really handle by
|
|
|
7398 specifying a pattern argument to the ":catch".
|
|
|
7399 Example: Catching all could make it nearly impossible to interrupt a script
|
|
|
7400 by pressing CTRL-C: >
|
|
|
7401
|
|
|
7402 :while 1
|
|
|
7403 : try
|
|
|
7404 : sleep 1
|
|
|
7405 : catch
|
|
|
7406 : endtry
|
|
|
7407 :endwhile
|
|
|
7408
|
|
|
7409
|
|
|
7410 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
|
|
|
7411
|
|
|
7412 Exceptions may be used during execution of autocommands. Example: >
|
|
|
7413
|
|
|
7414 :autocmd User x try
|
|
|
7415 :autocmd User x throw "Oops!"
|
|
|
7416 :autocmd User x catch
|
|
|
7417 :autocmd User x echo v:exception
|
|
|
7418 :autocmd User x endtry
|
|
|
7419 :autocmd User x throw "Arrgh!"
|
|
|
7420 :autocmd User x echo "Should not be displayed"
|
|
|
7421 :
|
|
|
7422 :try
|
|
|
7423 : doautocmd User x
|
|
|
7424 :catch
|
|
|
7425 : echo v:exception
|
|
|
7426 :endtry
|
|
|
7427
|
|
|
7428 This displays "Oops!" and "Arrgh!".
|
|
|
7429
|
|
|
7430 *except-autocmd-Pre*
|
|
|
7431 For some commands, autocommands get executed before the main action of the
|
|
|
7432 command takes place. If an exception is thrown and not caught in the sequence
|
|
|
7433 of autocommands, the sequence and the command that caused its execution are
|
|
|
7434 abandoned and the exception is propagated to the caller of the command.
|
|
|
7435 Example: >
|
|
|
7436
|
|
|
7437 :autocmd BufWritePre * throw "FAIL"
|
|
|
7438 :autocmd BufWritePre * echo "Should not be displayed"
|
|
|
7439 :
|
|
|
7440 :try
|
|
|
7441 : write
|
|
|
7442 :catch
|
|
|
7443 : echo "Caught:" v:exception "from" v:throwpoint
|
|
|
7444 :endtry
|
|
|
7445
|
|
|
7446 Here, the ":write" command does not write the file currently being edited (as
|
|
|
7447 you can see by checking 'modified'), since the exception from the BufWritePre
|
|
|
7448 autocommand abandons the ":write". The exception is then caught and the
|
|
|
7449 script displays: >
|
|
|
7450
|
|
|
7451 Caught: FAIL from BufWrite Auto commands for "*"
|
|
|
7452 <
|
|
|
7453 *except-autocmd-Post*
|
|
|
7454 For some commands, autocommands get executed after the main action of the
|
|
|
7455 command has taken place. If this main action fails and the command is inside
|
|
|
7456 an active try conditional, the autocommands are skipped and an error exception
|
|
|
7457 is thrown that can be caught by the caller of the command.
|
|
|
7458 Example: >
|
|
|
7459
|
|
|
7460 :autocmd BufWritePost * echo "File successfully written!"
|
|
|
7461 :
|
|
|
7462 :try
|
|
|
7463 : write /i/m/p/o/s/s/i/b/l/e
|
|
|
7464 :catch
|
|
|
7465 : echo v:exception
|
|
|
7466 :endtry
|
|
|
7467
|
|
|
7468 This just displays: >
|
|
|
7469
|
|
|
7470 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
|
|
|
7471
|
|
|
7472 If you really need to execute the autocommands even when the main action
|
|
|
7473 fails, trigger the event from the catch clause.
|
|
|
7474 Example: >
|
|
|
7475
|
|
|
7476 :autocmd BufWritePre * set noreadonly
|
|
|
7477 :autocmd BufWritePost * set readonly
|
|
|
7478 :
|
|
|
7479 :try
|
|
|
7480 : write /i/m/p/o/s/s/i/b/l/e
|
|
|
7481 :catch
|
|
|
7482 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
|
|
|
7483 :endtry
|
|
|
7484 <
|
|
|
7485 You can also use ":silent!": >
|
|
|
7486
|
|
|
7487 :let x = "ok"
|
|
|
7488 :let v:errmsg = ""
|
|
|
7489 :autocmd BufWritePost * if v:errmsg != ""
|
|
|
7490 :autocmd BufWritePost * let x = "after fail"
|
|
|
7491 :autocmd BufWritePost * endif
|
|
|
7492 :try
|
|
|
7493 : silent! write /i/m/p/o/s/s/i/b/l/e
|
|
|
7494 :catch
|
|
|
7495 :endtry
|
|
|
7496 :echo x
|
|
|
7497
|
|
|
7498 This displays "after fail".
|
|
|
7499
|
|
|
7500 If the main action of the command does not fail, exceptions from the
|
|
|
7501 autocommands will be catchable by the caller of the command: >
|
|
|
7502
|
|
|
7503 :autocmd BufWritePost * throw ":-("
|
|
|
7504 :autocmd BufWritePost * echo "Should not be displayed"
|
|
|
7505 :
|
|
|
7506 :try
|
|
|
7507 : write
|
|
|
7508 :catch
|
|
|
7509 : echo v:exception
|
|
|
7510 :endtry
|
|
|
7511 <
|
|
|
7512 *except-autocmd-Cmd*
|
|
|
7513 For some commands, the normal action can be replaced by a sequence of
|
|
|
7514 autocommands. Exceptions from that sequence will be catchable by the caller
|
|
|
7515 of the command.
|
|
|
7516 Example: For the ":write" command, the caller cannot know whether the file
|
|
1621
|
7517 had actually been written when the exception occurred. You need to tell it in
|
|
7
|
7518 some way. >
|
|
|
7519
|
|
|
7520 :if !exists("cnt")
|
|
|
7521 : let cnt = 0
|
|
|
7522 :
|
|
|
7523 : autocmd BufWriteCmd * if &modified
|
|
|
7524 : autocmd BufWriteCmd * let cnt = cnt + 1
|
|
|
7525 : autocmd BufWriteCmd * if cnt % 3 == 2
|
|
|
7526 : autocmd BufWriteCmd * throw "BufWriteCmdError"
|
|
|
7527 : autocmd BufWriteCmd * endif
|
|
|
7528 : autocmd BufWriteCmd * write | set nomodified
|
|
|
7529 : autocmd BufWriteCmd * if cnt % 3 == 0
|
|
|
7530 : autocmd BufWriteCmd * throw "BufWriteCmdError"
|
|
|
7531 : autocmd BufWriteCmd * endif
|
|
|
7532 : autocmd BufWriteCmd * echo "File successfully written!"
|
|
|
7533 : autocmd BufWriteCmd * endif
|
|
|
7534 :endif
|
|
|
7535 :
|
|
|
7536 :try
|
|
|
7537 : write
|
|
|
7538 :catch /^BufWriteCmdError$/
|
|
|
7539 : if &modified
|
|
|
7540 : echo "Error on writing (file contents not changed)"
|
|
|
7541 : else
|
|
|
7542 : echo "Error after writing"
|
|
|
7543 : endif
|
|
|
7544 :catch /^Vim(write):/
|
|
|
7545 : echo "Error on writing"
|
|
|
7546 :endtry
|
|
|
7547
|
|
|
7548 When this script is sourced several times after making changes, it displays
|
|
|
7549 first >
|
|
|
7550 File successfully written!
|
|
|
7551 then >
|
|
|
7552 Error on writing (file contents not changed)
|
|
|
7553 then >
|
|
|
7554 Error after writing
|
|
|
7555 etc.
|
|
|
7556
|
|
|
7557 *except-autocmd-ill*
|
|
|
7558 You cannot spread a try conditional over autocommands for different events.
|
|
|
7559 The following code is ill-formed: >
|
|
|
7560
|
|
|
7561 :autocmd BufWritePre * try
|
|
|
7562 :
|
|
|
7563 :autocmd BufWritePost * catch
|
|
|
7564 :autocmd BufWritePost * echo v:exception
|
|
|
7565 :autocmd BufWritePost * endtry
|
|
|
7566 :
|
|
|
7567 :write
|
|
|
7568
|
|
|
7569
|
|
|
7570 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
|
|
|
7571
|
|
|
7572 Some programming languages allow to use hierarchies of exception classes or to
|
|
|
7573 pass additional information with the object of an exception class. You can do
|
|
|
7574 similar things in Vim.
|
|
|
7575 In order to throw an exception from a hierarchy, just throw the complete
|
|
|
7576 class name with the components separated by a colon, for instance throw the
|
|
|
7577 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
|
|
|
7578 When you want to pass additional information with your exception class, add
|
|
|
7579 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
|
|
|
7580 for an error when writing "myfile".
|
|
|
7581 With the appropriate patterns in the ":catch" command, you can catch for
|
|
|
7582 base classes or derived classes of your hierarchy. Additional information in
|
|
|
7583 parentheses can be cut out from |v:exception| with the ":substitute" command.
|
|
|
7584 Example: >
|
|
|
7585
|
|
|
7586 :function! CheckRange(a, func)
|
|
|
7587 : if a:a < 0
|
|
|
7588 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
|
|
|
7589 : endif
|
|
|
7590 :endfunction
|
|
|
7591 :
|
|
|
7592 :function! Add(a, b)
|
|
|
7593 : call CheckRange(a:a, "Add")
|
|
|
7594 : call CheckRange(a:b, "Add")
|
|
|
7595 : let c = a:a + a:b
|
|
|
7596 : if c < 0
|
|
|
7597 : throw "EXCEPT:MATHERR:OVERFLOW"
|
|
|
7598 : endif
|
|
|
7599 : return c
|
|
|
7600 :endfunction
|
|
|
7601 :
|
|
|
7602 :function! Div(a, b)
|
|
|
7603 : call CheckRange(a:a, "Div")
|
|
|
7604 : call CheckRange(a:b, "Div")
|
|
|
7605 : if (a:b == 0)
|
|
|
7606 : throw "EXCEPT:MATHERR:ZERODIV"
|
|
|
7607 : endif
|
|
|
7608 : return a:a / a:b
|
|
|
7609 :endfunction
|
|
|
7610 :
|
|
|
7611 :function! Write(file)
|
|
|
7612 : try
|
|
1621
|
7613 : execute "write" fnameescape(a:file)
|
|
7
|
7614 : catch /^Vim(write):/
|
|
|
7615 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
|
|
|
7616 : endtry
|
|
|
7617 :endfunction
|
|
|
7618 :
|
|
|
7619 :try
|
|
|
7620 :
|
|
|
7621 : " something with arithmetics and I/O
|
|
|
7622 :
|
|
|
7623 :catch /^EXCEPT:MATHERR:RANGE/
|
|
|
7624 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
|
|
|
7625 : echo "Range error in" function
|
|
|
7626 :
|
|
|
7627 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
|
|
|
7628 : echo "Math error"
|
|
|
7629 :
|
|
|
7630 :catch /^EXCEPT:IO/
|
|
|
7631 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
|
|
|
7632 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
|
|
|
7633 : if file !~ '^/'
|
|
|
7634 : let file = dir . "/" . file
|
|
|
7635 : endif
|
|
|
7636 : echo 'I/O error for "' . file . '"'
|
|
|
7637 :
|
|
|
7638 :catch /^EXCEPT/
|
|
|
7639 : echo "Unspecified error"
|
|
|
7640 :
|
|
|
7641 :endtry
|
|
|
7642
|
|
|
7643 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
|
|
|
7644 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
|
|
|
7645 exceptions with the "Vim" prefix; they are reserved for Vim.
|
|
|
7646 Vim error exceptions are parameterized with the name of the command that
|
|
|
7647 failed, if known. See |catch-errors|.
|
|
|
7648
|
|
|
7649
|
|
|
7650 PECULIARITIES
|
|
|
7651 *except-compat*
|
|
|
7652 The exception handling concept requires that the command sequence causing the
|
|
|
7653 exception is aborted immediately and control is transferred to finally clauses
|
|
|
7654 and/or a catch clause.
|
|
|
7655
|
|
|
7656 In the Vim script language there are cases where scripts and functions
|
|
|
7657 continue after an error: in functions without the "abort" flag or in a command
|
|
|
7658 after ":silent!", control flow goes to the following line, and outside
|
|
|
7659 functions, control flow goes to the line following the outermost ":endwhile"
|
|
|
7660 or ":endif". On the other hand, errors should be catchable as exceptions
|
|
|
7661 (thus, requiring the immediate abortion).
|
|
|
7662
|
|
|
7663 This problem has been solved by converting errors to exceptions and using
|
|
|
7664 immediate abortion (if not suppressed by ":silent!") only when a try
|
|
1621
|
7665 conditional is active. This is no restriction since an (error) exception can
|
|
|
7666 be caught only from an active try conditional. If you want an immediate
|
|
7
|
7667 termination without catching the error, just use a try conditional without
|
|
|
7668 catch clause. (You can cause cleanup code being executed before termination
|
|
|
7669 by specifying a finally clause.)
|
|
|
7670
|
|
|
7671 When no try conditional is active, the usual abortion and continuation
|
|
|
7672 behavior is used instead of immediate abortion. This ensures compatibility of
|
|
|
7673 scripts written for Vim 6.1 and earlier.
|
|
|
7674
|
|
|
7675 However, when sourcing an existing script that does not use exception handling
|
|
|
7676 commands (or when calling one of its functions) from inside an active try
|
|
|
7677 conditional of a new script, you might change the control flow of the existing
|
|
|
7678 script on error. You get the immediate abortion on error and can catch the
|
|
|
7679 error in the new script. If however the sourced script suppresses error
|
|
|
7680 messages by using the ":silent!" command (checking for errors by testing
|
|
1621
|
7681 |v:errmsg| if appropriate), its execution path is not changed. The error is
|
|
|
7682 not converted to an exception. (See |:silent|.) So the only remaining cause
|
|
7
|
7683 where this happens is for scripts that don't care about errors and produce
|
|
|
7684 error messages. You probably won't want to use such code from your new
|
|
|
7685 scripts.
|
|
|
7686
|
|
|
7687 *except-syntax-err*
|
|
|
7688 Syntax errors in the exception handling commands are never caught by any of
|
|
|
7689 the ":catch" commands of the try conditional they belong to. Its finally
|
|
|
7690 clauses, however, is executed.
|
|
|
7691 Example: >
|
|
|
7692
|
|
|
7693 :try
|
|
|
7694 : try
|
|
|
7695 : throw 4711
|
|
|
7696 : catch /\(/
|
|
|
7697 : echo "in catch with syntax error"
|
|
|
7698 : catch
|
|
|
7699 : echo "inner catch-all"
|
|
|
7700 : finally
|
|
|
7701 : echo "inner finally"
|
|
|
7702 : endtry
|
|
|
7703 :catch
|
|
|
7704 : echo 'outer catch-all caught "' . v:exception . '"'
|
|
|
7705 : finally
|
|
|
7706 : echo "outer finally"
|
|
|
7707 :endtry
|
|
|
7708
|
|
|
7709 This displays: >
|
|
|
7710 inner finally
|
|
|
7711 outer catch-all caught "Vim(catch):E54: Unmatched \("
|
|
|
7712 outer finally
|
|
|
7713 The original exception is discarded and an error exception is raised, instead.
|
|
|
7714
|
|
|
7715 *except-single-line*
|
|
|
7716 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
|
|
|
7717 a single line, but then syntax errors may make it difficult to recognize the
|
|
|
7718 "catch" line, thus you better avoid this.
|
|
|
7719 Example: >
|
|
|
7720 :try | unlet! foo # | catch | endtry
|
|
|
7721 raises an error exception for the trailing characters after the ":unlet!"
|
|
|
7722 argument, but does not see the ":catch" and ":endtry" commands, so that the
|
|
|
7723 error exception is discarded and the "E488: Trailing characters" message gets
|
|
|
7724 displayed.
|
|
|
7725
|
|
|
7726 *except-several-errors*
|
|
|
7727 When several errors appear in a single command, the first error message is
|
|
|
7728 usually the most specific one and therefor converted to the error exception.
|
|
|
7729 Example: >
|
|
|
7730 echo novar
|
|
|
7731 causes >
|
|
|
7732 E121: Undefined variable: novar
|
|
|
7733 E15: Invalid expression: novar
|
|
|
7734 The value of the error exception inside try conditionals is: >
|
|
|
7735 Vim(echo):E121: Undefined variable: novar
|
|
|
7736 < *except-syntax-error*
|
|
|
7737 But when a syntax error is detected after a normal error in the same command,
|
|
|
7738 the syntax error is used for the exception being thrown.
|
|
|
7739 Example: >
|
|
|
7740 unlet novar #
|
|
|
7741 causes >
|
|
|
7742 E108: No such variable: "novar"
|
|
|
7743 E488: Trailing characters
|
|
|
7744 The value of the error exception inside try conditionals is: >
|
|
|
7745 Vim(unlet):E488: Trailing characters
|
|
|
7746 This is done because the syntax error might change the execution path in a way
|
|
|
7747 not intended by the user. Example: >
|
|
|
7748 try
|
|
|
7749 try | unlet novar # | catch | echo v:exception | endtry
|
|
|
7750 catch /.*/
|
|
|
7751 echo "outer catch:" v:exception
|
|
|
7752 endtry
|
|
|
7753 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
|
|
|
7754 a "E600: Missing :endtry" error message is given, see |except-single-line|.
|
|
|
7755
|
|
|
7756 ==============================================================================
|
|
|
7757 9. Examples *eval-examples*
|
|
|
7758
|
|
1156
|
7759 Printing in Binary ~
|
|
7
|
7760 >
|
|
1156
|
7761 :" The function Nr2Bin() returns the Hex string of a number.
|
|
|
7762 :func Nr2Bin(nr)
|
|
7
|
7763 : let n = a:nr
|
|
|
7764 : let r = ""
|
|
|
7765 : while n
|
|
1156
|
7766 : let r = '01'[n % 2] . r
|
|
|
7767 : let n = n / 2
|
|
7
|
7768 : endwhile
|
|
|
7769 : return r
|
|
|
7770 :endfunc
|
|
|
7771
|
|
1156
|
7772 :" The function String2Bin() converts each character in a string to a
|
|
|
7773 :" binary string, separated with dashes.
|
|
|
7774 :func String2Bin(str)
|
|
7
|
7775 : let out = ''
|
|
1156
|
7776 : for ix in range(strlen(a:str))
|
|
|
7777 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
|
|
|
7778 : endfor
|
|
|
7779 : return out[1:]
|
|
7
|
7780 :endfunc
|
|
|
7781
|
|
|
7782 Example of its use: >
|
|
1156
|
7783 :echo Nr2Bin(32)
|
|
|
7784 result: "100000" >
|
|
|
7785 :echo String2Bin("32")
|
|
|
7786 result: "110011-110010"
|
|
|
7787
|
|
|
7788
|
|
|
7789 Sorting lines ~
|
|
|
7790
|
|
|
7791 This example sorts lines with a specific compare function. >
|
|
|
7792
|
|
|
7793 :func SortBuffer()
|
|
|
7794 : let lines = getline(1, '$')
|
|
|
7795 : call sort(lines, function("Strcmp"))
|
|
|
7796 : call setline(1, lines)
|
|
7
|
7797 :endfunction
|
|
|
7798
|
|
1156
|
7799 As a one-liner: >
|
|
|
7800 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
|
|
|
7801
|
|
|
7802
|
|
|
7803 scanf() replacement ~
|
|
7
|
7804 *sscanf*
|
|
|
7805 There is no sscanf() function in Vim. If you need to extract parts from a
|
|
|
7806 line, you can use matchstr() and substitute() to do it. This example shows
|
|
|
7807 how to get the file name, line number and column number out of a line like
|
|
|
7808 "foobar.txt, 123, 45". >
|
|
|
7809 :" Set up the match bit
|
|
|
7810 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
|
|
|
7811 :"get the part matching the whole expression
|
|
|
7812 :let l = matchstr(line, mx)
|
|
|
7813 :"get each item out of the match
|
|
|
7814 :let file = substitute(l, mx, '\1', '')
|
|
|
7815 :let lnum = substitute(l, mx, '\2', '')
|
|
|
7816 :let col = substitute(l, mx, '\3', '')
|
|
|
7817
|
|
|
7818 The input is in the variable "line", the results in the variables "file",
|
|
|
7819 "lnum" and "col". (idea from Michael Geddes)
|
|
|
7820
|
|
1156
|
7821
|
|
|
7822 getting the scriptnames in a Dictionary ~
|
|
|
7823 *scriptnames-dictionary*
|
|
|
7824 The |:scriptnames| command can be used to get a list of all script files that
|
|
|
7825 have been sourced. There is no equivalent function or variable for this
|
|
|
7826 (because it's rarely needed). In case you need to manipulate the list this
|
|
|
7827 code can be used: >
|
|
|
7828 " Get the output of ":scriptnames" in the scriptnames_output variable.
|
|
|
7829 let scriptnames_output = ''
|
|
|
7830 redir => scriptnames_output
|
|
|
7831 silent scriptnames
|
|
|
7832 redir END
|
|
|
7833
|
|
1621
|
7834 " Split the output into lines and parse each line. Add an entry to the
|
|
1156
|
7835 " "scripts" dictionary.
|
|
|
7836 let scripts = {}
|
|
|
7837 for line in split(scriptnames_output, "\n")
|
|
|
7838 " Only do non-blank lines.
|
|
|
7839 if line =~ '\S'
|
|
|
7840 " Get the first number in the line.
|
|
1621
|
7841 let nr = matchstr(line, '\d\+')
|
|
1156
|
7842 " Get the file name, remove the script number " 123: ".
|
|
1621
|
7843 let name = substitute(line, '.\+:\s*', '', '')
|
|
1156
|
7844 " Add an item to the Dictionary
|
|
1621
|
7845 let scripts[nr] = name
|
|
1156
|
7846 endif
|
|
|
7847 endfor
|
|
|
7848 unlet scriptnames_output
|
|
|
7849
|
|
7
|
7850 ==============================================================================
|
|
|
7851 10. No +eval feature *no-eval-feature*
|
|
|
7852
|
|
|
7853 When the |+eval| feature was disabled at compile time, none of the expression
|
|
|
7854 evaluation commands are available. To prevent this from causing Vim scripts
|
|
|
7855 to generate all kinds of errors, the ":if" and ":endif" commands are still
|
|
|
7856 recognized, though the argument of the ":if" and everything between the ":if"
|
|
|
7857 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
|
|
|
7858 only if the commands are at the start of the line. The ":else" command is not
|
|
|
7859 recognized.
|
|
|
7860
|
|
|
7861 Example of how to avoid executing commands when the |+eval| feature is
|
|
|
7862 missing: >
|
|
|
7863
|
|
|
7864 :if 1
|
|
|
7865 : echo "Expression evaluation is compiled in"
|
|
|
7866 :else
|
|
|
7867 : echo "You will _never_ see this message"
|
|
|
7868 :endif
|
|
|
7869
|
|
|
7870 ==============================================================================
|
|
|
7871 11. The sandbox *eval-sandbox* *sandbox* *E48*
|
|
|
7872
|
|
|
7873 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
|
|
|
7874 options are evaluated in a sandbox. This means that you are protected from
|
|
|
7875 these expressions having nasty side effects. This gives some safety for when
|
|
1621
|
7876 these options are set from a modeline. It is also used when the command from
|
|
620
|
7877 a tags file is executed and for CTRL-R = in the command line.
|
|
29
|
7878 The sandbox is also used for the |:sandbox| command.
|
|
7
|
7879
|
|
|
7880 These items are not allowed in the sandbox:
|
|
|
7881 - changing the buffer text
|
|
|
7882 - defining or changing mapping, autocommands, functions, user commands
|
|
|
7883 - setting certain options (see |option-summary|)
|
|
1156
|
7884 - setting certain v: variables (see |v:var|) *E794*
|
|
7
|
7885 - executing a shell command
|
|
|
7886 - reading or writing a file
|
|
|
7887 - jumping to another buffer or editing a file
|
|
625
|
7888 - executing Python, Perl, etc. commands
|
|
29
|
7889 This is not guaranteed 100% secure, but it should block most attacks.
|
|
|
7890
|
|
|
7891 *:san* *:sandbox*
|
|
401
|
7892 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
|
|
29
|
7893 option that may have been set from a modeline, e.g.
|
|
|
7894 'foldexpr'.
|
|
|
7895
|
|
634
|
7896 *sandbox-option*
|
|
|
7897 A few options contain an expression. When this expression is evaluated it may
|
|
790
|
7898 have to be done in the sandbox to avoid a security risk. But the sandbox is
|
|
634
|
7899 restrictive, thus this only happens when the option was set from an insecure
|
|
|
7900 location. Insecure in this context are:
|
|
843
|
7901 - sourcing a .vimrc or .exrc in the current directory
|
|
634
|
7902 - while executing in the sandbox
|
|
|
7903 - value coming from a modeline
|
|
|
7904
|
|
|
7905 Note that when in the sandbox and saving an option value and restoring it, the
|
|
|
7906 option will still be marked as it was set in the sandbox.
|
|
|
7907
|
|
|
7908 ==============================================================================
|
|
|
7909 12. Textlock *textlock*
|
|
|
7910
|
|
|
7911 In a few situations it is not allowed to change the text in the buffer, jump
|
|
|
7912 to another window and some other things that might confuse or break what Vim
|
|
|
7913 is currently doing. This mostly applies to things that happen when Vim is
|
|
1621
|
7914 actually doing something else. For example, evaluating the 'balloonexpr' may
|
|
634
|
7915 happen any moment the mouse cursor is resting at some position.
|
|
|
7916
|
|
|
7917 This is not allowed when the textlock is active:
|
|
|
7918 - changing the buffer text
|
|
|
7919 - jumping to another buffer or window
|
|
|
7920 - editing another file
|
|
|
7921 - closing a window or quitting Vim
|
|
|
7922 - etc.
|
|
|
7923
|
|
7
|
7924
|
|
|
7925 vim:tw=78:ts=8:ft=help:norl:
|
