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