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