Mercurial > vim
annotate runtime/doc/usr_41.txt @ 2207:b17bbfa96fa0 vim73
Add the settabvar() and gettabvar() functions.
Various runtime file updates.
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Sat, 22 May 2010 15:37:44 +0200 |
parents | 7c8c7c95a865 |
children | 6f63294a1781 |
rev | line source |
---|---|
2154
7c8c7c95a865
First step in the Vim 7.3 branch. Changed version numbers.
Bram Moolenaar <bram@zimbu.org>
parents:
2050
diff
changeset
|
1 *usr_41.txt* For Vim version 7.3a. Last change: 2008 Jun 21 |
7 | 2 |
3 VIM USER MANUAL - by Bram Moolenaar | |
4 | |
5 Write a Vim script | |
6 | |
7 | |
8 The Vim script language is used for the startup vimrc file, syntax files, and | |
9 many other things. This chapter explains the items that can be used in a Vim | |
10 script. There are a lot of them, thus this is a long chapter. | |
11 | |
12 |41.1| Introduction | |
13 |41.2| Variables | |
14 |41.3| Expressions | |
15 |41.4| Conditionals | |
16 |41.5| Executing an expression | |
17 |41.6| Using functions | |
18 |41.7| Defining a function | |
161 | 19 |41.8| Lists and Dictionaries |
20 |41.9| Exceptions | |
21 |41.10| Various remarks | |
22 |41.11| Writing a plugin | |
23 |41.12| Writing a filetype plugin | |
24 |41.13| Writing a compiler plugin | |
170 | 25 |41.14| Writing a plugin that loads quickly |
26 |41.15| Writing library scripts | |
793 | 27 |41.16| Distributing Vim scripts |
7 | 28 |
29 Next chapter: |usr_42.txt| Add new menus | |
30 Previous chapter: |usr_40.txt| Make new commands | |
31 Table of contents: |usr_toc.txt| | |
32 | |
33 ============================================================================== | |
129 | 34 *41.1* Introduction *vim-script-intro* *script* |
7 | 35 |
36 Your first experience with Vim scripts is the vimrc file. Vim reads it when | |
37 it starts up and executes the commands. You can set options to values you | |
38 prefer. And you can use any colon command in it (commands that start with a | |
39 ":"; these are sometimes referred to as Ex commands or command-line commands). | |
40 Syntax files are also Vim scripts. As are files that set options for a | |
41 specific file type. A complicated macro can be defined by a separate Vim | |
42 script file. You can think of other uses yourself. | |
43 | |
44 Let's start with a simple example: > | |
45 | |
46 :let i = 1 | |
47 :while i < 5 | |
48 : echo "count is" i | |
161 | 49 : let i += 1 |
7 | 50 :endwhile |
51 < | |
52 Note: | |
53 The ":" characters are not really needed here. You only need to use | |
54 them when you type a command. In a Vim script file they can be left | |
55 out. We will use them here anyway to make clear these are colon | |
56 commands and make them stand out from Normal mode commands. | |
161 | 57 Note: |
58 You can try out the examples by yanking the lines from the text here | |
59 and executing them with :@" | |
60 | |
61 The output of the example code is: | |
62 | |
63 count is 1 ~ | |
64 count is 2 ~ | |
65 count is 3 ~ | |
66 count is 4 ~ | |
67 | |
68 In the first line the ":let" command assigns a value to a variable. The | |
69 generic form is: > | |
7 | 70 |
71 :let {variable} = {expression} | |
72 | |
73 In this case the variable name is "i" and the expression is a simple value, | |
74 the number one. | |
75 The ":while" command starts a loop. The generic form is: > | |
76 | |
77 :while {condition} | |
78 : {statements} | |
79 :endwhile | |
80 | |
81 The statements until the matching ":endwhile" are executed for as long as the | |
82 condition is true. The condition used here is the expression "i < 5". This | |
83 is true when the variable i is smaller than five. | |
84 Note: | |
85 If you happen to write a while loop that keeps on running, you can | |
86 interrupt it by pressing CTRL-C (CTRL-Break on MS-Windows). | |
161 | 87 |
88 The ":echo" command prints its arguments. In this case the string "count is" | |
89 and the value of the variable i. Since i is one, this will print: | |
90 | |
91 count is 1 ~ | |
92 | |
93 Then there is the ":let i += 1" command. This does the same thing as | |
94 ":let i = i + 1". This adds one to the variable i and assigns the new value | |
95 to the same variable. | |
96 | |
97 The example was given to explain the commands, but would you really want to | |
112 | 98 make such a loop it can be written much more compact: > |
99 | |
100 :for i in range(1, 4) | |
101 : echo "count is" i | |
102 :endfor | |
103 | |
161 | 104 We won't explain how |:for| and |range()| work until later. Follow the links |
105 if you are impatient. | |
112 | 106 |
7 | 107 |
108 THREE KINDS OF NUMBERS | |
109 | |
110 Numbers can be decimal, hexadecimal or octal. A hexadecimal number starts | |
161 | 111 with "0x" or "0X". For example "0x1f" is decimal 31. An octal number starts |
112 with a zero. "017" is decimal 15. Careful: don't put a zero before a decimal | |
113 number, it will be interpreted as an octal number! | |
7 | 114 The ":echo" command always prints decimal numbers. Example: > |
115 | |
116 :echo 0x7f 036 | |
117 < 127 30 ~ | |
118 | |
119 A number is made negative with a minus sign. This also works for hexadecimal | |
161 | 120 and octal numbers. A minus sign is also used for subtraction. Compare this |
121 with the previous example: > | |
7 | 122 |
123 :echo 0x7f -036 | |
124 < 97 ~ | |
125 | |
126 White space in an expression is ignored. However, it's recommended to use it | |
127 for separating items, to make the expression easier to read. For example, to | |
161 | 128 avoid the confusion with a negative number above, put a space between the |
129 minus sign and the following number: > | |
7 | 130 |
131 :echo 0x7f - 036 | |
132 | |
133 ============================================================================== | |
134 *41.2* Variables | |
135 | |
136 A variable name consists of ASCII letters, digits and the underscore. It | |
137 cannot start with a digit. Valid variable names are: | |
138 | |
139 counter | |
140 _aap3 | |
141 very_long_variable_name_with_underscores | |
142 FuncLength | |
143 LENGTH | |
144 | |
145 Invalid names are "foo+bar" and "6var". | |
146 These variables are global. To see a list of currently defined variables | |
147 use this command: > | |
148 | |
149 :let | |
150 | |
151 You can use global variables everywhere. This also means that when the | |
152 variable "count" is used in one script file, it might also be used in another | |
153 file. This leads to confusion at least, and real problems at worst. To avoid | |
154 this, you can use a variable local to a script file by prepending "s:". For | |
155 example, one script contains this code: > | |
156 | |
157 :let s:count = 1 | |
158 :while s:count < 5 | |
159 : source other.vim | |
161 | 160 : let s:count += 1 |
7 | 161 :endwhile |
162 | |
163 Since "s:count" is local to this script, you can be sure that sourcing the | |
164 "other.vim" script will not change this variable. If "other.vim" also uses an | |
165 "s:count" variable, it will be a different copy, local to that script. More | |
166 about script-local variables here: |script-variable|. | |
167 | |
168 There are more kinds of variables, see |internal-variables|. The most often | |
169 used ones are: | |
170 | |
171 b:name variable local to a buffer | |
172 w:name variable local to a window | |
173 g:name global variable (also in a function) | |
174 v:name variable predefined by Vim | |
175 | |
176 | |
177 DELETING VARIABLES | |
178 | |
179 Variables take up memory and show up in the output of the ":let" command. To | |
180 delete a variable use the ":unlet" command. Example: > | |
181 | |
182 :unlet s:count | |
183 | |
184 This deletes the script-local variable "s:count" to free up the memory it | |
185 uses. If you are not sure if the variable exists, and don't want an error | |
186 message when it doesn't, append !: > | |
187 | |
188 :unlet! s:count | |
189 | |
190 When a script finishes, the local variables used there will not be | |
191 automatically freed. The next time the script executes, it can still use the | |
192 old value. Example: > | |
193 | |
194 :if !exists("s:call_count") | |
195 : let s:call_count = 0 | |
196 :endif | |
197 :let s:call_count = s:call_count + 1 | |
198 :echo "called" s:call_count "times" | |
199 | |
200 The "exists()" function checks if a variable has already been defined. Its | |
201 argument is the name of the variable you want to check. Not the variable | |
202 itself! If you would do this: > | |
203 | |
204 :if !exists(s:call_count) | |
205 | |
206 Then the value of s:call_count will be used as the name of the variable that | |
207 exists() checks. That's not what you want. | |
208 The exclamation mark ! negates a value. When the value was true, it | |
209 becomes false. When it was false, it becomes true. You can read it as "not". | |
210 Thus "if !exists()" can be read as "if not exists()". | |
161 | 211 What Vim calls true is anything that is not zero. Zero is false. |
856 | 212 Note: |
161 | 213 Vim automatically converts a string to a number when it is looking for |
214 a number. When using a string that doesn't start with a digit the | |
215 resulting number is zero. Thus look out for this: > | |
216 :if "true" | |
217 < The "true" will be interpreted as a zero, thus as false! | |
7 | 218 |
219 | |
220 STRING VARIABLES AND CONSTANTS | |
221 | |
222 So far only numbers were used for the variable value. Strings can be used as | |
161 | 223 well. Numbers and strings are the basic types of variables that Vim supports. |
224 The type is dynamic, it is set each time when assigning a value to the | |
225 variable with ":let". More about types in |41.8|. | |
7 | 226 To assign a string value to a variable, you need to use a string constant. |
227 There are two types of these. First the string in double quotes: > | |
228 | |
229 :let name = "peter" | |
230 :echo name | |
231 < peter ~ | |
232 | |
233 If you want to include a double quote inside the string, put a backslash in | |
234 front of it: > | |
235 | |
236 :let name = "\"peter\"" | |
237 :echo name | |
238 < "peter" ~ | |
239 | |
240 To avoid the need for a backslash, you can use a string in single quotes: > | |
241 | |
242 :let name = '"peter"' | |
243 :echo name | |
244 < "peter" ~ | |
245 | |
161 | 246 Inside a single-quote string all the characters are as they are. Only the |
247 single quote itself is special: you need to use two to get one. A backslash | |
248 is taken literally, thus you can't use it to change the meaning of the | |
7 | 249 character after it. |
250 In double-quote strings it is possible to use special characters. Here are | |
251 a few useful ones: | |
252 | |
253 \t <Tab> | |
254 \n <NL>, line break | |
255 \r <CR>, <Enter> | |
256 \e <Esc> | |
257 \b <BS>, backspace | |
258 \" " | |
259 \\ \, backslash | |
260 \<Esc> <Esc> | |
261 \<C-W> CTRL-W | |
262 | |
263 The last two are just examples. The "\<name>" form can be used to include | |
264 the special key "name". | |
265 See |expr-quote| for the full list of special items in a string. | |
266 | |
267 ============================================================================== | |
268 *41.3* Expressions | |
269 | |
270 Vim has a rich, yet simple way to handle expressions. You can read the | |
271 definition here: |expression-syntax|. Here we will show the most common | |
272 items. | |
273 The numbers, strings and variables mentioned above are expressions by | |
274 themselves. Thus everywhere an expression is expected, you can use a number, | |
275 string or variable. Other basic items in an expression are: | |
276 | |
277 $NAME environment variable | |
278 &name option | |
279 @r register | |
280 | |
281 Examples: > | |
282 | |
283 :echo "The value of 'tabstop' is" &ts | |
284 :echo "Your home directory is" $HOME | |
285 :if @a > 5 | |
286 | |
287 The &name form can be used to save an option value, set it to a new value, | |
288 do something and restore the old value. Example: > | |
289 | |
290 :let save_ic = &ic | |
291 :set noic | |
292 :/The Start/,$delete | |
293 :let &ic = save_ic | |
294 | |
295 This makes sure the "The Start" pattern is used with the 'ignorecase' option | |
161 | 296 off. Still, it keeps the value that the user had set. (Another way to do |
297 this would be to add "\C" to the pattern, see |/\C|.) | |
7 | 298 |
299 | |
300 MATHEMATICS | |
301 | |
302 It becomes more interesting if we combine these basic items. Let's start with | |
303 mathematics on numbers: | |
304 | |
305 a + b add | |
306 a - b subtract | |
307 a * b multiply | |
308 a / b divide | |
309 a % b modulo | |
310 | |
311 The usual precedence is used. Example: > | |
312 | |
313 :echo 10 + 5 * 2 | |
314 < 20 ~ | |
315 | |
316 Grouping is done with braces. No surprises here. Example: > | |
317 | |
318 :echo (10 + 5) * 2 | |
319 < 30 ~ | |
320 | |
321 Strings can be concatenated with ".". Example: > | |
322 | |
323 :echo "foo" . "bar" | |
324 < foobar ~ | |
325 | |
326 When the ":echo" command gets multiple arguments, it separates them with a | |
327 space. In the example the argument is a single expression, thus no space is | |
328 inserted. | |
329 | |
330 Borrowed from the C language is the conditional expression: | |
331 | |
332 a ? b : c | |
333 | |
334 If "a" evaluates to true "b" is used, otherwise "c" is used. Example: > | |
335 | |
336 :let i = 4 | |
337 :echo i > 5 ? "i is big" : "i is small" | |
338 < i is small ~ | |
339 | |
340 The three parts of the constructs are always evaluated first, thus you could | |
341 see it work as: | |
342 | |
343 (a) ? (b) : (c) | |
344 | |
345 ============================================================================== | |
346 *41.4* Conditionals | |
347 | |
348 The ":if" commands executes the following statements, until the matching | |
349 ":endif", only when a condition is met. The generic form is: | |
350 | |
351 :if {condition} | |
352 {statements} | |
353 :endif | |
354 | |
355 Only when the expression {condition} evaluates to true (non-zero) will the | |
356 {statements} be executed. These must still be valid commands. If they | |
357 contain garbage, Vim won't be able to find the ":endif". | |
358 You can also use ":else". The generic form for this is: | |
359 | |
360 :if {condition} | |
361 {statements} | |
362 :else | |
363 {statements} | |
364 :endif | |
365 | |
366 The second {statements} is only executed if the first one isn't. | |
367 Finally, there is ":elseif": | |
368 | |
369 :if {condition} | |
370 {statements} | |
371 :elseif {condition} | |
372 {statements} | |
373 :endif | |
374 | |
375 This works just like using ":else" and then "if", but without the need for an | |
376 extra ":endif". | |
377 A useful example for your vimrc file is checking the 'term' option and | |
378 doing something depending upon its value: > | |
379 | |
380 :if &term == "xterm" | |
381 : " Do stuff for xterm | |
382 :elseif &term == "vt100" | |
383 : " Do stuff for a vt100 terminal | |
384 :else | |
385 : " Do something for other terminals | |
386 :endif | |
387 | |
388 | |
389 LOGIC OPERATIONS | |
390 | |
391 We already used some of them in the examples. These are the most often used | |
392 ones: | |
393 | |
394 a == b equal to | |
395 a != b not equal to | |
396 a > b greater than | |
397 a >= b greater than or equal to | |
398 a < b less than | |
399 a <= b less than or equal to | |
400 | |
401 The result is one if the condition is met and zero otherwise. An example: > | |
402 | |
161 | 403 :if v:version >= 700 |
7 | 404 : echo "congratulations" |
405 :else | |
406 : echo "you are using an old version, upgrade!" | |
407 :endif | |
408 | |
409 Here "v:version" is a variable defined by Vim, which has the value of the Vim | |
410 version. 600 is for version 6.0. Version 6.1 has the value 601. This is | |
411 very useful to write a script that works with multiple versions of Vim. | |
412 |v:version| | |
413 | |
414 The logic operators work both for numbers and strings. When comparing two | |
415 strings, the mathematical difference is used. This compares byte values, | |
416 which may not be right for some languages. | |
417 When comparing a string with a number, the string is first converted to a | |
418 number. This is a bit tricky, because when a string doesn't look like a | |
419 number, the number zero is used. Example: > | |
420 | |
421 :if 0 == "one" | |
422 : echo "yes" | |
423 :endif | |
424 | |
425 This will echo "yes", because "one" doesn't look like a number, thus it is | |
426 converted to the number zero. | |
427 | |
428 For strings there are two more items: | |
429 | |
430 a =~ b matches with | |
431 a !~ b does not match with | |
432 | |
433 The left item "a" is used as a string. The right item "b" is used as a | |
434 pattern, like what's used for searching. Example: > | |
435 | |
436 :if str =~ " " | |
437 : echo "str contains a space" | |
438 :endif | |
439 :if str !~ '\.$' | |
440 : echo "str does not end in a full stop" | |
441 :endif | |
442 | |
443 Notice the use of a single-quote string for the pattern. This is useful, | |
161 | 444 because backslashes would need to be doubled in a double-quote string and |
445 patterns tend to contain many backslashes. | |
7 | 446 |
447 The 'ignorecase' option is used when comparing strings. When you don't want | |
448 that, append "#" to match case and "?" to ignore case. Thus "==?" compares | |
449 two strings to be equal while ignoring case. And "!~#" checks if a pattern | |
450 doesn't match, also checking the case of letters. For the full table see | |
451 |expr-==|. | |
452 | |
453 | |
454 MORE LOOPING | |
455 | |
456 The ":while" command was already mentioned. Two more statements can be used | |
457 in between the ":while" and the ":endwhile": | |
458 | |
459 :continue Jump back to the start of the while loop; the | |
460 loop continues. | |
461 :break Jump forward to the ":endwhile"; the loop is | |
462 discontinued. | |
463 | |
464 Example: > | |
465 | |
466 :while counter < 40 | |
467 : call do_something() | |
468 : if skip_flag | |
469 : continue | |
470 : endif | |
471 : if finished_flag | |
472 : break | |
473 : endif | |
474 : sleep 50m | |
475 :endwhile | |
476 | |
477 The ":sleep" command makes Vim take a nap. The "50m" specifies fifty | |
478 milliseconds. Another example is ":sleep 4", which sleeps for four seconds. | |
479 | |
161 | 480 Even more looping can be done with the ":for" command, see below in |41.8|. |
481 | |
7 | 482 ============================================================================== |
483 *41.5* Executing an expression | |
484 | |
485 So far the commands in the script were executed by Vim directly. The | |
486 ":execute" command allows executing the result of an expression. This is a | |
487 very powerful way to build commands and execute them. | |
488 An example is to jump to a tag, which is contained in a variable: > | |
489 | |
490 :execute "tag " . tag_name | |
491 | |
492 The "." is used to concatenate the string "tag " with the value of variable | |
493 "tag_name". Suppose "tag_name" has the value "get_cmd", then the command that | |
494 will be executed is: > | |
495 | |
496 :tag get_cmd | |
497 | |
498 The ":execute" command can only execute colon commands. The ":normal" command | |
499 executes Normal mode commands. However, its argument is not an expression but | |
500 the literal command characters. Example: > | |
501 | |
502 :normal gg=G | |
503 | |
504 This jumps to the first line and formats all lines with the "=" operator. | |
505 To make ":normal" work with an expression, combine ":execute" with it. | |
506 Example: > | |
507 | |
508 :execute "normal " . normal_commands | |
509 | |
510 The variable "normal_commands" must contain the Normal mode commands. | |
511 Make sure that the argument for ":normal" is a complete command. Otherwise | |
512 Vim will run into the end of the argument and abort the command. For example, | |
513 if you start Insert mode, you must leave Insert mode as well. This works: > | |
514 | |
515 :execute "normal Inew text \<Esc>" | |
516 | |
517 This inserts "new text " in the current line. Notice the use of the special | |
518 key "\<Esc>". This avoids having to enter a real <Esc> character in your | |
519 script. | |
520 | |
161 | 521 If you don't want to execute a string but evaluate it to get its expression |
522 value, you can use the eval() function: > | |
523 | |
524 :let optname = "path" | |
525 :let optval = eval('&' . optname) | |
526 | |
527 A "&" character is prepended to "path", thus the argument to eval() is | |
528 "&path". The result will then be the value of the 'path' option. | |
529 The same thing can be done with: > | |
530 :exe 'let optval = &' . optname | |
531 | |
7 | 532 ============================================================================== |
533 *41.6* Using functions | |
534 | |
535 Vim defines many functions and provides a large amount of functionality that | |
536 way. A few examples will be given in this section. You can find the whole | |
537 list here: |functions|. | |
538 | |
539 A function is called with the ":call" command. The parameters are passed in | |
540 between braces, separated by commas. Example: > | |
541 | |
542 :call search("Date: ", "W") | |
543 | |
544 This calls the search() function, with arguments "Date: " and "W". The | |
545 search() function uses its first argument as a search pattern and the second | |
546 one as flags. The "W" flag means the search doesn't wrap around the end of | |
547 the file. | |
548 | |
549 A function can be called in an expression. Example: > | |
550 | |
551 :let line = getline(".") | |
552 :let repl = substitute(line, '\a', "*", "g") | |
553 :call setline(".", repl) | |
554 | |
161 | 555 The getline() function obtains a line from the current buffer. Its argument |
556 is a specification of the line number. In this case "." is used, which means | |
557 the line where the cursor is. | |
7 | 558 The substitute() function does something similar to the ":substitute" |
559 command. The first argument is the string on which to perform the | |
560 substitution. The second argument is the pattern, the third the replacement | |
561 string. Finally, the last arguments are the flags. | |
562 The setline() function sets the line, specified by the first argument, to a | |
563 new string, the second argument. In this example the line under the cursor is | |
564 replaced with the result of the substitute(). Thus the effect of the three | |
565 statements is equal to: > | |
566 | |
567 :substitute/\a/*/g | |
568 | |
569 Using the functions becomes more interesting when you do more work before and | |
570 after the substitute() call. | |
571 | |
572 | |
573 FUNCTIONS *function-list* | |
574 | |
575 There are many functions. We will mention them here, grouped by what they are | |
576 used for. You can find an alphabetical list here: |functions|. Use CTRL-] on | |
577 the function name to jump to detailed help on it. | |
578 | |
579 String manipulation: | |
824 | 580 nr2char() get a character by its ASCII value |
7 | 581 char2nr() get ASCII value of a character |
1620 | 582 str2nr() convert a string to a Number |
583 str2float() convert a string to a Float | |
824 | 584 printf() format a string according to % items |
7 | 585 escape() escape characters in a string with a '\' |
1620 | 586 shellescape() escape a string for use with a shell command |
587 fnameescape() escape a file name for use with a Vim command | |
824 | 588 tr() translate characters from one set to another |
7 | 589 strtrans() translate a string to make it printable |
590 tolower() turn a string to lowercase | |
591 toupper() turn a string to uppercase | |
592 match() position where a pattern matches in a string | |
593 matchend() position where a pattern match ends in a string | |
594 matchstr() match of a pattern in a string | |
824 | 595 matchlist() like matchstr() and also return submatches |
7 | 596 stridx() first index of a short string in a long string |
597 strridx() last index of a short string in a long string | |
598 strlen() length of a string | |
599 substitute() substitute a pattern match with a string | |
600 submatch() get a specific match in a ":substitute" | |
601 strpart() get part of a string | |
602 expand() expand special keywords | |
603 iconv() convert text from one encoding to another | |
824 | 604 byteidx() byte index of a character in a string |
605 repeat() repeat a string multiple times | |
606 eval() evaluate a string expression | |
7 | 607 |
112 | 608 List manipulation: |
609 get() get an item without error for wrong index | |
610 len() number of items in a List | |
611 empty() check if List is empty | |
612 insert() insert an item somewhere in a List | |
613 add() append an item to a List | |
614 extend() append a List to a List | |
615 remove() remove one or more items from a List | |
616 copy() make a shallow copy of a List | |
617 deepcopy() make a full copy of a List | |
618 filter() remove selected items from a List | |
619 map() change each List item | |
620 sort() sort a List | |
621 reverse() reverse the order of a List | |
622 split() split a String into a List | |
623 join() join List items into a String | |
824 | 624 range() return a List with a sequence of numbers |
112 | 625 string() String representation of a List |
626 call() call a function with List as arguments | |
323 | 627 index() index of a value in a List |
112 | 628 max() maximum value in a List |
629 min() minimum value in a List | |
630 count() count number of times a value appears in a List | |
824 | 631 repeat() repeat a List multiple times |
112 | 632 |
633 Dictionary manipulation: | |
323 | 634 get() get an entry without an error for a wrong key |
112 | 635 len() number of entries in a Dictionary |
636 has_key() check whether a key appears in a Dictionary | |
637 empty() check if Dictionary is empty | |
638 remove() remove an entry from a Dictionary | |
639 extend() add entries from one Dictionary to another | |
640 filter() remove selected entries from a Dictionary | |
641 map() change each Dictionary entry | |
642 keys() get List of Dictionary keys | |
643 values() get List of Dictionary values | |
644 items() get List of Dictionary key-value pairs | |
645 copy() make a shallow copy of a Dictionary | |
646 deepcopy() make a full copy of a Dictionary | |
647 string() String representation of a Dictionary | |
648 max() maximum value in a Dictionary | |
649 min() minimum value in a Dictionary | |
650 count() count number of times a value appears | |
651 | |
1620 | 652 Floating point computation: |
653 float2nr() convert Float to Number | |
654 abs() absolute value (also works for Number) | |
655 round() round off | |
656 ceil() round up | |
657 floor() round down | |
658 trunc() remove value after decimal point | |
659 log10() logarithm to base 10 | |
660 pow() value of x to the exponent y | |
661 sqrt() square root | |
662 sin() sine | |
663 cos() cosine | |
664 atan() arc tangent | |
665 | |
824 | 666 Variables: |
667 type() type of a variable | |
668 islocked() check if a variable is locked | |
669 function() get a Funcref for a function name | |
670 getbufvar() get a variable value from a specific buffer | |
671 setbufvar() set a variable in a specific buffer | |
831 | 672 getwinvar() get a variable from specific window |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
673 gettabvar() get a variable from specific tab page |
831 | 674 gettabwinvar() get a variable from specific window & tab page |
824 | 675 setwinvar() set a variable in a specific window |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
676 settabvar() set a variable in a specific tab page |
831 | 677 settabwinvar() set a variable in a specific window & tab page |
824 | 678 garbagecollect() possibly free memory |
679 | |
680 Cursor and mark position: | |
7 | 681 col() column number of the cursor or a mark |
682 virtcol() screen column of the cursor or a mark | |
683 line() line number of the cursor or mark | |
684 wincol() window column number of the cursor | |
685 winline() window line number of the cursor | |
686 cursor() position the cursor at a line/column | |
824 | 687 getpos() get position of cursor, mark, etc. |
688 setpos() set position of cursor, mark, etc. | |
689 byte2line() get line number at a specific byte count | |
690 line2byte() byte count at a specific line | |
691 diff_filler() get the number of filler lines above a line | |
692 | |
693 Working with text in the current buffer: | |
161 | 694 getline() get a line or list of lines from the buffer |
7 | 695 setline() replace a line in the buffer |
161 | 696 append() append line or list of lines in the buffer |
7 | 697 indent() indent of a specific line |
698 cindent() indent according to C indenting | |
699 lispindent() indent according to Lisp indenting | |
700 nextnonblank() find next non-blank line | |
701 prevnonblank() find previous non-blank line | |
702 search() find a match for a pattern | |
667 | 703 searchpos() find a match for a pattern |
7 | 704 searchpair() find the other end of a start/skip/end |
667 | 705 searchpairpos() find the other end of a start/skip/end |
824 | 706 searchdecl() search for the declaration of a name |
7 | 707 |
708 System functions and manipulation of files: | |
709 glob() expand wildcards | |
710 globpath() expand wildcards in a number of directories | |
824 | 711 findfile() find a file in a list of directories |
712 finddir() find a directory in a list of directories | |
7 | 713 resolve() find out where a shortcut points to |
714 fnamemodify() modify a file name | |
824 | 715 pathshorten() shorten directory names in a path |
716 simplify() simplify a path without changing its meaning | |
7 | 717 executable() check if an executable program exists |
718 filereadable() check if a file can be read | |
719 filewritable() check if a file can be written to | |
824 | 720 getfperm() get the permissions of a file |
721 getftype() get the kind of a file | |
7 | 722 isdirectory() check if a directory exists |
723 getfsize() get the size of a file | |
824 | 724 getcwd() get the current working directory |
1104 | 725 haslocaldir() check if current window used |:lcd| |
7 | 726 tempname() get the name of a temporary file |
824 | 727 mkdir() create a new directory |
7 | 728 delete() delete a file |
729 rename() rename a file | |
730 system() get the result of a shell command | |
731 hostname() name of the system | |
158 | 732 readfile() read a file into a List of lines |
733 writefile() write a List of lines into a file | |
7 | 734 |
824 | 735 Date and Time: |
736 getftime() get last modification time of a file | |
737 localtime() get current time in seconds | |
738 strftime() convert time to a string | |
739 reltime() get the current or elapsed time accurately | |
740 reltimestr() convert reltime() result to a string | |
741 | |
7 | 742 Buffers, windows and the argument list: |
743 argc() number of entries in the argument list | |
744 argidx() current position in the argument list | |
745 argv() get one entry from the argument list | |
746 bufexists() check if a buffer exists | |
747 buflisted() check if a buffer exists and is listed | |
748 bufloaded() check if a buffer exists and is loaded | |
749 bufname() get the name of a specific buffer | |
750 bufnr() get the buffer number of a specific buffer | |
824 | 751 tabpagebuflist() return List of buffers in a tab page |
752 tabpagenr() get the number of a tab page | |
753 tabpagewinnr() like winnr() for a specified tab page | |
7 | 754 winnr() get the window number for the current window |
755 bufwinnr() get the window number of a specific buffer | |
756 winbufnr() get the buffer number of a specific window | |
434 | 757 getbufline() get a list of lines from the specified buffer |
824 | 758 |
759 Command line: | |
760 getcmdline() get the current command line | |
761 getcmdpos() get position of the cursor in the command line | |
762 setcmdpos() set position of the cursor in the command line | |
763 getcmdtype() return the current command-line type | |
764 | |
765 Quickfix and location lists: | |
766 getqflist() list of quickfix errors | |
767 setqflist() modify a quickfix list | |
768 getloclist() list of location list items | |
769 setloclist() modify a location list | |
770 | |
771 Insert mode completion: | |
772 complete() set found matches | |
773 complete_add() add to found matches | |
774 complete_check() check if completion should be aborted | |
775 pumvisible() check if the popup menu is displayed | |
7 | 776 |
777 Folding: | |
778 foldclosed() check for a closed fold at a specific line | |
779 foldclosedend() like foldclosed() but return the last line | |
780 foldlevel() check for the fold level at a specific line | |
781 foldtext() generate the line displayed for a closed fold | |
824 | 782 foldtextresult() get the text displayed for a closed fold |
783 | |
784 Syntax and highlighting: | |
1326 | 785 clearmatches() clear all matches defined by |matchadd()| and |
786 the |:match| commands | |
787 getmatches() get all matches defined by |matchadd()| and | |
788 the |:match| commands | |
7 | 789 hlexists() check if a highlight group exists |
790 hlID() get ID of a highlight group | |
791 synID() get syntax ID at a specific position | |
792 synIDattr() get a specific attribute of a syntax ID | |
793 synIDtrans() get translated syntax ID | |
824 | 794 diff_hlID() get highlight ID for diff mode at a position |
1326 | 795 matchadd() define a pattern to highlight (a "match") |
824 | 796 matcharg() get info about |:match| arguments |
1326 | 797 matchdelete() delete a match defined by |matchadd()| or a |
798 |:match| command | |
799 setmatches() restore a list of matches saved by | |
800 |getmatches()| | |
824 | 801 |
802 Spelling: | |
803 spellbadword() locate badly spelled word at or after cursor | |
804 spellsuggest() return suggested spelling corrections | |
805 soundfold() return the sound-a-like equivalent of a word | |
7 | 806 |
807 History: | |
808 histadd() add an item to a history | |
809 histdel() delete an item from a history | |
810 histget() get an item from a history | |
811 histnr() get highest index of a history list | |
812 | |
813 Interactive: | |
824 | 814 browse() put up a file requester |
815 browsedir() put up a directory requester | |
7 | 816 confirm() let the user make a choice |
817 getchar() get a character from the user | |
818 getcharmod() get modifiers for the last typed character | |
1620 | 819 feedkeys() put characters in the typeahead queue |
7 | 820 input() get a line from the user |
824 | 821 inputlist() let the user pick an entry from a list |
7 | 822 inputsecret() get a line from the user without showing it |
823 inputdialog() get a line from the user in a dialog | |
230 | 824 inputsave() save and clear typeahead |
7 | 825 inputrestore() restore typeahead |
826 | |
824 | 827 GUI: |
828 getfontname() get name of current font being used | |
829 getwinposx() X position of the GUI Vim window | |
830 getwinposy() Y position of the GUI Vim window | |
831 | |
7 | 832 Vim server: |
833 serverlist() return the list of server names | |
834 remote_send() send command characters to a Vim server | |
835 remote_expr() evaluate an expression in a Vim server | |
836 server2client() send a reply to a client of a Vim server | |
837 remote_peek() check if there is a reply from a Vim server | |
838 remote_read() read a reply from a Vim server | |
839 foreground() move the Vim window to the foreground | |
840 remote_foreground() move the Vim server window to the foreground | |
841 | |
824 | 842 Window size and position: |
843 winheight() get height of a specific window | |
844 winwidth() get width of a specific window | |
845 winrestcmd() return command to restore window sizes | |
846 winsaveview() get view of current window | |
847 winrestview() restore saved view of current window | |
848 | |
7 | 849 Various: |
850 mode() get current editing mode | |
851 visualmode() last visual mode used | |
852 hasmapto() check if a mapping exists | |
853 mapcheck() check if a matching mapping exists | |
854 maparg() get rhs of a mapping | |
855 exists() check if a variable, function, etc. exists | |
856 has() check if a feature is supported in Vim | |
824 | 857 changenr() return number of most recent change |
7 | 858 cscope_connection() check if a cscope connection exists |
859 did_filetype() check if a FileType autocommand was used | |
860 eventhandler() check if invoked by an event handler | |
1620 | 861 getpid() get process ID of Vim |
824 | 862 |
7 | 863 libcall() call a function in an external library |
864 libcallnr() idem, returning a number | |
824 | 865 |
7 | 866 getreg() get contents of a register |
867 getregtype() get type of a register | |
868 setreg() set contents and type of a register | |
824 | 869 |
211 | 870 taglist() get list of matching tags |
824 | 871 tagfiles() get a list of tags files |
7 | 872 |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
873 mzeval() evaluate |MzScheme| expression |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
874 |
7 | 875 ============================================================================== |
876 *41.7* Defining a function | |
877 | |
878 Vim enables you to define your own functions. The basic function declaration | |
879 begins as follows: > | |
880 | |
881 :function {name}({var1}, {var2}, ...) | |
882 : {body} | |
883 :endfunction | |
884 < | |
885 Note: | |
886 Function names must begin with a capital letter. | |
887 | |
888 Let's define a short function to return the smaller of two numbers. It starts | |
889 with this line: > | |
890 | |
891 :function Min(num1, num2) | |
892 | |
893 This tells Vim that the function is named "Min" and it takes two arguments: | |
894 "num1" and "num2". | |
895 The first thing you need to do is to check to see which number is smaller: | |
896 > | |
897 : if a:num1 < a:num2 | |
898 | |
899 The special prefix "a:" tells Vim that the variable is a function argument. | |
900 Let's assign the variable "smaller" the value of the smallest number: > | |
901 | |
902 : if a:num1 < a:num2 | |
903 : let smaller = a:num1 | |
904 : else | |
905 : let smaller = a:num2 | |
906 : endif | |
907 | |
908 The variable "smaller" is a local variable. Variables used inside a function | |
909 are local unless prefixed by something like "g:", "a:", or "s:". | |
910 | |
911 Note: | |
912 To access a global variable from inside a function you must prepend | |
1620 | 913 "g:" to it. Thus "g:today" inside a function is used for the global |
914 variable "today", and "today" is another variable, local to the | |
7 | 915 function. |
916 | |
917 You now use the ":return" statement to return the smallest number to the user. | |
918 Finally, you end the function: > | |
919 | |
920 : return smaller | |
921 :endfunction | |
922 | |
923 The complete function definition is as follows: > | |
924 | |
925 :function Min(num1, num2) | |
926 : if a:num1 < a:num2 | |
927 : let smaller = a:num1 | |
928 : else | |
929 : let smaller = a:num2 | |
930 : endif | |
931 : return smaller | |
932 :endfunction | |
933 | |
161 | 934 For people who like short functions, this does the same thing: > |
935 | |
936 :function Min(num1, num2) | |
937 : if a:num1 < a:num2 | |
938 : return a:num1 | |
939 : endif | |
940 : return a:num2 | |
941 :endfunction | |
942 | |
681 | 943 A user defined function is called in exactly the same way as a built-in |
7 | 944 function. Only the name is different. The Min function can be used like |
945 this: > | |
946 | |
947 :echo Min(5, 8) | |
948 | |
949 Only now will the function be executed and the lines be interpreted by Vim. | |
950 If there are mistakes, like using an undefined variable or function, you will | |
951 now get an error message. When defining the function these errors are not | |
952 detected. | |
953 | |
954 When a function reaches ":endfunction" or ":return" is used without an | |
955 argument, the function returns zero. | |
956 | |
957 To redefine a function that already exists, use the ! for the ":function" | |
958 command: > | |
959 | |
960 :function! Min(num1, num2, num3) | |
961 | |
962 | |
963 USING A RANGE | |
964 | |
965 The ":call" command can be given a line range. This can have one of two | |
966 meanings. When a function has been defined with the "range" keyword, it will | |
967 take care of the line range itself. | |
968 The function will be passed the variables "a:firstline" and "a:lastline". | |
969 These will have the line numbers from the range the function was called with. | |
970 Example: > | |
971 | |
972 :function Count_words() range | |
1620 | 973 : let lnum = a:firstline |
974 : let n = 0 | |
975 : while lnum <= a:lastline | |
976 : let n = n + len(split(getline(lnum))) | |
977 : let lnum = lnum + 1 | |
7 | 978 : endwhile |
1620 | 979 : echo "found " . n . " words" |
7 | 980 :endfunction |
981 | |
982 You can call this function with: > | |
983 | |
984 :10,30call Count_words() | |
985 | |
986 It will be executed once and echo the number of words. | |
987 The other way to use a line range is by defining a function without the | |
988 "range" keyword. The function will be called once for every line in the | |
989 range, with the cursor in that line. Example: > | |
990 | |
991 :function Number() | |
992 : echo "line " . line(".") . " contains: " . getline(".") | |
993 :endfunction | |
994 | |
995 If you call this function with: > | |
996 | |
997 :10,15call Number() | |
998 | |
999 The function will be called six times. | |
1000 | |
1001 | |
1002 VARIABLE NUMBER OF ARGUMENTS | |
1003 | |
1004 Vim enables you to define functions that have a variable number of arguments. | |
1005 The following command, for instance, defines a function that must have 1 | |
1006 argument (start) and can have up to 20 additional arguments: > | |
1007 | |
1008 :function Show(start, ...) | |
1009 | |
1010 The variable "a:1" contains the first optional argument, "a:2" the second, and | |
1011 so on. The variable "a:0" contains the number of extra arguments. | |
1012 For example: > | |
1013 | |
1014 :function Show(start, ...) | |
1015 : echohl Title | |
1016 : echo "Show is " . a:start | |
1017 : echohl None | |
1018 : let index = 1 | |
1019 : while index <= a:0 | |
1020 : echo " Arg " . index . " is " . a:{index} | |
1021 : let index = index + 1 | |
1022 : endwhile | |
1023 : echo "" | |
1024 :endfunction | |
1025 | |
1026 This uses the ":echohl" command to specify the highlighting used for the | |
1027 following ":echo" command. ":echohl None" stops it again. The ":echon" | |
1028 command works like ":echo", but doesn't output a line break. | |
1029 | |
161 | 1030 You can also use the a:000 variable, it is a List of all the "..." arguments. |
1031 See |a:000|. | |
1032 | |
7 | 1033 |
1034 LISTING FUNCTIONS | |
1035 | |
1036 The ":function" command lists the names and arguments of all user-defined | |
1037 functions: > | |
1038 | |
1039 :function | |
1040 < function Show(start, ...) ~ | |
1041 function GetVimIndent() ~ | |
1042 function SetSyn(name) ~ | |
1043 | |
1044 To see what a function does, use its name as an argument for ":function": > | |
1045 | |
1046 :function SetSyn | |
1047 < 1 if &syntax == '' ~ | |
1048 2 let &syntax = a:name ~ | |
1049 3 endif ~ | |
1050 endfunction ~ | |
1051 | |
1052 | |
1053 DEBUGGING | |
1054 | |
1055 The line number is useful for when you get an error message or when debugging. | |
1056 See |debug-scripts| about debugging mode. | |
1057 You can also set the 'verbose' option to 12 or higher to see all function | |
1058 calls. Set it to 15 or higher to see every executed line. | |
1059 | |
1060 | |
1061 DELETING A FUNCTION | |
1062 | |
1063 To delete the Show() function: > | |
1064 | |
1065 :delfunction Show | |
1066 | |
1067 You get an error when the function doesn't exist. | |
1068 | |
161 | 1069 |
1070 FUNCTION REFERENCES | |
1071 | |
1072 Sometimes it can be useful to have a variable point to one function or | |
1073 another. You can do it with the function() function. It turns the name of a | |
1074 function into a reference: > | |
1075 | |
1076 :let result = 0 " or 1 | |
1077 :function! Right() | |
1078 : return 'Right!' | |
1079 :endfunc | |
1080 :function! Wrong() | |
1081 : return 'Wrong!' | |
1082 :endfunc | |
1083 : | |
1084 :if result == 1 | |
1085 : let Afunc = function('Right') | |
1086 :else | |
1087 : let Afunc = function('Wrong') | |
1088 :endif | |
1089 :echo call(Afunc, []) | |
1090 < Wrong! ~ | |
1091 | |
1092 Note that the name of a variable that holds a function reference must start | |
1093 with a capital. Otherwise it could be confused with the name of a builtin | |
1094 function. | |
1095 The way to invoke a function that a variable refers to is with the call() | |
1096 function. Its first argument is the function reference, the second argument | |
1097 is a List with arguments. | |
1098 | |
1099 Function references are most useful in combination with a Dictionary, as is | |
1100 explained in the next section. | |
1101 | |
7 | 1102 ============================================================================== |
161 | 1103 *41.8* Lists and Dictionaries |
1104 | |
1105 So far we have used the basic types String and Number. Vim also supports two | |
1106 composite types: List and Dictionary. | |
1107 | |
1108 A List is an ordered sequence of things. The things can be any kind of value, | |
1109 thus you can make a List of numbers, a List of Lists and even a List of mixed | |
1110 items. To create a List with three strings: > | |
1111 | |
856 | 1112 :let alist = ['aap', 'mies', 'noot'] |
161 | 1113 |
1114 The List items are enclosed in square brackets and separated by commas. To | |
1115 create an empty List: > | |
1116 | |
856 | 1117 :let alist = [] |
161 | 1118 |
1119 You can add items to a List with the add() function: > | |
1120 | |
856 | 1121 :let alist = [] |
161 | 1122 :call add(alist, 'foo') |
1123 :call add(alist, 'bar') | |
1124 :echo alist | |
1125 < ['foo', 'bar'] ~ | |
1126 | |
1127 List concatenation is done with +: > | |
1128 | |
1129 :echo alist + ['foo', 'bar'] | |
1130 < ['foo', 'bar', 'foo', 'bar'] ~ | |
1131 | |
1132 Or, if you want to extend a List directly: > | |
1133 | |
856 | 1134 :let alist = ['one'] |
161 | 1135 :call extend(alist, ['two', 'three']) |
1136 :echo alist | |
1137 < ['one', 'two', 'three'] ~ | |
1138 | |
1139 Notice that using add() will have a different effect: > | |
1140 | |
856 | 1141 :let alist = ['one'] |
161 | 1142 :call add(alist, ['two', 'three']) |
1143 :echo alist | |
1144 < ['one', ['two', 'three']] ~ | |
1145 | |
1146 The second argument of add() is added as a single item. | |
1147 | |
1148 | |
1149 FOR LOOP | |
1150 | |
1151 One of the nice things you can do with a List is iterate over it: > | |
1152 | |
1153 :let alist = ['one', 'two', 'three'] | |
1154 :for n in alist | |
1155 : echo n | |
1156 :endfor | |
1157 < one ~ | |
1158 two ~ | |
1159 three ~ | |
1160 | |
1161 This will loop over each element in List "alist", assigning the value to | |
1162 variable "n". The generic form of a for loop is: > | |
1163 | |
1164 :for {varname} in {listexpression} | |
1165 : {commands} | |
1166 :endfor | |
1167 | |
1168 To loop a certain number of times you need a List of a specific length. The | |
1169 range() function creates one for you: > | |
1170 | |
1171 :for a in range(3) | |
1172 : echo a | |
1173 :endfor | |
1174 < 0 ~ | |
1175 1 ~ | |
1176 2 ~ | |
1177 | |
1178 Notice that the first item of the List that range() produces is zero, thus the | |
1179 last item is one less than the length of the list. | |
1180 You can also specify the maximum value, the stride and even go backwards: > | |
1181 | |
1182 :for a in range(8, 4, -2) | |
1183 : echo a | |
1184 :endfor | |
1185 < 8 ~ | |
1186 6 ~ | |
1187 4 ~ | |
1188 | |
1189 A more useful example, looping over lines in the buffer: > | |
1190 | |
856 | 1191 :for line in getline(1, 20) |
1192 : if line =~ "Date: " | |
1193 : echo matchstr(line, 'Date: \zs.*') | |
1194 : endif | |
1195 :endfor | |
161 | 1196 |
1197 This looks into lines 1 to 20 (inclusive) and echoes any date found in there. | |
1198 | |
1199 | |
1200 DICTIONARIES | |
1201 | |
1202 A Dictionary stores key-value pairs. You can quickly lookup a value if you | |
1203 know the key. A Dictionary is created with curly braces: > | |
856 | 1204 |
161 | 1205 :let uk2nl = {'one': 'een', 'two': 'twee', 'three': 'drie'} |
1206 | |
164 | 1207 Now you can lookup words by putting the key in square brackets: > |
161 | 1208 |
1209 :echo uk2nl['two'] | |
1210 < twee ~ | |
1211 | |
1212 The generic form for defining a Dictionary is: > | |
1213 | |
1214 {<key> : <value>, ...} | |
1215 | |
1216 An empty Dictionary is one without any keys: > | |
1217 | |
1218 {} | |
1219 | |
1220 The possibilities with Dictionaries are numerous. There are various functions | |
1221 for them as well. For example, you can obtain a list of the keys and loop | |
1222 over them: > | |
1223 | |
1224 :for key in keys(uk2nl) | |
1225 : echo key | |
1226 :endfor | |
1227 < three ~ | |
1228 one ~ | |
1229 two ~ | |
1230 | |
1620 | 1231 You will notice the keys are not ordered. You can sort the list to get a |
161 | 1232 specific order: > |
1233 | |
1234 :for key in sort(keys(uk2nl)) | |
1235 : echo key | |
1236 :endfor | |
1237 < one ~ | |
1238 three ~ | |
1239 two ~ | |
1240 | |
1241 But you can never get back the order in which items are defined. For that you | |
1242 need to use a List, it stores items in an ordered sequence. | |
1243 | |
1244 | |
1245 DICTIONARY FUNCTIONS | |
1246 | |
1247 The items in a Dictionary can normally be obtained with an index in square | |
1248 brackets: > | |
1249 | |
1250 :echo uk2nl['one'] | |
1251 < een ~ | |
1252 | |
1253 A method that does the same, but without so many punctuation characters: > | |
1254 | |
1255 :echo uk2nl.one | |
1256 < een ~ | |
1257 | |
1258 This only works for a key that is made of ASCII letters, digits and the | |
1259 underscore. You can also assign a new value this way: > | |
1260 | |
1261 :let uk2nl.four = 'vier' | |
1262 :echo uk2nl | |
1263 < {'three': 'drie', 'four': 'vier', 'one': 'een', 'two': 'twee'} ~ | |
1264 | |
1265 And now for something special: you can directly define a function and store a | |
1266 reference to it in the dictionary: > | |
1267 | |
1268 :function uk2nl.translate(line) dict | |
1269 : return join(map(split(a:line), 'get(self, v:val, "???")')) | |
1270 :endfunction | |
1271 | |
1272 Let's first try it out: > | |
1273 | |
1274 :echo uk2nl.translate('three two five one') | |
1275 < drie twee ??? een ~ | |
1276 | |
1277 The first special thing you notice is the "dict" at the end of the ":function" | |
1278 line. This marks the function as being used from a Dictionary. The "self" | |
1279 local variable will then refer to that Dictionary. | |
1280 Now let's break up the complicated return command: > | |
1281 | |
1282 split(a:line) | |
1283 | |
1284 The split() function takes a string, chops it into white separated words | |
1285 and returns a list with these words. Thus in the example it returns: > | |
1286 | |
1287 :echo split('three two five one') | |
1288 < ['three', 'two', 'five', 'one'] ~ | |
1289 | |
1290 This list is the first argument to the map() function. This will go through | |
1291 the list, evaluating its second argument with "v:val" set to the value of each | |
1292 item. This is a shortcut to using a for loop. This command: > | |
1293 | |
1294 :let alist = map(split(a:line), 'get(self, v:val, "???")') | |
1295 | |
1296 Is equivalent to: > | |
1297 | |
1298 :let alist = split(a:line) | |
1299 :for idx in range(len(alist)) | |
1300 : let alist[idx] = get(self, alist[idx], "???") | |
1301 :endfor | |
1302 | |
1303 The get() function checks if a key is present in a Dictionary. If it is, then | |
1304 the value is retrieved. If it isn't, then the default value is returned, in | |
164 | 1305 the example it's '???'. This is a convenient way to handle situations where a |
161 | 1306 key may not be present and you don't want an error message. |
1307 | |
1308 The join() function does the opposite of split(): it joins together a list of | |
1309 words, putting a space in between. | |
1310 This combination of split(), map() and join() is a nice way to filter a line | |
1311 of words in a very compact way. | |
1312 | |
1313 | |
1314 OBJECT ORIENTED PROGRAMMING | |
1315 | |
1316 Now that you can put both values and functions in a Dictionary, you can | |
1317 actually use a Dictionary like an object. | |
1318 Above we used a Dictionary for translating Dutch to English. We might want | |
1319 to do the same for other languages. Let's first make an object (aka | |
1320 Dictionary) that has the translate function, but no words to translate: > | |
1321 | |
1322 :let transdict = {} | |
1323 :function transdict.translate(line) dict | |
1324 : return join(map(split(a:line), 'get(self.words, v:val, "???")')) | |
1325 :endfunction | |
1326 | |
1327 It's slightly different from the function above, using 'self.words' to lookup | |
1328 word translations. But we don't have a self.words. Thus you could call this | |
1329 an abstract class. | |
1330 | |
1331 Now we can instantiate a Dutch translation object: > | |
1332 | |
1333 :let uk2nl = copy(transdict) | |
1334 :let uk2nl.words = {'one': 'een', 'two': 'twee', 'three': 'drie'} | |
1335 :echo uk2nl.translate('three one') | |
1336 < drie een ~ | |
1337 | |
1338 And a German translator: > | |
1339 | |
1340 :let uk2de = copy(transdict) | |
1341 :let uk2de.words = {'one': 'ein', 'two': 'zwei', 'three': 'drei'} | |
1342 :echo uk2de.translate('three one') | |
1343 < drei ein ~ | |
1344 | |
1345 You see that the copy() function is used to make a copy of the "transdict" | |
1346 Dictionary and then the copy is changed to add the words. The original | |
1347 remains the same, of course. | |
1348 | |
1349 Now you can go one step further, and use your preferred translator: > | |
1350 | |
1351 :if $LANG =~ "de" | |
1352 : let trans = uk2de | |
1353 :else | |
1354 : let trans = uk2nl | |
1355 :endif | |
1356 :echo trans.translate('one two three') | |
1357 < een twee drie ~ | |
1358 | |
1359 Here "trans" refers to one of the two objects (Dictionaries). No copy is | |
1360 made. More about List and Dictionary identity can be found at |list-identity| | |
1361 and |dict-identity|. | |
1362 | |
1363 Now you might use a language that isn't supported. You can overrule the | |
1364 translate() function to do nothing: > | |
1365 | |
1366 :let uk2uk = copy(transdict) | |
1367 :function! uk2uk.translate(line) | |
1368 : return a:line | |
1369 :endfunction | |
1370 :echo uk2uk.translate('three one wladiwostok') | |
1371 < three one wladiwostok ~ | |
1372 | |
1373 Notice that a ! was used to overwrite the existing function reference. Now | |
1374 use "uk2uk" when no recognized language is found: > | |
1375 | |
1376 :if $LANG =~ "de" | |
1377 : let trans = uk2de | |
1378 :elseif $LANG =~ "nl" | |
1379 : let trans = uk2nl | |
1380 :else | |
1381 : let trans = uk2uk | |
1382 :endif | |
1383 :echo trans.translate('one two three') | |
1384 < one two three ~ | |
1385 | |
1386 For further reading see |Lists| and |Dictionaries|. | |
1387 | |
1388 ============================================================================== | |
1389 *41.9* Exceptions | |
7 | 1390 |
1391 Let's start with an example: > | |
1392 | |
1393 :try | |
1394 : read ~/templates/pascal.tmpl | |
1395 :catch /E484:/ | |
1396 : echo "Sorry, the Pascal template file cannot be found." | |
1397 :endtry | |
1398 | |
1399 The ":read" command will fail if the file does not exist. Instead of | |
1400 generating an error message, this code catches the error and gives the user a | |
1401 nice message instead. | |
1402 | |
1403 For the commands in between ":try" and ":endtry" errors are turned into | |
1404 exceptions. An exception is a string. In the case of an error the string | |
1405 contains the error message. And every error message has a number. In this | |
1406 case, the error we catch contains "E484:". This number is guaranteed to stay | |
1407 the same (the text may change, e.g., it may be translated). | |
1408 | |
1409 When the ":read" command causes another error, the pattern "E484:" will not | |
1410 match in it. Thus this exception will not be caught and result in the usual | |
1411 error message. | |
1412 | |
1413 You might be tempted to do this: > | |
1414 | |
1415 :try | |
1416 : read ~/templates/pascal.tmpl | |
1417 :catch | |
1418 : echo "Sorry, the Pascal template file cannot be found." | |
1419 :endtry | |
1420 | |
1421 This means all errors are caught. But then you will not see errors that are | |
1422 useful, such as "E21: Cannot make changes, 'modifiable' is off". | |
1423 | |
1424 Another useful mechanism is the ":finally" command: > | |
1425 | |
1426 :let tmp = tempname() | |
1427 :try | |
1428 : exe ".,$write " . tmp | |
1429 : exe "!filter " . tmp | |
1430 : .,$delete | |
1431 : exe "$read " . tmp | |
1432 :finally | |
1433 : call delete(tmp) | |
1434 :endtry | |
1435 | |
1436 This filters the lines from the cursor until the end of the file through the | |
1437 "filter" command, which takes a file name argument. No matter if the | |
1438 filtering works, something goes wrong in between ":try" and ":finally" or the | |
1439 user cancels the filtering by pressing CTRL-C, the "call delete(tmp)" is | |
1440 always executed. This makes sure you don't leave the temporary file behind. | |
1441 | |
1442 More information about exception handling can be found in the reference | |
1443 manual: |exception-handling|. | |
1444 | |
1445 ============================================================================== | |
161 | 1446 *41.10* Various remarks |
7 | 1447 |
1448 Here is a summary of items that apply to Vim scripts. They are also mentioned | |
1449 elsewhere, but form a nice checklist. | |
1450 | |
1451 The end-of-line character depends on the system. For Unix a single <NL> | |
1452 character is used. For MS-DOS, Windows, OS/2 and the like, <CR><LF> is used. | |
1453 This is important when using mappings that end in a <CR>. See |:source_crnl|. | |
1454 | |
1455 | |
1456 WHITE SPACE | |
1457 | |
1458 Blank lines are allowed and ignored. | |
1459 | |
1460 Leading whitespace characters (blanks and TABs) are always ignored. The | |
1461 whitespaces between parameters (e.g. between the 'set' and the 'cpoptions' in | |
1462 the example below) are reduced to one blank character and plays the role of a | |
1463 separator, the whitespaces after the last (visible) character may or may not | |
1464 be ignored depending on the situation, see below. | |
1465 | |
1466 For a ":set" command involving the "=" (equal) sign, such as in: > | |
1467 | |
1468 :set cpoptions =aABceFst | |
1469 | |
1470 the whitespace immediately before the "=" sign is ignored. But there can be | |
1471 no whitespace after the "=" sign! | |
1472 | |
1473 To include a whitespace character in the value of an option, it must be | |
1474 escaped by a "\" (backslash) as in the following example: > | |
1475 | |
1476 :set tags=my\ nice\ file | |
1477 | |
1478 The same example written as > | |
1479 | |
1480 :set tags=my nice file | |
1481 | |
1482 will issue an error, because it is interpreted as: > | |
1483 | |
1484 :set tags=my | |
1485 :set nice | |
1486 :set file | |
1487 | |
1488 | |
1489 COMMENTS | |
1490 | |
1491 The character " (the double quote mark) starts a comment. Everything after | |
1492 and including this character until the end-of-line is considered a comment and | |
1493 is ignored, except for commands that don't consider comments, as shown in | |
1494 examples below. A comment can start on any character position on the line. | |
1495 | |
1496 There is a little "catch" with comments for some commands. Examples: > | |
1497 | |
1498 :abbrev dev development " shorthand | |
1499 :map <F3> o#include " insert include | |
1500 :execute cmd " do it | |
1501 :!ls *.c " list C files | |
1502 | |
1503 The abbreviation 'dev' will be expanded to 'development " shorthand'. The | |
1504 mapping of <F3> will actually be the whole line after the 'o# ....' including | |
1505 the '" insert include'. The "execute" command will give an error. The "!" | |
1506 command will send everything after it to the shell, causing an error for an | |
1507 unmatched '"' character. | |
1508 There can be no comment after ":map", ":abbreviate", ":execute" and "!" | |
1509 commands (there are a few more commands with this restriction). For the | |
1510 ":map", ":abbreviate" and ":execute" commands there is a trick: > | |
1511 | |
1512 :abbrev dev development|" shorthand | |
1513 :map <F3> o#include|" insert include | |
1514 :execute cmd |" do it | |
1515 | |
1516 With the '|' character the command is separated from the next one. And that | |
1146 | 1517 next command is only a comment. For the last command you need to do two |
1518 things: |:execute| and use '|': > | |
1519 :exe '!ls *.c' |" list C files | |
7 | 1520 |
1521 Notice that there is no white space before the '|' in the abbreviation and | |
1522 mapping. For these commands, any character until the end-of-line or '|' is | |
1523 included. As a consequence of this behavior, you don't always see that | |
1524 trailing whitespace is included: > | |
1525 | |
1526 :map <F4> o#include | |
1527 | |
1146 | 1528 To spot these problems, you can set the 'list' option when editing vimrc |
7 | 1529 files. |
1530 | |
1146 | 1531 For Unix there is one special way to comment a line, that allows making a Vim |
1532 script executable: > | |
1533 #!/usr/bin/env vim -S | |
1534 echo "this is a Vim script" | |
1535 quit | |
1536 | |
1537 The "#" command by itself lists a line with the line number. Adding an | |
1538 exclamation mark changes it into doing nothing, so that you can add the shell | |
1539 command to execute the rest of the file. |:#!| |-S| | |
1540 | |
7 | 1541 |
1542 PITFALLS | |
1543 | |
1544 Even bigger problem arises in the following example: > | |
1545 | |
1546 :map ,ab o#include | |
1547 :unmap ,ab | |
1548 | |
1549 Here the unmap command will not work, because it tries to unmap ",ab ". This | |
1550 does not exist as a mapped sequence. An error will be issued, which is very | |
1551 hard to identify, because the ending whitespace character in ":unmap ,ab " is | |
1552 not visible. | |
1553 | |
1554 And this is the same as what happens when one uses a comment after an 'unmap' | |
1555 command: > | |
1556 | |
1557 :unmap ,ab " comment | |
1558 | |
1559 Here the comment part will be ignored. However, Vim will try to unmap | |
1560 ',ab ', which does not exist. Rewrite it as: > | |
1561 | |
1562 :unmap ,ab| " comment | |
1563 | |
1564 | |
1565 RESTORING THE VIEW | |
1566 | |
1567 Sometimes you want to make a change and go back to where cursor was. | |
1568 Restoring the relative position would also be nice, so that the same line | |
1569 appears at the top of the window. | |
1570 This example yanks the current line, puts it above the first line in the | |
1571 file and then restores the view: > | |
1572 | |
1573 map ,p ma"aYHmbgg"aP`bzt`a | |
1574 | |
1575 What this does: > | |
1576 ma"aYHmbgg"aP`bzt`a | |
1577 < ma set mark a at cursor position | |
1578 "aY yank current line into register a | |
1579 Hmb go to top line in window and set mark b there | |
1580 gg go to first line in file | |
1581 "aP put the yanked line above it | |
1582 `b go back to top line in display | |
1583 zt position the text in the window as before | |
1584 `a go back to saved cursor position | |
1585 | |
1586 | |
1587 PACKAGING | |
1588 | |
1589 To avoid your function names to interfere with functions that you get from | |
1590 others, use this scheme: | |
1591 - Prepend a unique string before each function name. I often use an | |
1592 abbreviation. For example, "OW_" is used for the option window functions. | |
1593 - Put the definition of your functions together in a file. Set a global | |
1594 variable to indicate that the functions have been loaded. When sourcing the | |
1595 file again, first unload the functions. | |
1596 Example: > | |
1597 | |
1598 " This is the XXX package | |
1599 | |
1600 if exists("XXX_loaded") | |
1601 delfun XXX_one | |
1602 delfun XXX_two | |
1603 endif | |
1604 | |
1605 function XXX_one(a) | |
1606 ... body of function ... | |
1607 endfun | |
1608 | |
1609 function XXX_two(b) | |
1610 ... body of function ... | |
1611 endfun | |
1612 | |
1613 let XXX_loaded = 1 | |
1614 | |
1615 ============================================================================== | |
161 | 1616 *41.11* Writing a plugin *write-plugin* |
7 | 1617 |
1618 You can write a Vim script in such a way that many people can use it. This is | |
1619 called a plugin. Vim users can drop your script in their plugin directory and | |
1620 use its features right away |add-plugin|. | |
1621 | |
1622 There are actually two types of plugins: | |
1623 | |
1624 global plugins: For all types of files. | |
1625 filetype plugins: Only for files of a specific type. | |
1626 | |
1627 In this section the first type is explained. Most items are also relevant for | |
1628 writing filetype plugins. The specifics for filetype plugins are in the next | |
1629 section |write-filetype-plugin|. | |
1630 | |
1631 | |
1632 NAME | |
1633 | |
1634 First of all you must choose a name for your plugin. The features provided | |
1635 by the plugin should be clear from its name. And it should be unlikely that | |
1636 someone else writes a plugin with the same name but which does something | |
1637 different. And please limit the name to 8 characters, to avoid problems on | |
1638 old Windows systems. | |
1639 | |
1640 A script that corrects typing mistakes could be called "typecorr.vim". We | |
1641 will use it here as an example. | |
1642 | |
1643 For the plugin to work for everybody, it should follow a few guidelines. This | |
1644 will be explained step-by-step. The complete example plugin is at the end. | |
1645 | |
1646 | |
1647 BODY | |
1648 | |
1649 Let's start with the body of the plugin, the lines that do the actual work: > | |
1650 | |
1651 14 iabbrev teh the | |
1652 15 iabbrev otehr other | |
1653 16 iabbrev wnat want | |
1654 17 iabbrev synchronisation | |
1655 18 \ synchronization | |
1656 19 let s:count = 4 | |
1657 | |
1658 The actual list should be much longer, of course. | |
1659 | |
1660 The line numbers have only been added to explain a few things, don't put them | |
1661 in your plugin file! | |
1662 | |
1663 | |
1664 HEADER | |
1665 | |
1666 You will probably add new corrections to the plugin and soon have several | |
1667 versions laying around. And when distributing this file, people will want to | |
1668 know who wrote this wonderful plugin and where they can send remarks. | |
1669 Therefore, put a header at the top of your plugin: > | |
1670 | |
1671 1 " Vim global plugin for correcting typing mistakes | |
1672 2 " Last Change: 2000 Oct 15 | |
1673 3 " Maintainer: Bram Moolenaar <Bram@vim.org> | |
1674 | |
1675 About copyright and licensing: Since plugins are very useful and it's hardly | |
1676 worth restricting their distribution, please consider making your plugin | |
1677 either public domain or use the Vim |license|. A short note about this near | |
1678 the top of the plugin should be sufficient. Example: > | |
1679 | |
1680 4 " License: This file is placed in the public domain. | |
1681 | |
1682 | |
1683 LINE CONTINUATION, AVOIDING SIDE EFFECTS *use-cpo-save* | |
1684 | |
1685 In line 18 above, the line-continuation mechanism is used |line-continuation|. | |
1686 Users with 'compatible' set will run into trouble here, they will get an error | |
1687 message. We can't just reset 'compatible', because that has a lot of side | |
1688 effects. To avoid this, we will set the 'cpoptions' option to its Vim default | |
1689 value and restore it later. That will allow the use of line-continuation and | |
1690 make the script work for most people. It is done like this: > | |
1691 | |
1692 11 let s:save_cpo = &cpo | |
1693 12 set cpo&vim | |
1694 .. | |
1695 42 let &cpo = s:save_cpo | |
1696 | |
1697 We first store the old value of 'cpoptions' in the s:save_cpo variable. At | |
1698 the end of the plugin this value is restored. | |
1699 | |
1700 Notice that a script-local variable is used |s:var|. A global variable could | |
1701 already be in use for something else. Always use script-local variables for | |
1702 things that are only used in the script. | |
1703 | |
1704 | |
1705 NOT LOADING | |
1706 | |
1707 It's possible that a user doesn't always want to load this plugin. Or the | |
1708 system administrator has dropped it in the system-wide plugin directory, but a | |
1709 user has his own plugin he wants to use. Then the user must have a chance to | |
1710 disable loading this specific plugin. This will make it possible: > | |
1711 | |
1712 6 if exists("loaded_typecorr") | |
1713 7 finish | |
1714 8 endif | |
1715 9 let loaded_typecorr = 1 | |
1716 | |
1717 This also avoids that when the script is loaded twice it would cause error | |
1718 messages for redefining functions and cause trouble for autocommands that are | |
1719 added twice. | |
1720 | |
1721 | |
1722 MAPPING | |
1723 | |
1724 Now let's make the plugin more interesting: We will add a mapping that adds a | |
1725 correction for the word under the cursor. We could just pick a key sequence | |
1726 for this mapping, but the user might already use it for something else. To | |
1727 allow the user to define which keys a mapping in a plugin uses, the <Leader> | |
1728 item can be used: > | |
1729 | |
1730 22 map <unique> <Leader>a <Plug>TypecorrAdd | |
1731 | |
1732 The "<Plug>TypecorrAdd" thing will do the work, more about that further on. | |
1733 | |
1734 The user can set the "mapleader" variable to the key sequence that he wants | |
1735 this mapping to start with. Thus if the user has done: > | |
1736 | |
1737 let mapleader = "_" | |
1738 | |
1739 the mapping will define "_a". If the user didn't do this, the default value | |
1740 will be used, which is a backslash. Then a map for "\a" will be defined. | |
1741 | |
1742 Note that <unique> is used, this will cause an error message if the mapping | |
1743 already happened to exist. |:map-<unique>| | |
1744 | |
1745 But what if the user wants to define his own key sequence? We can allow that | |
1746 with this mechanism: > | |
1747 | |
1748 21 if !hasmapto('<Plug>TypecorrAdd') | |
1749 22 map <unique> <Leader>a <Plug>TypecorrAdd | |
1750 23 endif | |
1751 | |
1752 This checks if a mapping to "<Plug>TypecorrAdd" already exists, and only | |
1753 defines the mapping from "<Leader>a" if it doesn't. The user then has a | |
1754 chance of putting this in his vimrc file: > | |
1755 | |
1756 map ,c <Plug>TypecorrAdd | |
1757 | |
1758 Then the mapped key sequence will be ",c" instead of "_a" or "\a". | |
1759 | |
1760 | |
1761 PIECES | |
1762 | |
1763 If a script gets longer, you often want to break up the work in pieces. You | |
1764 can use functions or mappings for this. But you don't want these functions | |
1765 and mappings to interfere with the ones from other scripts. For example, you | |
1766 could define a function Add(), but another script could try to define the same | |
1767 function. To avoid this, we define the function local to the script by | |
1768 prepending it with "s:". | |
1769 | |
1770 We will define a function that adds a new typing correction: > | |
1771 | |
1772 30 function s:Add(from, correct) | |
1773 31 let to = input("type the correction for " . a:from . ": ") | |
1774 32 exe ":iabbrev " . a:from . " " . to | |
1775 .. | |
1776 36 endfunction | |
1777 | |
1778 Now we can call the function s:Add() from within this script. If another | |
1779 script also defines s:Add(), it will be local to that script and can only | |
1780 be called from the script it was defined in. There can also be a global Add() | |
1781 function (without the "s:"), which is again another function. | |
1782 | |
1783 <SID> can be used with mappings. It generates a script ID, which identifies | |
1784 the current script. In our typing correction plugin we use it like this: > | |
1785 | |
1786 24 noremap <unique> <script> <Plug>TypecorrAdd <SID>Add | |
1787 .. | |
1788 28 noremap <SID>Add :call <SID>Add(expand("<cword>"), 1)<CR> | |
1789 | |
1790 Thus when a user types "\a", this sequence is invoked: > | |
1791 | |
1792 \a -> <Plug>TypecorrAdd -> <SID>Add -> :call <SID>Add() | |
1793 | |
1794 If another script would also map <SID>Add, it would get another script ID and | |
1795 thus define another mapping. | |
1796 | |
1797 Note that instead of s:Add() we use <SID>Add() here. That is because the | |
1798 mapping is typed by the user, thus outside of the script. The <SID> is | |
1799 translated to the script ID, so that Vim knows in which script to look for | |
1800 the Add() function. | |
1801 | |
1802 This is a bit complicated, but it's required for the plugin to work together | |
1803 with other plugins. The basic rule is that you use <SID>Add() in mappings and | |
1804 s:Add() in other places (the script itself, autocommands, user commands). | |
1805 | |
1806 We can also add a menu entry to do the same as the mapping: > | |
1807 | |
1808 26 noremenu <script> Plugin.Add\ Correction <SID>Add | |
1809 | |
1810 The "Plugin" menu is recommended for adding menu items for plugins. In this | |
1811 case only one item is used. When adding more items, creating a submenu is | |
1812 recommended. For example, "Plugin.CVS" could be used for a plugin that offers | |
1813 CVS operations "Plugin.CVS.checkin", "Plugin.CVS.checkout", etc. | |
1814 | |
1815 Note that in line 28 ":noremap" is used to avoid that any other mappings cause | |
1816 trouble. Someone may have remapped ":call", for example. In line 24 we also | |
1817 use ":noremap", but we do want "<SID>Add" to be remapped. This is why | |
1818 "<script>" is used here. This only allows mappings which are local to the | |
1819 script. |:map-<script>| The same is done in line 26 for ":noremenu". | |
1820 |:menu-<script>| | |
1821 | |
1822 | |
1823 <SID> AND <Plug> *using-<Plug>* | |
1824 | |
1825 Both <SID> and <Plug> are used to avoid that mappings of typed keys interfere | |
1826 with mappings that are only to be used from other mappings. Note the | |
1827 difference between using <SID> and <Plug>: | |
1828 | |
1829 <Plug> is visible outside of the script. It is used for mappings which the | |
1830 user might want to map a key sequence to. <Plug> is a special code | |
1831 that a typed key will never produce. | |
1832 To make it very unlikely that other plugins use the same sequence of | |
1833 characters, use this structure: <Plug> scriptname mapname | |
1834 In our example the scriptname is "Typecorr" and the mapname is "Add". | |
1835 This results in "<Plug>TypecorrAdd". Only the first character of | |
1836 scriptname and mapname is uppercase, so that we can see where mapname | |
1837 starts. | |
1838 | |
1839 <SID> is the script ID, a unique identifier for a script. | |
1840 Internally Vim translates <SID> to "<SNR>123_", where "123" can be any | |
1841 number. Thus a function "<SID>Add()" will have a name "<SNR>11_Add()" | |
1842 in one script, and "<SNR>22_Add()" in another. You can see this if | |
1843 you use the ":function" command to get a list of functions. The | |
1844 translation of <SID> in mappings is exactly the same, that's how you | |
1845 can call a script-local function from a mapping. | |
1846 | |
1847 | |
1848 USER COMMAND | |
1849 | |
1850 Now let's add a user command to add a correction: > | |
1851 | |
1852 38 if !exists(":Correct") | |
1853 39 command -nargs=1 Correct :call s:Add(<q-args>, 0) | |
1854 40 endif | |
1855 | |
1856 The user command is defined only if no command with the same name already | |
1857 exists. Otherwise we would get an error here. Overriding the existing user | |
1858 command with ":command!" is not a good idea, this would probably make the user | |
1859 wonder why the command he defined himself doesn't work. |:command| | |
1860 | |
1861 | |
1862 SCRIPT VARIABLES | |
1863 | |
1864 When a variable starts with "s:" it is a script variable. It can only be used | |
1865 inside a script. Outside the script it's not visible. This avoids trouble | |
1866 with using the same variable name in different scripts. The variables will be | |
1867 kept as long as Vim is running. And the same variables are used when sourcing | |
1868 the same script again. |s:var| | |
1869 | |
1870 The fun is that these variables can also be used in functions, autocommands | |
1871 and user commands that are defined in the script. In our example we can add | |
1872 a few lines to count the number of corrections: > | |
1873 | |
1874 19 let s:count = 4 | |
1875 .. | |
1876 30 function s:Add(from, correct) | |
1877 .. | |
1878 34 let s:count = s:count + 1 | |
1879 35 echo s:count . " corrections now" | |
1880 36 endfunction | |
1881 | |
1882 First s:count is initialized to 4 in the script itself. When later the | |
1883 s:Add() function is called, it increments s:count. It doesn't matter from | |
1884 where the function was called, since it has been defined in the script, it | |
1885 will use the local variables from this script. | |
1886 | |
1887 | |
1888 THE RESULT | |
1889 | |
1890 Here is the resulting complete example: > | |
1891 | |
1892 1 " Vim global plugin for correcting typing mistakes | |
1893 2 " Last Change: 2000 Oct 15 | |
1894 3 " Maintainer: Bram Moolenaar <Bram@vim.org> | |
1895 4 " License: This file is placed in the public domain. | |
1896 5 | |
1897 6 if exists("loaded_typecorr") | |
1898 7 finish | |
1899 8 endif | |
1900 9 let loaded_typecorr = 1 | |
1901 10 | |
1902 11 let s:save_cpo = &cpo | |
1903 12 set cpo&vim | |
1904 13 | |
1905 14 iabbrev teh the | |
1906 15 iabbrev otehr other | |
1907 16 iabbrev wnat want | |
1908 17 iabbrev synchronisation | |
1909 18 \ synchronization | |
1910 19 let s:count = 4 | |
1911 20 | |
1912 21 if !hasmapto('<Plug>TypecorrAdd') | |
1913 22 map <unique> <Leader>a <Plug>TypecorrAdd | |
1914 23 endif | |
1915 24 noremap <unique> <script> <Plug>TypecorrAdd <SID>Add | |
1916 25 | |
1917 26 noremenu <script> Plugin.Add\ Correction <SID>Add | |
1918 27 | |
1919 28 noremap <SID>Add :call <SID>Add(expand("<cword>"), 1)<CR> | |
1920 29 | |
1921 30 function s:Add(from, correct) | |
1922 31 let to = input("type the correction for " . a:from . ": ") | |
1923 32 exe ":iabbrev " . a:from . " " . to | |
1924 33 if a:correct | exe "normal viws\<C-R>\" \b\e" | endif | |
1925 34 let s:count = s:count + 1 | |
1926 35 echo s:count . " corrections now" | |
1927 36 endfunction | |
1928 37 | |
1929 38 if !exists(":Correct") | |
1930 39 command -nargs=1 Correct :call s:Add(<q-args>, 0) | |
1931 40 endif | |
1932 41 | |
1933 42 let &cpo = s:save_cpo | |
1934 | |
1935 Line 33 wasn't explained yet. It applies the new correction to the word under | |
1936 the cursor. The |:normal| command is used to use the new abbreviation. Note | |
1937 that mappings and abbreviations are expanded here, even though the function | |
1938 was called from a mapping defined with ":noremap". | |
1939 | |
1940 Using "unix" for the 'fileformat' option is recommended. The Vim scripts will | |
1941 then work everywhere. Scripts with 'fileformat' set to "dos" do not work on | |
1942 Unix. Also see |:source_crnl|. To be sure it is set right, do this before | |
1943 writing the file: > | |
1944 | |
1945 :set fileformat=unix | |
1946 | |
1947 | |
1948 DOCUMENTATION *write-local-help* | |
1949 | |
1950 It's a good idea to also write some documentation for your plugin. Especially | |
1951 when its behavior can be changed by the user. See |add-local-help| for how | |
1952 they are installed. | |
1953 | |
1954 Here is a simple example for a plugin help file, called "typecorr.txt": > | |
1955 | |
1956 1 *typecorr.txt* Plugin for correcting typing mistakes | |
1957 2 | |
1958 3 If you make typing mistakes, this plugin will have them corrected | |
1959 4 automatically. | |
1960 5 | |
1961 6 There are currently only a few corrections. Add your own if you like. | |
1962 7 | |
1963 8 Mappings: | |
1964 9 <Leader>a or <Plug>TypecorrAdd | |
1965 10 Add a correction for the word under the cursor. | |
1966 11 | |
1967 12 Commands: | |
1968 13 :Correct {word} | |
1969 14 Add a correction for {word}. | |
1970 15 | |
1971 16 *typecorr-settings* | |
1972 17 This plugin doesn't have any settings. | |
1973 | |
1974 The first line is actually the only one for which the format matters. It will | |
1975 be extracted from the help file to be put in the "LOCAL ADDITIONS:" section of | |
1976 help.txt |local-additions|. The first "*" must be in the first column of the | |
1977 first line. After adding your help file do ":help" and check that the entries | |
1978 line up nicely. | |
1979 | |
1980 You can add more tags inside ** in your help file. But be careful not to use | |
1981 existing help tags. You would probably use the name of your plugin in most of | |
1982 them, like "typecorr-settings" in the example. | |
1983 | |
1984 Using references to other parts of the help in || is recommended. This makes | |
1985 it easy for the user to find associated help. | |
1986 | |
1987 | |
1988 FILETYPE DETECTION *plugin-filetype* | |
1989 | |
1990 If your filetype is not already detected by Vim, you should create a filetype | |
1991 detection snippet in a separate file. It is usually in the form of an | |
1992 autocommand that sets the filetype when the file name matches a pattern. | |
1993 Example: > | |
1994 | |
1995 au BufNewFile,BufRead *.foo set filetype=foofoo | |
1996 | |
1997 Write this single-line file as "ftdetect/foofoo.vim" in the first directory | |
1998 that appears in 'runtimepath'. For Unix that would be | |
1999 "~/.vim/ftdetect/foofoo.vim". The convention is to use the name of the | |
2000 filetype for the script name. | |
2001 | |
2002 You can make more complicated checks if you like, for example to inspect the | |
2003 contents of the file to recognize the language. Also see |new-filetype|. | |
2004 | |
2005 | |
2006 SUMMARY *plugin-special* | |
2007 | |
2008 Summary of special things to use in a plugin: | |
2009 | |
2010 s:name Variables local to the script. | |
2011 | |
2012 <SID> Script-ID, used for mappings and functions local to | |
2013 the script. | |
2014 | |
2015 hasmapto() Function to test if the user already defined a mapping | |
2016 for functionality the script offers. | |
2017 | |
2018 <Leader> Value of "mapleader", which the user defines as the | |
2019 keys that plugin mappings start with. | |
2020 | |
2021 :map <unique> Give a warning if a mapping already exists. | |
2022 | |
2023 :noremap <script> Use only mappings local to the script, not global | |
2024 mappings. | |
2025 | |
2026 exists(":Cmd") Check if a user command already exists. | |
2027 | |
2028 ============================================================================== | |
161 | 2029 *41.12* Writing a filetype plugin *write-filetype-plugin* *ftplugin* |
7 | 2030 |
2031 A filetype plugin is like a global plugin, except that it sets options and | |
2032 defines mappings for the current buffer only. See |add-filetype-plugin| for | |
2033 how this type of plugin is used. | |
2034 | |
161 | 2035 First read the section on global plugins above |41.11|. All that is said there |
7 | 2036 also applies to filetype plugins. There are a few extras, which are explained |
2037 here. The essential thing is that a filetype plugin should only have an | |
2038 effect on the current buffer. | |
2039 | |
2040 | |
2041 DISABLING | |
2042 | |
2043 If you are writing a filetype plugin to be used by many people, they need a | |
2044 chance to disable loading it. Put this at the top of the plugin: > | |
2045 | |
2046 " Only do this when not done yet for this buffer | |
2047 if exists("b:did_ftplugin") | |
2048 finish | |
2049 endif | |
2050 let b:did_ftplugin = 1 | |
2051 | |
2052 This also needs to be used to avoid that the same plugin is executed twice for | |
2053 the same buffer (happens when using an ":edit" command without arguments). | |
2054 | |
2055 Now users can disable loading the default plugin completely by making a | |
2056 filetype plugin with only this line: > | |
2057 | |
2058 let b:did_ftplugin = 1 | |
2059 | |
2060 This does require that the filetype plugin directory comes before $VIMRUNTIME | |
2061 in 'runtimepath'! | |
2062 | |
2063 If you do want to use the default plugin, but overrule one of the settings, | |
2064 you can write the different setting in a script: > | |
2065 | |
2066 setlocal textwidth=70 | |
2067 | |
2068 Now write this in the "after" directory, so that it gets sourced after the | |
2069 distributed "vim.vim" ftplugin |after-directory|. For Unix this would be | |
2070 "~/.vim/after/ftplugin/vim.vim". Note that the default plugin will have set | |
2071 "b:did_ftplugin", but it is ignored here. | |
2072 | |
2073 | |
2074 OPTIONS | |
2075 | |
2076 To make sure the filetype plugin only affects the current buffer use the > | |
2077 | |
2078 :setlocal | |
2079 | |
2080 command to set options. And only set options which are local to a buffer (see | |
2081 the help for the option to check that). When using |:setlocal| for global | |
2082 options or options local to a window, the value will change for many buffers, | |
2083 and that is not what a filetype plugin should do. | |
2084 | |
2085 When an option has a value that is a list of flags or items, consider using | |
2086 "+=" and "-=" to keep the existing value. Be aware that the user may have | |
2087 changed an option value already. First resetting to the default value and | |
2088 then changing it often a good idea. Example: > | |
2089 | |
2090 :setlocal formatoptions& formatoptions+=ro | |
2091 | |
2092 | |
2093 MAPPINGS | |
2094 | |
2095 To make sure mappings will only work in the current buffer use the > | |
2096 | |
2097 :map <buffer> | |
2098 | |
2099 command. This needs to be combined with the two-step mapping explained above. | |
2100 An example of how to define functionality in a filetype plugin: > | |
2101 | |
2102 if !hasmapto('<Plug>JavaImport') | |
2103 map <buffer> <unique> <LocalLeader>i <Plug>JavaImport | |
2104 endif | |
2105 noremap <buffer> <unique> <Plug>JavaImport oimport ""<Left><Esc> | |
2106 | |
2107 |hasmapto()| is used to check if the user has already defined a map to | |
2108 <Plug>JavaImport. If not, then the filetype plugin defines the default | |
2109 mapping. This starts with |<LocalLeader>|, which allows the user to select | |
2110 the key(s) he wants filetype plugin mappings to start with. The default is a | |
2111 backslash. | |
2112 "<unique>" is used to give an error message if the mapping already exists or | |
2113 overlaps with an existing mapping. | |
2114 |:noremap| is used to avoid that any other mappings that the user has defined | |
2115 interferes. You might want to use ":noremap <script>" to allow remapping | |
2116 mappings defined in this script that start with <SID>. | |
2117 | |
2118 The user must have a chance to disable the mappings in a filetype plugin, | |
2119 without disabling everything. Here is an example of how this is done for a | |
2120 plugin for the mail filetype: > | |
2121 | |
2122 " Add mappings, unless the user didn't want this. | |
2123 if !exists("no_plugin_maps") && !exists("no_mail_maps") | |
2124 " Quote text by inserting "> " | |
2125 if !hasmapto('<Plug>MailQuote') | |
2126 vmap <buffer> <LocalLeader>q <Plug>MailQuote | |
2127 nmap <buffer> <LocalLeader>q <Plug>MailQuote | |
2128 endif | |
2129 vnoremap <buffer> <Plug>MailQuote :s/^/> /<CR> | |
2130 nnoremap <buffer> <Plug>MailQuote :.,$s/^/> /<CR> | |
2131 endif | |
2132 | |
2133 Two global variables are used: | |
2134 no_plugin_maps disables mappings for all filetype plugins | |
2135 no_mail_maps disables mappings for a specific filetype | |
2136 | |
2137 | |
2138 USER COMMANDS | |
2139 | |
2140 To add a user command for a specific file type, so that it can only be used in | |
2141 one buffer, use the "-buffer" argument to |:command|. Example: > | |
2142 | |
2143 :command -buffer Make make %:r.s | |
2144 | |
2145 | |
2146 VARIABLES | |
2147 | |
2148 A filetype plugin will be sourced for each buffer of the type it's for. Local | |
2149 script variables |s:var| will be shared between all invocations. Use local | |
2150 buffer variables |b:var| if you want a variable specifically for one buffer. | |
2151 | |
2152 | |
2153 FUNCTIONS | |
2154 | |
2155 When defining a function, this only needs to be done once. But the filetype | |
2156 plugin will be sourced every time a file with this filetype will be opened. | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2157 This construct makes sure the function is only defined once: > |
7 | 2158 |
2159 :if !exists("*s:Func") | |
2160 : function s:Func(arg) | |
2161 : ... | |
2162 : endfunction | |
2163 :endif | |
2164 < | |
2165 | |
2166 UNDO *undo_ftplugin* | |
2167 | |
2168 When the user does ":setfiletype xyz" the effect of the previous filetype | |
2169 should be undone. Set the b:undo_ftplugin variable to the commands that will | |
2170 undo the settings in your filetype plugin. Example: > | |
2171 | |
2172 let b:undo_ftplugin = "setlocal fo< com< tw< commentstring<" | |
2173 \ . "| unlet b:match_ignorecase b:match_words b:match_skip" | |
2174 | |
2175 Using ":setlocal" with "<" after the option name resets the option to its | |
2176 global value. That is mostly the best way to reset the option value. | |
2177 | |
2178 This does require removing the "C" flag from 'cpoptions' to allow line | |
2179 continuation, as mentioned above |use-cpo-save|. | |
2180 | |
2181 | |
2182 FILE NAME | |
2183 | |
2184 The filetype must be included in the file name |ftplugin-name|. Use one of | |
2185 these three forms: | |
2186 | |
2187 .../ftplugin/stuff.vim | |
2188 .../ftplugin/stuff_foo.vim | |
2189 .../ftplugin/stuff/bar.vim | |
2190 | |
2191 "stuff" is the filetype, "foo" and "bar" are arbitrary names. | |
2192 | |
2193 | |
2194 SUMMARY *ftplugin-special* | |
2195 | |
2196 Summary of special things to use in a filetype plugin: | |
2197 | |
2198 <LocalLeader> Value of "maplocalleader", which the user defines as | |
2199 the keys that filetype plugin mappings start with. | |
2200 | |
2201 :map <buffer> Define a mapping local to the buffer. | |
2202 | |
2203 :noremap <script> Only remap mappings defined in this script that start | |
2204 with <SID>. | |
2205 | |
2206 :setlocal Set an option for the current buffer only. | |
2207 | |
2208 :command -buffer Define a user command local to the buffer. | |
2209 | |
2210 exists("*s:Func") Check if a function was already defined. | |
2211 | |
2212 Also see |plugin-special|, the special things used for all plugins. | |
2213 | |
2214 ============================================================================== | |
161 | 2215 *41.13* Writing a compiler plugin *write-compiler-plugin* |
7 | 2216 |
2217 A compiler plugin sets options for use with a specific compiler. The user can | |
2218 load it with the |:compiler| command. The main use is to set the | |
2219 'errorformat' and 'makeprg' options. | |
2220 | |
2221 Easiest is to have a look at examples. This command will edit all the default | |
2222 compiler plugins: > | |
2223 | |
2224 :next $VIMRUNTIME/compiler/*.vim | |
2225 | |
2226 Use |:next| to go to the next plugin file. | |
2227 | |
2228 There are two special items about these files. First is a mechanism to allow | |
2229 a user to overrule or add to the default file. The default files start with: > | |
2230 | |
2231 :if exists("current_compiler") | |
2232 : finish | |
2233 :endif | |
2234 :let current_compiler = "mine" | |
2235 | |
2236 When you write a compiler file and put it in your personal runtime directory | |
2237 (e.g., ~/.vim/compiler for Unix), you set the "current_compiler" variable to | |
2238 make the default file skip the settings. | |
570 | 2239 *:CompilerSet* |
7 | 2240 The second mechanism is to use ":set" for ":compiler!" and ":setlocal" for |
2241 ":compiler". Vim defines the ":CompilerSet" user command for this. However, | |
2242 older Vim versions don't, thus your plugin should define it then. This is an | |
2243 example: > | |
2244 | |
2245 if exists(":CompilerSet") != 2 | |
2246 command -nargs=* CompilerSet setlocal <args> | |
2247 endif | |
2248 CompilerSet errorformat& " use the default 'errorformat' | |
2249 CompilerSet makeprg=nmake | |
2250 | |
2251 When you write a compiler plugin for the Vim distribution or for a system-wide | |
2252 runtime directory, use the mechanism mentioned above. When | |
2253 "current_compiler" was already set by a user plugin nothing will be done. | |
2254 | |
2255 When you write a compiler plugin to overrule settings from a default plugin, | |
2256 don't check "current_compiler". This plugin is supposed to be loaded | |
2257 last, thus it should be in a directory at the end of 'runtimepath'. For Unix | |
2258 that could be ~/.vim/after/compiler. | |
2259 | |
2260 ============================================================================== | |
170 | 2261 *41.14* Writing a plugin that loads quickly *write-plugin-quickload* |
2262 | |
2263 A plugin may grow and become quite long. The startup delay may become | |
1620 | 2264 noticeable, while you hardly ever use the plugin. Then it's time for a |
170 | 2265 quickload plugin. |
2266 | |
2267 The basic idea is that the plugin is loaded twice. The first time user | |
2268 commands and mappings are defined that offer the functionality. The second | |
2269 time the functions that implement the functionality are defined. | |
2270 | |
2271 It may sound surprising that quickload means loading a script twice. What we | |
2272 mean is that it loads quickly the first time, postponing the bulk of the | |
2273 script to the second time, which only happens when you actually use it. When | |
2274 you always use the functionality it actually gets slower! | |
2275 | |
793 | 2276 Note that since Vim 7 there is an alternative: use the |autoload| |
2277 functionality |41.15|. | |
2278 | |
170 | 2279 The following example shows how it's done: > |
2280 | |
2281 " Vim global plugin for demonstrating quick loading | |
2282 " Last Change: 2005 Feb 25 | |
2283 " Maintainer: Bram Moolenaar <Bram@vim.org> | |
2284 " License: This file is placed in the public domain. | |
2285 | |
2286 if !exists("s:did_load") | |
2287 command -nargs=* BNRead call BufNetRead(<f-args>) | |
2288 map <F19> :call BufNetWrite('something')<CR> | |
2289 | |
2290 let s:did_load = 1 | |
2291 exe 'au FuncUndefined BufNet* source ' . expand('<sfile>') | |
2292 finish | |
2293 endif | |
2294 | |
2295 function BufNetRead(...) | |
2296 echo 'BufNetRead(' . string(a:000) . ')' | |
2297 " read functionality here | |
2298 endfunction | |
2299 | |
2300 function BufNetWrite(...) | |
2301 echo 'BufNetWrite(' . string(a:000) . ')' | |
2302 " write functionality here | |
2303 endfunction | |
2304 | |
2305 When the script is first loaded "s:did_load" is not set. The commands between | |
2306 the "if" and "endif" will be executed. This ends in a |:finish| command, thus | |
2307 the rest of the script is not executed. | |
2308 | |
2309 The second time the script is loaded "s:did_load" exists and the commands | |
2310 after the "endif" are executed. This defines the (possible long) | |
2311 BufNetRead() and BufNetWrite() functions. | |
2312 | |
2313 If you drop this script in your plugin directory Vim will execute it on | |
2314 startup. This is the sequence of events that happens: | |
2315 | |
2316 1. The "BNRead" command is defined and the <F19> key is mapped when the script | |
2317 is sourced at startup. A |FuncUndefined| autocommand is defined. The | |
2318 ":finish" command causes the script to terminate early. | |
2319 | |
2320 2. The user types the BNRead command or presses the <F19> key. The | |
2321 BufNetRead() or BufNetWrite() function will be called. | |
856 | 2322 |
170 | 2323 3. Vim can't find the function and triggers the |FuncUndefined| autocommand |
2324 event. Since the pattern "BufNet*" matches the invoked function, the | |
2325 command "source fname" will be executed. "fname" will be equal to the name | |
2326 of the script, no matter where it is located, because it comes from | |
2327 expanding "<sfile>" (see |expand()|). | |
2328 | |
2329 4. The script is sourced again, the "s:did_load" variable exists and the | |
2330 functions are defined. | |
2331 | |
2332 Notice that the functions that are loaded afterwards match the pattern in the | |
2333 |FuncUndefined| autocommand. You must make sure that no other plugin defines | |
2334 functions that match this pattern. | |
2335 | |
2336 ============================================================================== | |
2337 *41.15* Writing library scripts *write-library-script* | |
2338 | |
2339 Some functionality will be required in several places. When this becomes more | |
2340 than a few lines you will want to put it in one script and use it from many | |
2341 scripts. We will call that one script a library script. | |
2342 | |
2343 Manually loading a library script is possible, so long as you avoid loading it | |
2344 when it's already done. You can do this with the |exists()| function. | |
2345 Example: > | |
2346 | |
2347 if !exists('*MyLibFunction') | |
2348 runtime library/mylibscript.vim | |
2349 endif | |
2350 call MyLibFunction(arg) | |
2351 | |
2352 Here you need to know that MyLibFunction() is defined in a script | |
2353 "library/mylibscript.vim" in one of the directories in 'runtimepath'. | |
2354 | |
2355 To make this a bit simpler Vim offers the autoload mechanism. Then the | |
2356 example looks like this: > | |
2357 | |
270 | 2358 call mylib#myfunction(arg) |
170 | 2359 |
2360 That's a lot simpler, isn't it? Vim will recognize the function name and when | |
2361 it's not defined search for the script "autoload/mylib.vim" in 'runtimepath'. | |
270 | 2362 That script must define the "mylib#myfunction()" function. |
170 | 2363 |
2364 You can put many other functions in the mylib.vim script, you are free to | |
2365 organize your functions in library scripts. But you must use function names | |
323 | 2366 where the part before the '#' matches the script name. Otherwise Vim would |
2367 not know what script to load. | |
170 | 2368 |
681 | 2369 If you get really enthusiastic and write lots of library scripts, you may |
170 | 2370 want to use subdirectories. Example: > |
2371 | |
270 | 2372 call netlib#ftp#read('somefile') |
170 | 2373 |
2374 For Unix the library script used for this could be: | |
2375 | |
2376 ~/.vim/autoload/netlib/ftp.vim | |
2377 | |
2378 Where the function is defined like this: > | |
2379 | |
270 | 2380 function netlib#ftp#read(fname) |
170 | 2381 " Read the file fname through ftp |
2382 endfunction | |
2383 | |
2384 Notice that the name the function is defined with is exactly the same as the | |
323 | 2385 name used for calling the function. And the part before the last '#' |
170 | 2386 exactly matches the subdirectory and script name. |
2387 | |
2388 You can use the same mechanism for variables: > | |
2389 | |
270 | 2390 let weekdays = dutch#weekdays |
170 | 2391 |
2392 This will load the script "autoload/dutch.vim", which should contain something | |
2393 like: > | |
2394 | |
270 | 2395 let dutch#weekdays = ['zondag', 'maandag', 'dinsdag', 'woensdag', |
170 | 2396 \ 'donderdag', 'vrijdag', 'zaterdag'] |
2397 | |
2398 Further reading: |autoload|. | |
2399 | |
2400 ============================================================================== | |
793 | 2401 *41.16* Distributing Vim scripts *distribute-script* |
2402 | |
2403 Vim users will look for scripts on the Vim website: http://www.vim.org. | |
2404 If you made something that is useful for others, share it! | |
2405 | |
2406 Vim scripts can be used on any system. There might not be a tar or gzip | |
2407 command. If you want to pack files together and/or compress them the "zip" | |
2408 utility is recommended. | |
2409 | |
2410 For utmost portability use Vim itself to pack scripts together. This can be | |
2411 done with the Vimball utility. See |vimball|. | |
2412 | |
799 | 2413 It's good if you add a line to allow automatic updating. See |glvs-plugins|. |
2414 | |
793 | 2415 ============================================================================== |
7 | 2416 |
2417 Next chapter: |usr_42.txt| Add new menus | |
2418 | |
2419 Copyright: see |manual-copyright| vim:tw=78:ts=8:ft=help:norl: |