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