Mercurial > vim
annotate runtime/doc/usr_41.txt @ 32357:5e2f81645b10 v9.0.1510
patch 9.0.1510: misleading variable name for error message
Commit: https://github.com/vim/vim/commit/70e8028a4d63c83f67bc3314d064613e2041e462
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri May 5 22:58:34 2023 +0100
patch 9.0.1510: misleading variable name for error message
Problem: Misleading variable name for error message.
Solution: Change "name" to "number". (closes https://github.com/vim/vim/issues/12345)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 06 May 2023 00:00:03 +0200 |
parents | 8d6f53a07ffd |
children | d5e673b941cd |
rev | line source |
---|---|
31885 | 1 *usr_41.txt* For Vim version 9.0. Last change: 2023 Jan 17 |
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 | |
29066 | 10 script. There are a lot of them, therefore this is a long chapter. |
7 | 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 |
29104 | 20 |41.9| White space |
21 |41.10| Line continuation | |
22 |41.11| Comments | |
23 |41.12| Fileformat | |
7 | 24 |
25 Next chapter: |usr_42.txt| Add new menus | |
26 Previous chapter: |usr_40.txt| Make new commands | |
27 Table of contents: |usr_toc.txt| | |
28 | |
29 ============================================================================== | |
129 | 30 *41.1* Introduction *vim-script-intro* *script* |
7 | 31 |
32 Your first experience with Vim scripts is the vimrc file. Vim reads it when | |
29066 | 33 it starts up and executes the commands. You can set options to the values you |
34 prefer, define mappings, select plugins and much more. You can use any colon | |
35 command in it (commands that start with a ":"; these are sometimes referred to | |
36 as Ex commands or command-line commands). | |
26847 | 37 |
38 Syntax files are also Vim scripts. As are files that set options for a | |
7 | 39 specific file type. A complicated macro can be defined by a separate Vim |
40 script file. You can think of other uses yourself. | |
41 | |
26847 | 42 Vim script comes in two flavors: legacy and |Vim9|. Since this help file is |
43 for new users, we'll teach you the newer and more convenient |Vim9| syntax. | |
29066 | 44 While legacy script is particularly for Vim, |Vim9| script looks more like |
45 other languages, such as JavaScript and TypeScript. | |
26847 | 46 |
47 To try out Vim script the best way is to edit a script file and source it. | |
48 Basically: > | |
49 :edit test.vim | |
50 [insert the script lines you want] | |
51 :w | |
52 :source % | |
53 | |
7 | 54 Let's start with a simple example: > |
55 | |
26847 | 56 vim9script |
57 var i = 1 | |
58 while i < 5 | |
59 echo "count is" i | |
60 i += 1 | |
61 endwhile | |
7 | 62 < |
161 | 63 The output of the example code is: |
64 | |
65 count is 1 ~ | |
66 count is 2 ~ | |
67 count is 3 ~ | |
68 count is 4 ~ | |
69 | |
26847 | 70 In the first line the `vim9script` command makes clear this is a new, |Vim9| |
29087 | 71 script file. That matters for how the rest of the file is used. It is |
72 recommended to put it in the very fist line, before any comments. | |
29066 | 73 *vim9-declarations* |
26847 | 74 The `var i = 1` command declares the "i" variable and initializes it. The |
161 | 75 generic form is: > |
7 | 76 |
26847 | 77 var {name} = {expression} |
7 | 78 |
79 In this case the variable name is "i" and the expression is a simple value, | |
80 the number one. | |
26847 | 81 |
82 The `while` command starts a loop. The generic form is: > | |
83 | |
84 while {condition} | |
85 {statements} | |
86 endwhile | |
87 | |
88 The statements until the matching `endwhile` are executed for as long as the | |
7 | 89 condition is true. The condition used here is the expression "i < 5". This |
90 is true when the variable i is smaller than five. | |
91 Note: | |
92 If you happen to write a while loop that keeps on running, you can | |
93 interrupt it by pressing CTRL-C (CTRL-Break on MS-Windows). | |
161 | 94 |
26847 | 95 The `echo` command prints its arguments. In this case the string "count is" |
161 | 96 and the value of the variable i. Since i is one, this will print: |
97 | |
98 count is 1 ~ | |
99 | |
26847 | 100 Then there is the `i += 1` command. This does the same thing as "i = i + 1", |
101 it adds one to the variable i and assigns the new value to the same variable. | |
161 | 102 |
103 The example was given to explain the commands, but would you really want to | |
11062 | 104 make such a loop, it can be written much more compact: > |
112 | 105 |
26847 | 106 for i in range(1, 4) |
29066 | 107 echo $"count is {i}" |
26847 | 108 endfor |
109 | |
29066 | 110 We won't explain how `for`, `range()`and `$"string"` work until later. Follow |
111 the links if you are impatient. | |
112 | |
113 | |
114 TRYING OUT EXAMPLES | |
115 | |
116 You can easily try out most examples in these help files without saving the | |
29104 | 117 commands to a file. For example, to try out the "for" loop above do this: |
29066 | 118 1. position the cursor on the "for" |
119 2. start Visual mode with "v" | |
120 3. move down to the "endfor" | |
121 4. press colon, then "so" and Enter | |
122 | |
123 After pressing colon you will see ":'<,'>", which is the range of the Visually | |
124 selected text. | |
125 | |
126 For some commands it matters they are executed as in |Vim9| script. But typed | |
127 commands normally use legacy script syntax, such as the example below that | |
128 causes the E1004 error. For that use this fourth step: | |
129 4. press colon, then "vim9 so" and Enter | |
130 | |
131 "vim9" is short for `vim9cmd`, which is a command modifier to execute the | |
132 following command in |Vim9| syntax. | |
133 | |
134 Note that this won't work for examples that require a script context. | |
112 | 135 |
7 | 136 |
16871 | 137 FOUR KINDS OF NUMBERS |
138 | |
29066 | 139 Numbers can be decimal, hexadecimal, octal and binary. |
24520 | 140 |
141 A hexadecimal number starts with "0x" or "0X". For example "0x1f" is decimal | |
31028 | 142 31 and "0x1234" is decimal 4660. |
24520 | 143 |
26847 | 144 An octal number starts with "0o", "0O". "0o17" is decimal 15. |
24520 | 145 |
146 A binary number starts with "0b" or "0B". For example "0b101" is decimal 5. | |
147 | |
26847 | 148 A decimal number is just digits. Careful: In legacy script don't put a zero |
29066 | 149 before a decimal number, it will be interpreted as an octal number! That's |
150 one reason to use |Vim9| script. | |
26847 | 151 |
29066 | 152 The `echo` command evaluates its argument and when it is a number always |
153 prints the decimal form. Example: > | |
26847 | 154 |
155 echo 0x7f 0o36 | |
7 | 156 < 127 30 ~ |
157 | |
16871 | 158 A number is made negative with a minus sign. This also works for hexadecimal, |
26847 | 159 octal and binary numbers: > |
160 | |
161 echo -0x7f | |
162 < -127 ~ | |
163 | |
164 A minus sign is also used for subtraction. This can sometimes lead to | |
165 confusion. If we put a minus sign before both numbers we get an error: > | |
166 | |
167 echo -0x7f -0o36 | |
168 < E1004: White space required before and after '-' at "-0o36" ~ | |
169 | |
170 Note: if you are not using a |Vim9| script to try out these commands but type | |
171 them directly, they will be executed as legacy script. Then the echo command | |
172 sees the second minus sign as subtraction. To get the error, prefix the | |
173 command with `vim9cmd`: > | |
174 | |
175 vim9cmd echo -0x7f -0o36 | |
176 < E1004: White space required before and after '-' at "-0o36" ~ | |
177 | |
178 White space in an expression is often required to make sure it is easy to read | |
179 and avoid errors. Such as thinking that the "-0o36" above makes the number | |
180 negative, while it is actually seen as a subtraction. | |
181 | |
182 To actually have the minus sign be used for negation, you can put the second | |
27804 | 183 expression in parentheses: > |
26847 | 184 |
185 echo -0x7f (-0o36) | |
29066 | 186 < -127 -30 ~ |
7 | 187 |
188 ============================================================================== | |
189 *41.2* Variables | |
190 | |
191 A variable name consists of ASCII letters, digits and the underscore. It | |
192 cannot start with a digit. Valid variable names are: | |
193 | |
194 counter | |
195 _aap3 | |
196 very_long_variable_name_with_underscores | |
29066 | 197 CamelCaseName |
7 | 198 LENGTH |
199 | |
29104 | 200 Invalid names are "foo.bar" and "6var". |
26847 | 201 |
202 Some variables are global. To see a list of currently defined global | |
203 variables type this command: > | |
7 | 204 |
205 :let | |
206 | |
29066 | 207 You can use global variables everywhere. However, it is too easy to use the |
208 same name in two unrelated scripts. Therefore variables declared in a script | |
209 are local to that script. For example, if you have this in "script1.vim": > | |
26847 | 210 |
211 vim9script | |
212 var counter = 5 | |
213 echo counter | |
214 < 5 ~ | |
215 | |
216 And you try to use the variable in "script2.vim": > | |
217 | |
218 vim9script | |
219 echo counter | |
220 < E121: Undefined variable: counter ~ | |
221 | |
222 Using a script-local variable means you can be sure that it is only changed in | |
223 that script and not elsewhere. | |
224 | |
225 If you do want to share variables between scripts, use the "g:" prefix and | |
29066 | 226 assign the value directly, do not use `var`. And use a specific name to avoid |
227 mistakes. Thus in "script1.vim": > | |
26847 | 228 |
229 vim9script | |
29066 | 230 g:mash_counter = 5 |
231 echo g:mash_counter | |
26847 | 232 < 5 ~ |
233 | |
234 And then in "script2.vim": > | |
235 | |
236 vim9script | |
29066 | 237 echo g:mash_counter |
26847 | 238 < 5 ~ |
239 | |
29066 | 240 Global variables can also be accessed on the command line, E.g. typing this: > |
241 echo g:mash_counter | |
242 That will not work for a script-local variable. | |
243 | |
26847 | 244 More about script-local variables here: |script-variable|. |
7 | 245 |
246 There are more kinds of variables, see |internal-variables|. The most often | |
247 used ones are: | |
248 | |
249 b:name variable local to a buffer | |
250 w:name variable local to a window | |
251 g:name global variable (also in a function) | |
252 v:name variable predefined by Vim | |
253 | |
254 | |
255 DELETING VARIABLES | |
256 | |
26847 | 257 Variables take up memory and show up in the output of the `let` command. To |
258 delete a global variable use the `unlet` command. Example: > | |
259 | |
260 unlet g:counter | |
261 | |
262 This deletes the global variable "g:counter" to free up the memory it uses. | |
263 If you are not sure if the variable exists, and don't want an error message | |
264 when it doesn't, append !: > | |
265 | |
266 unlet! g:counter | |
267 | |
29066 | 268 You cannot `unlet` script-local variables in |Vim9| script, only in legacy |
26847 | 269 script. |
270 | |
29659 | 271 When a script has been processed to the end, the local variables declared |
272 there will not be deleted. Functions defined in the script can use them. | |
273 Example: | |
26847 | 274 > |
275 vim9script | |
276 var counter = 0 | |
277 def g:GetCount(): number | |
29659 | 278 counter += 1 |
279 return counter | |
26847 | 280 enddef |
281 | |
282 Every time you call the function it will return the next count: > | |
283 :echo g:GetCount() | |
284 < 1 ~ | |
285 > | |
286 :echo g:GetCount() | |
287 < 2 ~ | |
288 | |
29066 | 289 If you are worried a script-local variable is consuming too much memory, set |
290 it to an empty or null value after you no longer need it. Example: > | |
291 var lines = readfile(...) | |
292 ... | |
293 lines = [] | |
26847 | 294 |
29066 | 295 Note: below we'll leave out the `vim9script` line from examples, so we can |
296 concentrate on the relevant commands, but you'll still need to put it at the | |
297 top of your script file. | |
7 | 298 |
299 | |
300 STRING VARIABLES AND CONSTANTS | |
301 | |
302 So far only numbers were used for the variable value. Strings can be used as | |
161 | 303 well. Numbers and strings are the basic types of variables that Vim supports. |
26847 | 304 Example: > |
305 | |
306 var name = "Peter" | |
307 echo name | |
27036 | 308 < Peter ~ |
7 | 309 |
26847 | 310 Every variable has a type. Very often, as in this example, the type is |
311 defined by assigning a value. This is called type inference. If you do not | |
312 want to give the variable a value yet, you need to specify the type: > | |
313 | |
314 var name: string | |
315 var age: number | |
29066 | 316 if male |
317 name = "Peter" | |
318 age = 42 | |
319 else | |
320 name = "Elisa" | |
321 age = 45 | |
322 endif | |
26847 | 323 |
324 If you make a mistake and try to assign the wrong type of value you'll get an | |
325 error: > | |
29290 | 326 |
26847 | 327 age = "Peter" |
328 < E1012: Type mismatch; expected number but got string ~ | |
329 | |
330 More about types in |41.8|. | |
331 | |
29066 | 332 To assign a string value to a variable, you can use a string constant. There |
333 are two types of these. First the string in double quotes, as we used | |
26847 | 334 already. If you want to include a double quote inside the string, put a |
335 backslash in front of it: > | |
336 | |
337 var name = "he is \"Peter\"" | |
338 echo name | |
339 < he is "Peter" ~ | |
7 | 340 |
29066 | 341 To avoid the need for backslashes, you can use a string in single quotes: > |
7 | 342 |
26847 | 343 var name = 'he is "Peter"' |
344 echo name | |
345 < he is "Peter" ~ | |
7 | 346 |
161 | 347 Inside a single-quote string all the characters are as they are. Only the |
348 single quote itself is special: you need to use two to get one. A backslash | |
349 is taken literally, thus you can't use it to change the meaning of the | |
26847 | 350 character after it: > |
351 | |
352 var name = 'P\e''ter''' | |
353 echo name | |
354 < P\e'ter' ~ | |
355 | |
356 In double-quote strings it is possible to use special characters. Here are a | |
357 few useful ones: | |
7 | 358 |
359 \t <Tab> | |
360 \n <NL>, line break | |
361 \r <CR>, <Enter> | |
362 \e <Esc> | |
363 \b <BS>, backspace | |
364 \" " | |
365 \\ \, backslash | |
366 \<Esc> <Esc> | |
367 \<C-W> CTRL-W | |
368 | |
369 The last two are just examples. The "\<name>" form can be used to include | |
370 the special key "name". | |
26847 | 371 |
372 See |expr-quote| for the full list of special items in a string. | |
7 | 373 |
374 ============================================================================== | |
375 *41.3* Expressions | |
376 | |
26847 | 377 Vim has a fairly standard way to handle expressions. You can read the |
7 | 378 definition here: |expression-syntax|. Here we will show the most common |
379 items. | |
26847 | 380 |
381 The numbers, strings and variables mentioned above are expressions by | |
7 | 382 themselves. Thus everywhere an expression is expected, you can use a number, |
383 string or variable. Other basic items in an expression are: | |
384 | |
385 $NAME environment variable | |
29066 | 386 &name option value |
387 @r register contents | |
7 | 388 |
389 Examples: > | |
390 | |
26847 | 391 echo "The value of 'tabstop' is" &ts |
392 echo "Your home directory is" $HOME | |
393 if @a == 'text' | |
394 | |
395 The &name form can also be used to set an option value, do something and | |
396 restore the old value. Example: > | |
397 | |
398 var save_ic = &ic | |
399 set noic | |
400 s/The Start/The Beginning/ | |
401 &ic = save_ic | |
7 | 402 |
403 This makes sure the "The Start" pattern is used with the 'ignorecase' option | |
161 | 404 off. Still, it keeps the value that the user had set. (Another way to do |
405 this would be to add "\C" to the pattern, see |/\C|.) | |
7 | 406 |
407 | |
408 MATHEMATICS | |
409 | |
410 It becomes more interesting if we combine these basic items. Let's start with | |
411 mathematics on numbers: | |
412 | |
413 a + b add | |
414 a - b subtract | |
415 a * b multiply | |
416 a / b divide | |
417 a % b modulo | |
418 | |
419 The usual precedence is used. Example: > | |
420 | |
26847 | 421 echo 10 + 5 * 2 |
7 | 422 < 20 ~ |
423 | |
2709 | 424 Grouping is done with parentheses. No surprises here. Example: > |
7 | 425 |
26847 | 426 echo (10 + 5) * 2 |
7 | 427 < 30 ~ |
428 | |
29066 | 429 |
430 OTHERS | |
431 | |
22171 | 432 Strings can be concatenated with ".." (see |expr6|). Example: > |
433 | |
29066 | 434 echo "Name: " .. name |
435 Name: Peter | |
7 | 436 |
26847 | 437 When the "echo" command gets multiple arguments, it separates them with a |
7 | 438 space. In the example the argument is a single expression, thus no space is |
439 inserted. | |
440 | |
29066 | 441 If you don't like the concatenation you can use the $"string" form, which |
442 accepts an expression in curly braces: > | |
443 echo $"Name: {name}" | |
444 | |
31200 | 445 See |interpolated-string| for more information. |
29066 | 446 |
26847 | 447 Borrowed from the C language is the conditional expression: > |
7 | 448 |
449 a ? b : c | |
450 | |
451 If "a" evaluates to true "b" is used, otherwise "c" is used. Example: > | |
452 | |
26847 | 453 var nr = 4 |
454 echo nr > 5 ? "nr is big" : "nr is small" | |
455 < nr is small ~ | |
7 | 456 |
457 The three parts of the constructs are always evaluated first, thus you could | |
26847 | 458 see it works as: > |
7 | 459 |
460 (a) ? (b) : (c) | |
461 | |
29066 | 462 There is also the falsy operator: > |
463 echo name ?? "No name given" | |
464 See |??|. | |
465 | |
7 | 466 ============================================================================== |
467 *41.4* Conditionals | |
468 | |
26847 | 469 The `if` commands executes the following statements, until the matching |
470 `endif`, only when a condition is met. The generic form is: | |
471 | |
472 if {condition} | |
7 | 473 {statements} |
26847 | 474 endif |
475 | |
476 Only when the expression {condition} evaluates to true or one will the | |
477 {statements} be executed. If they are not executed they must still be valid | |
478 commands. If they contain garbage, Vim won't be able to find the matching | |
479 `endif`. | |
480 | |
481 You can also use `else`. The generic form for this is: | |
482 | |
483 if {condition} | |
7 | 484 {statements} |
26847 | 485 else |
7 | 486 {statements} |
26847 | 487 endif |
488 | |
489 The second {statements} block is only executed if the first one isn't. | |
490 | |
491 Finally, there is `elseif` | |
492 | |
493 if {condition} | |
7 | 494 {statements} |
26847 | 495 elseif {condition} |
7 | 496 {statements} |
26847 | 497 endif |
498 | |
499 This works just like using `else` and then `if`, but without the need for an | |
500 extra `endif`. | |
501 | |
502 A useful example for your vimrc file is checking the 'term' option and doing | |
503 something depending upon its value: > | |
504 | |
505 if &term == "xterm" | |
506 # Do stuff for xterm | |
507 elseif &term == "vt100" | |
508 # Do stuff for a vt100 terminal | |
509 else | |
510 # Do something for other terminals | |
511 endif | |
512 | |
513 This uses "#" to start a comment, more about that later. | |
7 | 514 |
515 | |
516 LOGIC OPERATIONS | |
517 | |
518 We already used some of them in the examples. These are the most often used | |
519 ones: | |
520 | |
521 a == b equal to | |
522 a != b not equal to | |
523 a > b greater than | |
524 a >= b greater than or equal to | |
525 a < b less than | |
526 a <= b less than or equal to | |
527 | |
26847 | 528 The result is true if the condition is met and false otherwise. An example: > |
529 | |
29066 | 530 if v:version >= 800 |
26847 | 531 echo "congratulations" |
532 else | |
533 echo "you are using an old version, upgrade!" | |
534 endif | |
7 | 535 |
536 Here "v:version" is a variable defined by Vim, which has the value of the Vim | |
29066 | 537 version. 800 is for version 8.0, version 8.1 has the value 801. This is |
538 useful to write a script that works with multiple versions of Vim. | |
539 See |v:version|. You can also check for a specific feature with `has()` or a | |
540 specific patch, see |has-patch|. | |
7 | 541 |
542 The logic operators work both for numbers and strings. When comparing two | |
543 strings, the mathematical difference is used. This compares byte values, | |
544 which may not be right for some languages. | |
26847 | 545 |
546 If you try to compare a string with a number you will get an error. | |
547 | |
548 For strings there are two more useful items: | |
549 | |
550 str =~ pat matches with | |
551 str !~ pat does not match with | |
552 | |
553 The left item "str" is used as a string. The right item "pat" is used as a | |
7 | 554 pattern, like what's used for searching. Example: > |
555 | |
26847 | 556 if str =~ " " |
557 echo "str contains a space" | |
558 endif | |
559 if str !~ '\.$' | |
560 echo "str does not end in a full stop" | |
561 endif | |
7 | 562 |
563 Notice the use of a single-quote string for the pattern. This is useful, | |
29066 | 564 because patterns tend to contain many backslashes and backslashes need to be |
565 doubled in a double-quote string. | |
7 | 566 |
26847 | 567 The match is not anchored, if you want to match the whole string start with |
568 "^" and end with "$". | |
569 | |
570 The 'ignorecase' option is not used when comparing strings. When you do want | |
571 to ignore case append "?". Thus "==?" compares two strings to be equal while | |
572 ignoring case. For the full table see |expr-==|. | |
7 | 573 |
574 | |
575 MORE LOOPING | |
576 | |
26847 | 577 The `while` command was already mentioned. Two more statements can be used in |
578 between the `while` and the `endwhile`: | |
579 | |
580 continue Jump back to the start of the while loop; the | |
7 | 581 loop continues. |
26847 | 582 break Jump forward to the `endwhile`; the loop is |
7 | 583 discontinued. |
584 | |
585 Example: > | |
586 | |
27036 | 587 var counter = 1 |
26847 | 588 while counter < 40 |
27036 | 589 if skip_number(counter) |
26847 | 590 continue |
591 endif | |
27036 | 592 if last_number(counter) |
26847 | 593 break |
594 endif | |
595 sleep 50m | |
27036 | 596 ++counter |
26847 | 597 endwhile |
598 | |
599 The `sleep` command makes Vim take a nap. The "50m" specifies fifty | |
600 milliseconds. Another example is `sleep 4`, which sleeps for four seconds. | |
601 | |
29066 | 602 `continue` and `break` can also be used in between `for` and `endfor`. |
26847 | 603 Even more looping can be done with the `for` command, see below in |41.8|. |
161 | 604 |
7 | 605 ============================================================================== |
606 *41.5* Executing an expression | |
607 | |
608 So far the commands in the script were executed by Vim directly. The | |
26847 | 609 `execute` command allows executing the result of an expression. This is a |
7 | 610 very powerful way to build commands and execute them. |
26847 | 611 |
612 An example is to jump to a tag, which is contained in a variable: > | |
613 | |
614 execute "tag " .. tag_name | |
22171 | 615 |
616 The ".." is used to concatenate the string "tag " with the value of variable | |
7 | 617 "tag_name". Suppose "tag_name" has the value "get_cmd", then the command that |
618 will be executed is: > | |
619 | |
26847 | 620 tag get_cmd |
621 | |
622 The `execute` command can only execute Ex commands. The `normal` command | |
7 | 623 executes Normal mode commands. However, its argument is not an expression but |
624 the literal command characters. Example: > | |
625 | |
26847 | 626 normal gg=G |
627 | |
628 This jumps to the first line with "gg" and formats all lines with the "=" | |
629 operator and the "G" movement. | |
630 | |
631 To make `normal` work with an expression, combine `execute` with it. | |
7 | 632 Example: > |
633 | |
26847 | 634 execute "normal " .. count .. "j" |
635 | |
636 This will move the cursor "count" lines down. | |
637 | |
638 Make sure that the argument for `normal` is a complete command. Otherwise | |
29066 | 639 Vim will run into the end of the argument and silently abort the command. For |
640 example, if you start the delete operator, you must give the movement command | |
641 also. This works: > | |
29290 | 642 |
26847 | 643 normal d$ |
644 | |
645 This does nothing: > | |
646 | |
647 normal d | |
648 | |
649 If you start Insert mode and do not end it with Esc, it will end anyway. This | |
650 works to insert "new text": > | |
651 | |
652 execute "normal inew text" | |
653 | |
654 If you want to do something after inserting text you do need to end Insert | |
655 mode: > | |
656 | |
657 execute "normal inew text\<Esc>b" | |
658 | |
659 This inserts "new text" and puts the cursor on the first letter of "text". | |
660 Notice the use of the special key "\<Esc>". This avoids having to enter a | |
661 real <Esc> character in your script. That is where `execute` with a | |
662 double-quote string comes in handy. | |
7 | 663 |
29066 | 664 If you don't want to execute a string as a command but evaluate it to get the |
665 result of the expression, you can use the eval() function: > | |
161 | 666 |
26847 | 667 var optname = "path" |
668 var optvalue = eval('&' .. optname) | |
161 | 669 |
670 A "&" character is prepended to "path", thus the argument to eval() is | |
671 "&path". The result will then be the value of the 'path' option. | |
672 | |
7 | 673 ============================================================================== |
674 *41.6* Using functions | |
675 | |
676 Vim defines many functions and provides a large amount of functionality that | |
677 way. A few examples will be given in this section. You can find the whole | |
26847 | 678 list below: |function-list|. |
679 | |
29066 | 680 A function is called with the parameters in between parentheses, separated by |
681 commas. Example: > | |
7 | 682 |
29066 | 683 search("Date: ", "W") |
7 | 684 |
685 This calls the search() function, with arguments "Date: " and "W". The | |
686 search() function uses its first argument as a search pattern and the second | |
687 one as flags. The "W" flag means the search doesn't wrap around the end of | |
688 the file. | |
689 | |
31028 | 690 Using the `call` command is optional in |Vim9| script. It is required in |
29104 | 691 legacy script and on the command line: > |
26847 | 692 |
29066 | 693 call search("Date: ", "W") |
26847 | 694 |
7 | 695 A function can be called in an expression. Example: > |
696 | |
26847 | 697 var line = getline(".") |
698 var repl = substitute(line, '\a', "*", "g") | |
699 setline(".", repl) | |
7 | 700 |
161 | 701 The getline() function obtains a line from the current buffer. Its argument |
702 is a specification of the line number. In this case "." is used, which means | |
703 the line where the cursor is. | |
26847 | 704 |
29066 | 705 The substitute() function does something similar to the `:substitute` command. |
706 The first argument "line" is the string on which to perform the substitution. | |
707 The second argument '\a' is the pattern, the third "*" is the replacement | |
708 string. Finally, the last argument "g" is the flags. | |
26847 | 709 |
710 The setline() function sets the line, specified by the first argument, to a | |
7 | 711 new string, the second argument. In this example the line under the cursor is |
712 replaced with the result of the substitute(). Thus the effect of the three | |
713 statements is equal to: > | |
714 | |
715 :substitute/\a/*/g | |
716 | |
29104 | 717 Using the functions becomes interesting when you do more work before and |
7 | 718 after the substitute() call. |
719 | |
720 | |
721 FUNCTIONS *function-list* | |
722 | |
723 There are many functions. We will mention them here, grouped by what they are | |
26847 | 724 used for. You can find an alphabetical list here: |builtin-function-list|. |
725 Use CTRL-] on the function name to jump to detailed help on it. | |
7 | 726 |
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
|
727 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
|
728 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
|
729 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
|
730 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
|
731 str2list() get list of numbers from a string |
1620 | 732 str2nr() convert a string to a Number |
733 str2float() convert a string to a Float | |
824 | 734 printf() format a string according to % items |
7 | 735 escape() escape characters in a string with a '\' |
1620 | 736 shellescape() escape a string for use with a shell command |
737 fnameescape() escape a file name for use with a Vim command | |
824 | 738 tr() translate characters from one set to another |
7 | 739 strtrans() translate a string to make it printable |
30230 | 740 keytrans() translate internal keycodes to a form that |
741 can be used by |:map| | |
7 | 742 tolower() turn a string to lowercase |
743 toupper() turn a string to uppercase | |
21973
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
744 charclass() class of a character |
7 | 745 match() position where a pattern matches in a string |
746 matchend() position where a pattern match ends in a string | |
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
747 matchfuzzy() fuzzy matches a string in a list of strings |
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
748 matchfuzzypos() fuzzy matches a string in a list of strings |
7 | 749 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
|
750 matchstrpos() match and positions of a pattern in a string |
824 | 751 matchlist() like matchstr() and also return submatches |
7 | 752 stridx() first index of a short string in a long string |
753 strridx() last index of a short string in a long string | |
5618 | 754 strlen() length of a string in bytes |
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
755 strcharlen() length of a string in characters |
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
756 strchars() number of characters in a string |
32307
8d6f53a07ffd
patch 9.0.1485: no functions for converting from/to UTF-16 index
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
757 strutf16len() number of UTF-16 code units in a string |
5618 | 758 strwidth() size of string when displayed |
759 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
|
760 setcellwidths() set character cell width overrides |
31760
f348559ce426
patch 9.0.1212: cannot read back what setcellwidths() has done
Bram Moolenaar <Bram@vim.org>
parents:
31579
diff
changeset
|
761 getcellwidths() get character cell width overrides |
7 | 762 substitute() substitute a pattern match with a string |
2908 | 763 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
|
764 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
|
765 strcharpart() get part of a string using char index |
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
766 slice() take a slice of a string, using char index in |
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
767 Vim9 script |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
768 strgetchar() get character from a string using char index |
7 | 769 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
|
770 expandcmd() expand a command like done for `:edit` |
7 | 771 iconv() convert text from one encoding to another |
824 | 772 byteidx() byte index of a character in a string |
5618 | 773 byteidxcomp() like byteidx() but count composing characters |
23380
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
774 charidx() character index of a byte in a string |
32307
8d6f53a07ffd
patch 9.0.1485: no functions for converting from/to UTF-16 index
Bram Moolenaar <Bram@vim.org>
parents:
31885
diff
changeset
|
775 utf16idx() UTF-16 index of a byte in a string |
824 | 776 repeat() repeat a string multiple times |
777 eval() evaluate a string expression | |
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9319
diff
changeset
|
778 execute() execute an Ex command and get the output |
16871 | 779 win_execute() like execute() but in a specified window |
15068 | 780 trim() trim characters from a string |
21989
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
781 gettext() lookup message translation |
7 | 782 |
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
|
783 List manipulation: *list-functions* |
112 | 784 get() get an item without error for wrong index |
785 len() number of items in a List | |
786 empty() check if List is empty | |
787 insert() insert an item somewhere in a List | |
788 add() append an item to a List | |
789 extend() append a List to a List | |
23588
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23573
diff
changeset
|
790 extendnew() make a new List and append items |
112 | 791 remove() remove one or more items from a List |
792 copy() make a shallow copy of a List | |
793 deepcopy() make a full copy of a List | |
794 filter() remove selected items from a List | |
795 map() change each List item | |
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
796 mapnew() make a new List with changed items |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
797 reduce() reduce a List to a value |
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
798 slice() take a slice of a List |
112 | 799 sort() sort a List |
29712
bdb31515f78b
patch 9.0.0196: finding value in list may require a for loop
Bram Moolenaar <Bram@vim.org>
parents:
29659
diff
changeset
|
800 reverse() reverse the order of a List or Blob |
5763 | 801 uniq() remove copies of repeated adjacent items |
112 | 802 split() split a String into a List |
803 join() join List items into a String | |
824 | 804 range() return a List with a sequence of numbers |
112 | 805 string() String representation of a List |
806 call() call a function with List as arguments | |
29712
bdb31515f78b
patch 9.0.0196: finding value in list may require a for loop
Bram Moolenaar <Bram@vim.org>
parents:
29659
diff
changeset
|
807 index() index of a value in a List or Blob |
bdb31515f78b
patch 9.0.0196: finding value in list may require a for loop
Bram Moolenaar <Bram@vim.org>
parents:
29659
diff
changeset
|
808 indexof() index in a List or Blob where an expression |
31200 | 809 evaluates to true |
112 | 810 max() maximum value in a List |
811 min() minimum value in a List | |
812 count() count number of times a value appears in a List | |
824 | 813 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
|
814 flatten() flatten a List |
23816
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
815 flattennew() flatten a copy of a List |
112 | 816 |
2301
6f63294a1781
Avoid use of the GTK mail_loop() so that the GtkFileChooser can be used.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
817 Dictionary manipulation: *dict-functions* |
323 | 818 get() get an entry without an error for a wrong key |
112 | 819 len() number of entries in a Dictionary |
820 has_key() check whether a key appears in a Dictionary | |
821 empty() check if Dictionary is empty | |
822 remove() remove an entry from a Dictionary | |
823 extend() add entries from one Dictionary to another | |
23588
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23573
diff
changeset
|
824 extendnew() make a new Dictionary and append items |
112 | 825 filter() remove selected entries from a Dictionary |
826 map() change each Dictionary entry | |
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
827 mapnew() make a new Dictionary with changed items |
112 | 828 keys() get List of Dictionary keys |
829 values() get List of Dictionary values | |
830 items() get List of Dictionary key-value pairs | |
831 copy() make a shallow copy of a Dictionary | |
832 deepcopy() make a full copy of a Dictionary | |
833 string() String representation of a Dictionary | |
834 max() maximum value in a Dictionary | |
835 min() minimum value in a Dictionary | |
836 count() count number of times a value appears | |
837 | |
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
|
838 Floating point computation: *float-functions* |
1620 | 839 float2nr() convert Float to Number |
840 abs() absolute value (also works for Number) | |
841 round() round off | |
842 ceil() round up | |
843 floor() round down | |
844 trunc() remove value after decimal point | |
5618 | 845 fmod() remainder of division |
846 exp() exponential | |
847 log() natural logarithm (logarithm to base e) | |
1620 | 848 log10() logarithm to base 10 |
849 pow() value of x to the exponent y | |
850 sqrt() square root | |
851 sin() sine | |
852 cos() cosine | |
2725 | 853 tan() tangent |
854 asin() arc sine | |
855 acos() arc cosine | |
1620 | 856 atan() arc tangent |
2725 | 857 atan2() arc tangent |
858 sinh() hyperbolic sine | |
859 cosh() hyperbolic cosine | |
860 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
|
861 isinf() check for infinity |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
862 isnan() check for not a number |
1620 | 863 |
25806
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
864 Blob manipulation: *blob-functions* |
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
865 blob2list() get a list of numbers from a blob |
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
866 list2blob() get a blob from a list of numbers |
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
867 |
3237 | 868 Other computation: *bitwise-function* |
869 and() bitwise AND | |
870 invert() bitwise invert | |
871 or() bitwise OR | |
872 xor() bitwise XOR | |
5618 | 873 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
|
874 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
|
875 srand() initialize seed used by rand() |
3237 | 876 |
2301
6f63294a1781
Avoid use of the GTK mail_loop() so that the GtkFileChooser can be used.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
877 Variables: *var-functions* |
23594
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
878 type() type of a variable as a number |
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
879 typename() type of a variable as text |
824 | 880 islocked() check if a variable is locked |
11062 | 881 funcref() get a Funcref for a function reference |
824 | 882 function() get a Funcref for a function name |
883 getbufvar() get a variable value from a specific buffer | |
884 setbufvar() set a variable in a specific buffer | |
831 | 885 getwinvar() get a variable from specific window |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
886 gettabvar() get a variable from specific tab page |
831 | 887 gettabwinvar() get a variable from specific window & tab page |
824 | 888 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
|
889 settabvar() set a variable in a specific tab page |
831 | 890 settabwinvar() set a variable in a specific window & tab page |
824 | 891 garbagecollect() possibly free memory |
892 | |
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
|
893 Cursor and mark position: *cursor-functions* *mark-functions* |
7 | 894 col() column number of the cursor or a mark |
895 virtcol() screen column of the cursor or a mark | |
896 line() line number of the cursor or mark | |
897 wincol() window column number of the cursor | |
898 winline() window line number of the cursor | |
899 cursor() position the cursor at a line/column | |
5618 | 900 screencol() get screen column of the cursor |
901 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
|
902 screenpos() screen row and col of a text character |
29024
9f25e0ed831d
patch 8.2.5034: there is no way to get the byte index from a virtual column
Bram Moolenaar <Bram@vim.org>
parents:
28933
diff
changeset
|
903 virtcol2col() byte index of a text character on screen |
5968 | 904 getcurpos() get position of the cursor |
824 | 905 getpos() get position of cursor, mark, etc. |
906 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
|
907 getmarklist() list of global/local marks |
824 | 908 byte2line() get line number at a specific byte count |
909 line2byte() byte count at a specific line | |
910 diff_filler() get the number of filler lines above a line | |
5618 | 911 screenattr() get attribute at a screen line/row |
912 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
|
913 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
|
914 screenstring() get string of characters at a screen line/row |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23380
diff
changeset
|
915 charcol() character number of the cursor or a mark |
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23380
diff
changeset
|
916 getcharpos() get character position of cursor, mark, etc. |
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23380
diff
changeset
|
917 setcharpos() set character position of cursor, mark, etc. |
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23380
diff
changeset
|
918 getcursorcharpos() get character position of the cursor |
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23380
diff
changeset
|
919 setcursorcharpos() set character position of the cursor |
824 | 920 |
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
|
921 Working with text in the current buffer: *text-functions* |
161 | 922 getline() get a line or list of lines from the buffer |
7 | 923 setline() replace a line in the buffer |
161 | 924 append() append line or list of lines in the buffer |
7 | 925 indent() indent of a specific line |
926 cindent() indent according to C indenting | |
927 lispindent() indent according to Lisp indenting | |
928 nextnonblank() find next non-blank line | |
929 prevnonblank() find previous non-blank line | |
930 search() find a match for a pattern | |
667 | 931 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
|
932 searchcount() get number of matches before/after the cursor |
7 | 933 searchpair() find the other end of a start/skip/end |
667 | 934 searchpairpos() find the other end of a start/skip/end |
824 | 935 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
|
936 getcharsearch() return character search information |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
937 setcharsearch() set character search information |
7 | 938 |
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
939 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
|
940 getbufline() get a list of lines from the specified buffer |
31164
7831da568864
patch 9.0.0916: getbufline() is inefficient for getting a single line
Bram Moolenaar <Bram@vim.org>
parents:
31139
diff
changeset
|
941 getbufoneline() get a one line from the specified buffer |
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
942 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
|
943 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
|
944 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
|
945 |
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
|
946 *system-functions* *file-functions* |
7 | 947 System functions and manipulation of files: |
948 glob() expand wildcards | |
949 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
|
950 glob2regpat() convert a glob pattern into a search pattern |
824 | 951 findfile() find a file in a list of directories |
952 finddir() find a directory in a list of directories | |
7 | 953 resolve() find out where a shortcut points to |
954 fnamemodify() modify a file name | |
824 | 955 pathshorten() shorten directory names in a path |
956 simplify() simplify a path without changing its meaning | |
7 | 957 executable() check if an executable program exists |
5814 | 958 exepath() full path of an executable program |
7 | 959 filereadable() check if a file can be read |
960 filewritable() check if a file can be written to | |
824 | 961 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
|
962 setfperm() set the permissions of a file |
824 | 963 getftype() get the kind of a file |
28629
5ef46b938c6e
patch 8.2.4838: checking for absolute path is not trivial
Bram Moolenaar <Bram@vim.org>
parents:
28620
diff
changeset
|
964 isabsolutepath() check if a path is absolute |
7 | 965 isdirectory() check if a directory exists |
966 getfsize() get the size of a file | |
824 | 967 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
|
968 haslocaldir() check if current window used |:lcd| or |:tcd| |
7 | 969 tempname() get the name of a temporary file |
824 | 970 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
|
971 chdir() change current working directory |
7 | 972 delete() delete a file |
973 rename() rename a file | |
5814 | 974 system() get the result of a shell command as a string |
975 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
|
976 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
|
977 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
|
978 setenv() set an environment variable |
7 | 979 hostname() name of the system |
158 | 980 readfile() read a file into a List of lines |
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
981 readblob() read a file into a Blob |
16267 | 982 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
|
983 readdirex() get a List of file information in a directory |
15729 | 984 writefile() write a List of lines or Blob into a file |
7 | 985 |
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
|
986 Date and Time: *date-functions* *time-functions* |
824 | 987 getftime() get last modification time of a file |
988 localtime() get current time in seconds | |
989 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
|
990 strptime() convert a date/time string to time |
824 | 991 reltime() get the current or elapsed time accurately |
992 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
|
993 reltimefloat() convert reltime() result to a Float |
824 | 994 |
28917
c5862dfaf0bd
patch 8.2.4981: it is not possible to manipulate autocommands
Bram Moolenaar <Bram@vim.org>
parents:
28862
diff
changeset
|
995 Autocmds: *autocmd-functions* |
c5862dfaf0bd
patch 8.2.4981: it is not possible to manipulate autocommands
Bram Moolenaar <Bram@vim.org>
parents:
28862
diff
changeset
|
996 autocmd_add() add a list of autocmds and groups |
c5862dfaf0bd
patch 8.2.4981: it is not possible to manipulate autocommands
Bram Moolenaar <Bram@vim.org>
parents:
28862
diff
changeset
|
997 autocmd_delete() delete a list of autocmds and groups |
c5862dfaf0bd
patch 8.2.4981: it is not possible to manipulate autocommands
Bram Moolenaar <Bram@vim.org>
parents:
28862
diff
changeset
|
998 autocmd_get() return a list of autocmds |
c5862dfaf0bd
patch 8.2.4981: it is not possible to manipulate autocommands
Bram Moolenaar <Bram@vim.org>
parents:
28862
diff
changeset
|
999 |
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
|
1000 *buffer-functions* *window-functions* *arg-functions* |
7 | 1001 Buffers, windows and the argument list: |
1002 argc() number of entries in the argument list | |
1003 argidx() current position in the argument list | |
5942 | 1004 arglistid() get id of the argument list |
7 | 1005 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
|
1006 bufadd() add a file to the list of buffers |
7 | 1007 bufexists() check if a buffer exists |
1008 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
|
1009 bufload() ensure a buffer is loaded |
7 | 1010 bufloaded() check if a buffer exists and is loaded |
1011 bufname() get the name of a specific buffer | |
1012 bufnr() get the buffer number of a specific buffer | |
824 | 1013 tabpagebuflist() return List of buffers in a tab page |
1014 tabpagenr() get the number of a tab page | |
1015 tabpagewinnr() like winnr() for a specified tab page | |
7 | 1016 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
|
1017 bufwinid() get the window ID of a specific buffer |
7 | 1018 bufwinnr() get the window number of a specific buffer |
1019 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
|
1020 listener_add() add a callback to listen to changes |
16808 | 1021 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
|
1022 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
|
1023 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
|
1024 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
|
1025 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
|
1026 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
|
1027 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
|
1028 win_id2win() get window nr from window ID |
27047
b94cdb5ef20e
patch 8.2.4052: not easy to resize a window from a plugin
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1029 win_move_separator() move window vertical separator |
b94cdb5ef20e
patch 8.2.4052: not easy to resize a window from a plugin
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1030 win_move_statusline() move window status line |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1031 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
|
1032 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
|
1033 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
|
1034 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
|
1035 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
|
1036 getjumplist() get a list of jump list entries |
31347
56a2af8c0980
patch 9.0.1007: there is no way to get a list of swap file names
Bram Moolenaar <Bram@vim.org>
parents:
31200
diff
changeset
|
1037 swapfilelist() list of existing swap files in 'directory' |
14637 | 1038 swapinfo() information about a swap file |
15068 | 1039 swapname() get the swap file path of a buffer |
824 | 1040 |
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
|
1041 Command line: *command-line-functions* |
28757
add09d468c0d
patch 8.2.4903: cannot get the current cmdline completion type and position
Bram Moolenaar <Bram@vim.org>
parents:
28629
diff
changeset
|
1042 getcmdcompltype() get the type of the current command line |
add09d468c0d
patch 8.2.4903: cannot get the current cmdline completion type and position
Bram Moolenaar <Bram@vim.org>
parents:
28629
diff
changeset
|
1043 completion |
824 | 1044 getcmdline() get the current command line |
1045 getcmdpos() get position of the cursor in the command line | |
28757
add09d468c0d
patch 8.2.4903: cannot get the current cmdline completion type and position
Bram Moolenaar <Bram@vim.org>
parents:
28629
diff
changeset
|
1046 getcmdscreenpos() get screen position of the cursor in the |
add09d468c0d
patch 8.2.4903: cannot get the current cmdline completion type and position
Bram Moolenaar <Bram@vim.org>
parents:
28629
diff
changeset
|
1047 command line |
29894
d8fc1effa724
patch 9.0.0285: it is not easy to change the command line from a plugin
Bram Moolenaar <Bram@vim.org>
parents:
29840
diff
changeset
|
1048 setcmdline() set the current command line |
824 | 1049 setcmdpos() set position of the cursor in the command line |
1050 getcmdtype() return the current command-line type | |
6153 | 1051 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
|
1052 getcompletion() list of command-line completion matches |
23853
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
1053 fullcommand() get full command name |
824 | 1054 |
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
|
1055 Quickfix and location lists: *quickfix-functions* |
824 | 1056 getqflist() list of quickfix errors |
1057 setqflist() modify a quickfix list | |
1058 getloclist() list of location list items | |
1059 setloclist() modify a location list | |
1060 | |
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
|
1061 Insert mode completion: *completion-functions* |
824 | 1062 complete() set found matches |
1063 complete_add() add to found matches | |
1064 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
|
1065 complete_info() get current completion information |
824 | 1066 pumvisible() check if the popup menu is displayed |
18186 | 1067 pum_getpos() position and size of popup menu if visible |
7 | 1068 |
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
|
1069 Folding: *folding-functions* |
7 | 1070 foldclosed() check for a closed fold at a specific line |
1071 foldclosedend() like foldclosed() but return the last line | |
1072 foldlevel() check for the fold level at a specific line | |
1073 foldtext() generate the line displayed for a closed fold | |
824 | 1074 foldtextresult() get the text displayed for a closed fold |
1075 | |
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
|
1076 Syntax and highlighting: *syntax-functions* *highlighting-functions* |
1326 | 1077 clearmatches() clear all matches defined by |matchadd()| and |
1078 the |:match| commands | |
1079 getmatches() get all matches defined by |matchadd()| and | |
1080 the |:match| commands | |
7 | 1081 hlexists() check if a highlight group exists |
26089
c544eacaf066
patch 8.2.3578: manipulating highlighting is complicated
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1082 hlget() get highlight group attributes |
c544eacaf066
patch 8.2.3578: manipulating highlighting is complicated
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1083 hlset() set highlight group attributes |
7 | 1084 hlID() get ID of a highlight group |
1085 synID() get syntax ID at a specific position | |
1086 synIDattr() get a specific attribute of a syntax ID | |
1087 synIDtrans() get translated syntax ID | |
2642 | 1088 synstack() get list of syntax IDs at a specific position |
2662 | 1089 synconcealed() get info about concealing |
824 | 1090 diff_hlID() get highlight ID for diff mode at a position |
1326 | 1091 matchadd() define a pattern to highlight (a "match") |
5979 | 1092 matchaddpos() define a list of positions to highlight |
824 | 1093 matcharg() get info about |:match| arguments |
1326 | 1094 matchdelete() delete a match defined by |matchadd()| or a |
1095 |:match| command | |
1096 setmatches() restore a list of matches saved by | |
1097 |getmatches()| | |
824 | 1098 |
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
|
1099 Spelling: *spell-functions* |
824 | 1100 spellbadword() locate badly spelled word at or after cursor |
1101 spellsuggest() return suggested spelling corrections | |
1102 soundfold() return the sound-a-like equivalent of a word | |
7 | 1103 |
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
|
1104 History: *history-functions* |
7 | 1105 histadd() add an item to a history |
1106 histdel() delete an item from a history | |
1107 histget() get an item from a history | |
1108 histnr() get highest index of a history list | |
1109 | |
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
|
1110 Interactive: *interactive-functions* |
824 | 1111 browse() put up a file requester |
1112 browsedir() put up a directory requester | |
7 | 1113 confirm() let the user make a choice |
1114 getchar() get a character from the user | |
24840
c7aa7acb23bb
patch 8.2.2958: function list test fails
Bram Moolenaar <Bram@vim.org>
parents:
24520
diff
changeset
|
1115 getcharstr() get a character from the user as a string |
7 | 1116 getcharmod() get modifiers for the last typed character |
18639 | 1117 getmousepos() get last known mouse position |
31093
004aee2845d2
patch 9.0.0881: cannot get the currently showing mouse shape
Bram Moolenaar <Bram@vim.org>
parents:
31028
diff
changeset
|
1118 getmouseshape() get name of the current mouse shape |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1119 echoraw() output characters as-is |
1620 | 1120 feedkeys() put characters in the typeahead queue |
7 | 1121 input() get a line from the user |
824 | 1122 inputlist() let the user pick an entry from a list |
7 | 1123 inputsecret() get a line from the user without showing it |
1124 inputdialog() get a line from the user in a dialog | |
230 | 1125 inputsave() save and clear typeahead |
7 | 1126 inputrestore() restore typeahead |
1127 | |
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
|
1128 GUI: *gui-functions* |
824 | 1129 getfontname() get name of current font being used |
13437 | 1130 getwinpos() position of the Vim window |
1131 getwinposx() X position of the Vim window | |
1132 getwinposy() Y position of the Vim window | |
11062 | 1133 balloon_show() set the balloon content |
12909 | 1134 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
|
1135 balloon_gettext() get the text in the balloon |
824 | 1136 |
2301
6f63294a1781
Avoid use of the GTK mail_loop() so that the GtkFileChooser can be used.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
1137 Vim server: *server-functions* |
7 | 1138 serverlist() return the list of server names |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1139 remote_startserver() run a server |
7 | 1140 remote_send() send command characters to a Vim server |
1141 remote_expr() evaluate an expression in a Vim server | |
1142 server2client() send a reply to a client of a Vim server | |
1143 remote_peek() check if there is a reply from a Vim server | |
1144 remote_read() read a reply from a Vim server | |
1145 foreground() move the Vim window to the foreground | |
1146 remote_foreground() move the Vim server window to the foreground | |
1147 | |
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
|
1148 Window size and position: *window-size-functions* |
824 | 1149 winheight() get height of a specific window |
1150 winwidth() get width of a specific window | |
13051 | 1151 win_screenpos() get screen position of a window |
15068 | 1152 winlayout() get layout of windows in a tab page |
824 | 1153 winrestcmd() return command to restore window sizes |
1154 winsaveview() get view of current window | |
1155 winrestview() restore saved view of current window | |
1156 | |
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
1157 Mappings and Menus: *mapping-functions* |
25378
890fd8211202
patch 8.2.3226: new digraph functions use old naming scheme
Bram Moolenaar <Bram@vim.org>
parents:
25294
diff
changeset
|
1158 digraph_get() get |digraph| |
890fd8211202
patch 8.2.3226: new digraph functions use old naming scheme
Bram Moolenaar <Bram@vim.org>
parents:
25294
diff
changeset
|
1159 digraph_getlist() get all |digraph|s |
890fd8211202
patch 8.2.3226: new digraph functions use old naming scheme
Bram Moolenaar <Bram@vim.org>
parents:
25294
diff
changeset
|
1160 digraph_set() register |digraph| |
890fd8211202
patch 8.2.3226: new digraph functions use old naming scheme
Bram Moolenaar <Bram@vim.org>
parents:
25294
diff
changeset
|
1161 digraph_setlist() register multiple |digraph|s |
4159 | 1162 hasmapto() check if a mapping exists |
1163 mapcheck() check if a matching mapping exists | |
1164 maparg() get rhs of a mapping | |
28602
398c5b3211f9
patch 8.2.4825: can only get a list of mappings
Bram Moolenaar <Bram@vim.org>
parents:
28592
diff
changeset
|
1165 maplist() get list of all mappings |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1166 mapset() restore a mapping |
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
1167 menu_info() get information about a menu item |
4159 | 1168 wildmenumode() check if the wildmode is active |
1169 | |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
6153
diff
changeset
|
1170 Testing: *test-functions* |
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
1171 assert_equal() assert that two expressions values are equal |
15068 | 1172 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
|
1173 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
|
1174 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
|
1175 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
|
1176 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
|
1177 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
|
1178 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
|
1179 assert_exception() assert that a command throws an exception |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
1180 assert_beeps() assert that a command beeps |
24313
10c39822f496
patch 8.2.2697: function list test fails
Bram Moolenaar <Bram@vim.org>
parents:
24278
diff
changeset
|
1181 assert_nobeep() assert that a command does not cause a beep |
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
1182 assert_fails() assert that a command fails |
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1183 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
|
1184 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
|
1185 test_autochdir() enable 'autochdir' during startup |
11160 | 1186 test_override() test with Vim internal overrides |
1187 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
|
1188 test_garbagecollect_soon() set a flag to free memory soon |
16808 | 1189 test_getvalue() get value of an internal variable |
27462
b43f6c879d52
patch 8.2.4259: number of test functions for GUI events is growing
Bram Moolenaar <Bram@vim.org>
parents:
27459
diff
changeset
|
1190 test_gui_event() generate a GUI event for testing |
11062 | 1191 test_ignore_error() ignore a specific error message |
31503
b9a4699d6a35
patch 9.0.1084: code handling low level MS-Windows events cannot be tested
Bram Moolenaar <Bram@vim.org>
parents:
31383
diff
changeset
|
1192 test_mswin_event() generate an MS-Windows event |
15729 | 1193 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
|
1194 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
|
1195 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
|
1196 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
|
1197 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
|
1198 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
|
1199 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
|
1200 test_null_string() return a null String |
11062 | 1201 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
|
1202 test_setmouse() set the mouse position |
15068 | 1203 test_feedinput() add key sequence to input buffer |
1204 test_option_not_set() reset flag indicating option was set | |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1205 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
|
1206 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
|
1207 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
|
1208 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
|
1209 |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1210 Inter-process communication: *channel-functions* |
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
1211 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
|
1212 ch_open() open a channel |
00d64eb49ce1
commit https://github.com/vim/vim/commit/681baaf4a4c81418693dcafb81421a8614832e91
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
1213 ch_close() close a channel |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
1214 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
|
1215 ch_read() read a message from a channel |
15512 | 1216 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
|
1217 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
|
1218 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
|
1219 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
|
1220 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
|
1221 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
|
1222 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
|
1223 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
|
1224 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
|
1225 ch_info() get channel information |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1226 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
|
1227 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
|
1228 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
|
1229 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
|
1230 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
|
1231 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
|
1232 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
|
1233 |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1234 Jobs: *job-functions* |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1235 job_start() start a job |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1236 job_stop() stop a job |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1237 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
|
1238 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
|
1239 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
|
1240 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
|
1241 |
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1242 Signs: *sign-functions* |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1243 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
|
1244 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
|
1245 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
|
1246 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
|
1247 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
|
1248 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
|
1249 sign_undefine() undefine a sign |
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1250 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
|
1251 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
|
1252 |
12254 | 1253 Terminal window: *terminal-functions* |
1254 term_start() open a terminal window and run a job | |
1255 term_list() get the list of terminal buffers | |
1256 term_sendkeys() send keystrokes to a terminal | |
1257 term_wait() wait for screen to be updated | |
1258 term_getjob() get the job associated with a terminal | |
1259 term_scrape() get row of a terminal screen | |
1260 term_getline() get a line of text from a terminal | |
1261 term_getattr() get the value of attribute {what} | |
1262 term_getcursor() get the cursor position of a terminal | |
1263 term_getscrolled() get the scroll count of a terminal | |
1264 term_getaltscreen() get the alternate screen flag | |
1265 term_getsize() get the size of a terminal | |
1266 term_getstatus() get the status of a terminal | |
1267 term_gettitle() get the title of a terminal | |
1268 term_gettty() get the tty name of a terminal | |
13735 | 1269 term_setansicolors() set 16 ANSI colors, used for GUI |
1270 term_getansicolors() get 16 ANSI colors, used for GUI | |
15068 | 1271 term_dumpdiff() display difference between two screen dumps |
1272 term_dumpload() load a terminal screen dump in a window | |
1273 term_dumpwrite() dump contents of a terminal screen to a file | |
1274 term_setkill() set signal to stop job in a terminal | |
1275 term_setrestore() set command to restore a terminal | |
1276 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
|
1277 term_setapi() set terminal JSON API function name prefix |
12254 | 1278 |
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
1279 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
|
1280 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
|
1281 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
|
1282 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
|
1283 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
|
1284 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
|
1285 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
|
1286 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
|
1287 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
|
1288 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
|
1289 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
|
1290 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
|
1291 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
|
1292 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
|
1293 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
|
1294 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
|
1295 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
|
1296 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
|
1297 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
|
1298 popup_getpos() get actual position and size of a popup |
30697
d914a3812d5b
patch 9.0.0683: cannot specify a time for :echowindow
Bram Moolenaar <Bram@vim.org>
parents:
30230
diff
changeset
|
1299 popup_findecho() get window ID for popup used for `:echowindow` |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1300 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
|
1301 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
|
1302 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
|
1303 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
|
1304 |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1305 Timers: *timer-functions* |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
1306 timer_start() create a timer |
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1307 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
|
1308 timer_stop() stop a timer |
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1309 timer_stopall() stop all timers |
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1310 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
|
1311 |
15068 | 1312 Tags: *tag-functions* |
1313 taglist() get list of matching tags | |
1314 tagfiles() get a list of tags files | |
1315 gettagstack() get the tag stack of a window | |
1316 settagstack() modify the tag stack of a window | |
1317 | |
1318 Prompt Buffer: *promptbuffer-functions* | |
22077
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
1319 prompt_getprompt() get the effective prompt text for a buffer |
15068 | 1320 prompt_setcallback() set prompt callback for a buffer |
1321 prompt_setinterrupt() set interrupt callback for a buffer | |
1322 prompt_setprompt() set the prompt text for a buffer | |
1323 | |
29810
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1324 Registers: *register-functions* |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1325 getreg() get contents of a register |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1326 getreginfo() get information about a register |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1327 getregtype() get type of a register |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1328 setreg() set contents and type of a register |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1329 reg_executing() return the name of the register being executed |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1330 reg_recording() return the name of the register being recorded |
761631155a90
patch 9.0.0244: cannot easily get the list of sourced scripts
Bram Moolenaar <Bram@vim.org>
parents:
29712
diff
changeset
|
1331 |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1332 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
|
1333 prop_add() attach a property at a position |
25640
78ef12e0ce8c
patch 8.2.3356: adding many text properties requires a lot of function calls
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
1334 prop_add_list() attach a property at multiple positions |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1335 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
|
1336 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
|
1337 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
|
1338 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
|
1339 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
|
1340 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
|
1341 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
|
1342 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
|
1343 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
|
1344 |
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1345 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
|
1346 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
|
1347 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
|
1348 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
|
1349 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
|
1350 |
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
|
1351 Various: *various-functions* |
7 | 1352 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
|
1353 state() get current busy state |
7 | 1354 visualmode() last visual mode used |
1355 exists() check if a variable, function, etc. exists | |
25555
446f478d6fb1
patch 8.2.3314: behavior of exists() in a :def function is unpredictable
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
1356 exists_compiled() like exists() but check at compile time |
7 | 1357 has() check if a feature is supported in Vim |
824 | 1358 changenr() return number of most recent change |
7 | 1359 cscope_connection() check if a cscope connection exists |
1360 did_filetype() check if a FileType autocommand was used | |
1361 eventhandler() check if invoked by an event handler | |
1620 | 1362 getpid() get process ID of Vim |
29840 | 1363 getscriptinfo() get list of sourced vim scripts |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1364 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
|
1365 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
|
1366 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
|
1367 terminalprops() properties of the terminal |
824 | 1368 |
7 | 1369 libcall() call a function in an external library |
1370 libcallnr() idem, returning a number | |
824 | 1371 |
5618 | 1372 undofile() get the name of the undo file |
1373 undotree() return the state of the undo tree | |
1374 | |
1375 shiftwidth() effective value of 'shiftwidth' | |
1376 | |
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9319
diff
changeset
|
1377 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
|
1378 |
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
1379 luaeval() evaluate |Lua| expression |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1380 mzeval() evaluate |MzScheme| expression |
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
1381 perleval() evaluate Perl expression (|+perl|) |
5618 | 1382 py3eval() evaluate Python expression (|+python3|) |
1383 pyeval() evaluate Python expression (|+python|) | |
10734 | 1384 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
|
1385 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
|
1386 |
15194 | 1387 debugbreak() interrupt a program being debugged |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1388 |
7 | 1389 ============================================================================== |
1390 *41.7* Defining a function | |
1391 | |
1392 Vim enables you to define your own functions. The basic function declaration | |
1393 begins as follows: > | |
1394 | |
26847 | 1395 def {name}({var1}, {var2}, ...): return-type |
1396 {body} | |
1397 enddef | |
7 | 1398 < |
1399 Note: | |
1400 Function names must begin with a capital letter. | |
1401 | |
1402 Let's define a short function to return the smaller of two numbers. It starts | |
1403 with this line: > | |
1404 | |
26847 | 1405 def Min(num1: number, num2: number): number |
1406 | |
1407 This tells Vim that the function is named "Min", it takes two arguments that | |
1408 are numbers: "num1" and "num2" and returns a number. | |
1409 | |
1410 The first thing you need to do is to check to see which number is smaller: | |
7 | 1411 > |
26847 | 1412 if num1 < num2 |
1413 | |
7 | 1414 Let's assign the variable "smaller" the value of the smallest number: > |
1415 | |
26847 | 1416 var smaller: number |
1417 if num1 < num2 | |
1418 smaller = num1 | |
1419 else | |
1420 smaller = num2 | |
1421 endif | |
7 | 1422 |
29104 | 1423 The variable "smaller" is a local variable. It is declared to be a number, |
1424 that way Vim can warn you for any mistakes. Variables used inside a function | |
1425 are local unless prefixed by something like "g:", "w:", or "b:". | |
7 | 1426 |
1427 Note: | |
1428 To access a global variable from inside a function you must prepend | |
1620 | 1429 "g:" to it. Thus "g:today" inside a function is used for the global |
1430 variable "today", and "today" is another variable, local to the | |
26847 | 1431 function or the script. |
1432 | |
1433 You now use the `return` statement to return the smallest number to the user. | |
7 | 1434 Finally, you end the function: > |
1435 | |
26847 | 1436 return smaller |
1437 enddef | |
7 | 1438 |
1439 The complete function definition is as follows: > | |
1440 | |
26847 | 1441 def Min(num1: number, num2: number): number |
1442 var smaller: number | |
1443 if num1 < num2 | |
1444 smaller = num1 | |
1445 else | |
1446 smaller = num2 | |
1447 endif | |
1448 return smaller | |
1449 enddef | |
1450 | |
1451 Obviously this is a verbose example. You can make it shorter by using two | |
1452 return commands: > | |
1453 | |
1454 def Min(num1: number, num2: number): number | |
1455 if num1 < num2 | |
1456 return num1 | |
1457 endif | |
1458 return num2 | |
1459 enddef | |
1460 | |
1461 And if you remember the conditional expression, you need only one line: > | |
1462 | |
1463 def Min(num1: number, num2: number): number | |
1464 return num1 < num2 ? num1 : num2 | |
1465 enddef | |
161 | 1466 |
681 | 1467 A user defined function is called in exactly the same way as a built-in |
7 | 1468 function. Only the name is different. The Min function can be used like |
1469 this: > | |
1470 | |
26847 | 1471 echo Min(5, 8) |
1472 | |
1473 Only now will the function be executed and the lines be parsed by Vim. | |
7 | 1474 If there are mistakes, like using an undefined variable or function, you will |
1475 now get an error message. When defining the function these errors are not | |
26847 | 1476 detected. To get the errors sooner you can tell Vim to compile all the |
1477 functions in the script: > | |
1478 | |
1479 defcompile | |
1480 | |
29066 | 1481 Compiling functions takes a little time, but does report errors early. You |
1482 could use `:defcompile` at the end of your script while working on it, and | |
1483 comment it out when everything is fine. | |
1484 | |
1485 For a function that does not return anything simply leave out the return type: > | |
26847 | 1486 |
1487 def SayIt(text: string) | |
1488 echo text | |
1489 enddef | |
1490 | |
29104 | 1491 If you want to return any kind of value, you can use the "any" return type: > |
1492 def GetValue(): any | |
1493 This disables type checking for the return value, use only when needed. | |
1494 | |
26847 | 1495 It is also possible to define a legacy function with `function` and |
29066 | 1496 `endfunction`. These do not have types and are not compiled. Therefore they |
1497 execute much slower. | |
7 | 1498 |
1499 | |
1500 USING A RANGE | |
1501 | |
26847 | 1502 A line range can be used with a function call. The function will be called |
1503 once for every line in the range, with the cursor in that line. Example: > | |
1504 | |
1505 def Number() | |
1506 echo "line " .. line(".") .. " contains: " .. getline(".") | |
1507 enddef | |
7 | 1508 |
1509 If you call this function with: > | |
1510 | |
29104 | 1511 :10,15Number() |
7 | 1512 |
26847 | 1513 The function will be called six times, starting on line 10 and ending on line |
1514 15. | |
7 | 1515 |
1516 | |
1517 LISTING FUNCTIONS | |
1518 | |
26847 | 1519 The `function` command lists the names and arguments of all user-defined |
7 | 1520 functions: > |
1521 | |
1522 :function | |
26847 | 1523 < def <SNR>86_Show(start: string, ...items: list<string>) ~ |
7 | 1524 function GetVimIndent() ~ |
1525 function SetSyn(name) ~ | |
1526 | |
26847 | 1527 The "<SNR>" prefix means that a function is script-local. |Vim9| functions |
29121 | 1528 will start with "def" and include argument and return types. Legacy functions |
26847 | 1529 are listed with "function". |
1530 | |
1531 To see what a function does, use its name as an argument for `function`: > | |
7 | 1532 |
1533 :function SetSyn | |
1534 < 1 if &syntax == '' ~ | |
1535 2 let &syntax = a:name ~ | |
1536 3 endif ~ | |
1537 endfunction ~ | |
1538 | |
29066 | 1539 To see the "Show" function you need to include the script prefix, since |
1540 multiple "Show" functions can be defined in different scripts. To find | |
26847 | 1541 the exact name you can use `function`, but the result may be a very long list. |
1542 To only get the functions matching a pattern you can use the `filter` prefix: | |
1543 > | |
1544 :filter Show function | |
1545 < def <SNR>86_Show(start: string, ...items: list<string>) ~ | |
1546 > | |
1547 :function <SNR>86_Show | |
1548 < 1 echohl Title ~ | |
1549 2 echo "start is " .. start ~ | |
1550 etc. | |
1551 | |
7 | 1552 |
1553 DEBUGGING | |
1554 | |
1555 The line number is useful for when you get an error message or when debugging. | |
1556 See |debug-scripts| about debugging mode. | |
26847 | 1557 |
1558 You can also set the 'verbose' option to 12 or higher to see all function | |
7 | 1559 calls. Set it to 15 or higher to see every executed line. |
1560 | |
1561 | |
1562 DELETING A FUNCTION | |
1563 | |
26847 | 1564 To delete the SetSyn() function: > |
1565 | |
1566 :delfunction SetSyn | |
1567 | |
1568 Deleting only works for global functions and functions in legacy script, not | |
1569 for functions defined in a |Vim9| script. | |
1570 | |
1571 You get an error when the function doesn't exist or cannot be deleted. | |
7 | 1572 |
161 | 1573 |
1574 FUNCTION REFERENCES | |
1575 | |
1576 Sometimes it can be useful to have a variable point to one function or | |
29066 | 1577 another. You can do it with a function reference variable. Often shortened |
1578 to "funcref". Example: > | |
26847 | 1579 |
29066 | 1580 def Right(): string |
26847 | 1581 return 'Right!' |
1582 enddef | |
29066 | 1583 def Wrong(): string |
26847 | 1584 return 'Wrong!' |
1585 enddef | |
29290 | 1586 |
26847 | 1587 var Afunc = g:result == 1 ? Right : Wrong |
29066 | 1588 echo Afunc() |
161 | 1589 < Wrong! ~ |
1590 | |
29066 | 1591 This assumes "g:result" is not one. See |Funcref| for details. |
26847 | 1592 |
161 | 1593 Note that the name of a variable that holds a function reference must start |
1594 with a capital. Otherwise it could be confused with the name of a builtin | |
1595 function. | |
1596 | |
29104 | 1597 |
1598 FURTHER READING | |
1599 | |
1600 Using a variable number of arguments is introduced in section |50.2|. | |
1601 | |
25806
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
1602 More information about defining your own functions here: |user-functions|. |
8d55e978f95b
patch 8.2.3438: cannot manipulate blobs
Bram Moolenaar <Bram@vim.org>
parents:
25640
diff
changeset
|
1603 |
7 | 1604 ============================================================================== |
161 | 1605 *41.8* Lists and Dictionaries |
1606 | |
1607 So far we have used the basic types String and Number. Vim also supports two | |
1608 composite types: List and Dictionary. | |
1609 | |
26847 | 1610 A List is an ordered sequence of items. The items can be any kind of value, |
161 | 1611 thus you can make a List of numbers, a List of Lists and even a List of mixed |
1612 items. To create a List with three strings: > | |
1613 | |
29066 | 1614 var alist = ['aap', 'noot', 'mies'] |
161 | 1615 |
1616 The List items are enclosed in square brackets and separated by commas. To | |
1617 create an empty List: > | |
1618 | |
26847 | 1619 var alist = [] |
161 | 1620 |
1621 You can add items to a List with the add() function: > | |
1622 | |
26847 | 1623 var alist = [] |
1624 add(alist, 'foo') | |
1625 add(alist, 'bar') | |
1626 echo alist | |
161 | 1627 < ['foo', 'bar'] ~ |
1628 | |
1629 List concatenation is done with +: > | |
1630 | |
26847 | 1631 var alist = ['foo', 'bar'] |
1632 alist = alist + ['and', 'more'] | |
1633 echo alist | |
1634 < ['foo', 'bar', 'and', 'more'] ~ | |
1635 | |
29066 | 1636 Or, if you want to extend a List with a function, use `extend()`: > |
26847 | 1637 |
1638 var alist = ['one'] | |
1639 extend(alist, ['two', 'three']) | |
1640 echo alist | |
161 | 1641 < ['one', 'two', 'three'] ~ |
1642 | |
29066 | 1643 Notice that using `add()` will have a different effect than `extend()`: > |
26847 | 1644 |
1645 var alist = ['one'] | |
1646 add(alist, ['two', 'three']) | |
1647 echo alist | |
161 | 1648 < ['one', ['two', 'three']] ~ |
1649 | |
26847 | 1650 The second argument of add() is added as an item, now you have a nested list. |
161 | 1651 |
1652 | |
1653 FOR LOOP | |
1654 | |
1655 One of the nice things you can do with a List is iterate over it: > | |
1656 | |
26847 | 1657 var alist = ['one', 'two', 'three'] |
1658 for n in alist | |
1659 echo n | |
1660 endfor | |
161 | 1661 < one ~ |
1662 two ~ | |
1663 three ~ | |
1664 | |
26847 | 1665 This will loop over each element in List "alist", assigning each value to |
161 | 1666 variable "n". The generic form of a for loop is: > |
1667 | |
29066 | 1668 for {varname} in {list-expression} |
26847 | 1669 {commands} |
1670 endfor | |
161 | 1671 |
1672 To loop a certain number of times you need a List of a specific length. The | |
1673 range() function creates one for you: > | |
1674 | |
26847 | 1675 for a in range(3) |
1676 echo a | |
1677 endfor | |
161 | 1678 < 0 ~ |
1679 1 ~ | |
1680 2 ~ | |
1681 | |
1682 Notice that the first item of the List that range() produces is zero, thus the | |
29066 | 1683 last item is one less than the length of the list. Detail: Internally range() |
1684 does not actually create the list, so that a large range used in a for loop | |
1685 works efficiently. When used elsewhere, the range is turned into an actual | |
29121 | 1686 list, which takes more time for a long list. |
26847 | 1687 |
1688 You can also specify the maximum value, the stride and even go backwards: > | |
1689 | |
1690 for a in range(8, 4, -2) | |
1691 echo a | |
1692 endfor | |
161 | 1693 < 8 ~ |
1694 6 ~ | |
1695 4 ~ | |
1696 | |
29066 | 1697 A more useful example, looping over all the lines in the buffer: > |
161 | 1698 |
29066 | 1699 for line in getline(1, 50) |
26847 | 1700 if line =~ "Date: " |
1701 echo line | |
1702 endif | |
1703 endfor | |
161 | 1704 |
29066 | 1705 This looks into lines 1 to 50 (inclusive) and echoes any date found in there. |
1706 | |
1707 For further reading see |Lists|. | |
161 | 1708 |
1709 | |
1710 DICTIONARIES | |
1711 | |
1712 A Dictionary stores key-value pairs. You can quickly lookup a value if you | |
1713 know the key. A Dictionary is created with curly braces: > | |
856 | 1714 |
26847 | 1715 var uk2nl = {one: 'een', two: 'twee', three: 'drie'} |
161 | 1716 |
164 | 1717 Now you can lookup words by putting the key in square brackets: > |
161 | 1718 |
26847 | 1719 echo uk2nl['two'] |
1720 < twee ~ | |
1721 | |
1722 If the key does not have special characters, you can use the dot notation: > | |
1723 | |
1724 echo uk2nl.two | |
161 | 1725 < twee ~ |
1726 | |
1727 The generic form for defining a Dictionary is: > | |
1728 | |
1729 {<key> : <value>, ...} | |
1730 | |
1731 An empty Dictionary is one without any keys: > | |
1732 | |
1733 {} | |
1734 | |
1735 The possibilities with Dictionaries are numerous. There are various functions | |
1736 for them as well. For example, you can obtain a list of the keys and loop | |
1737 over them: > | |
1738 | |
26847 | 1739 for key in keys(uk2nl) |
1740 echo key | |
1741 endfor | |
161 | 1742 < three ~ |
1743 one ~ | |
1744 two ~ | |
1745 | |
1620 | 1746 You will notice the keys are not ordered. You can sort the list to get a |
161 | 1747 specific order: > |
1748 | |
26847 | 1749 for key in sort(keys(uk2nl)) |
1750 echo key | |
1751 endfor | |
161 | 1752 < one ~ |
1753 three ~ | |
1754 two ~ | |
1755 | |
1756 But you can never get back the order in which items are defined. For that you | |
1757 need to use a List, it stores items in an ordered sequence. | |
1758 | |
29066 | 1759 For further reading see |Dictionaries|. |
161 | 1760 |
1761 ============================================================================== | |
29104 | 1762 *41.9* White space |
7 | 1763 |
29269 | 1764 Blank lines are allowed in a script and ignored. |
7 | 1765 |
29269 | 1766 Leading whitespace characters (blanks and TABs) are ignored, except when using |
1767 |:let-heredoc| without "trim". | |
26847 | 1768 |
1769 Trailing whitespace is often ignored, but not always. One command that | |
29104 | 1770 includes it is `map`. You have to watch out for that, it can cause hard to |
1771 understand mistakes. A generic solution is to never use trailing white space, | |
1772 unless you really need it. | |
7 | 1773 |
1774 To include a whitespace character in the value of an option, it must be | |
1775 escaped by a "\" (backslash) as in the following example: > | |
1776 | |
1777 :set tags=my\ nice\ file | |
1778 | |
29066 | 1779 If it would be written as: > |
7 | 1780 |
1781 :set tags=my nice file | |
1782 | |
29066 | 1783 This will issue an error, because it is interpreted as: > |
7 | 1784 |
1785 :set tags=my | |
1786 :set nice | |
1787 :set file | |
1788 | |
26847 | 1789 |Vim9| script is very picky when it comes to white space. This was done |
1790 intentionally to make sure scripts are easy to read and to avoid mistakes. | |
29066 | 1791 If you use white space sensibly it will just work. When not you will get an |
1792 error message telling you where white space is missing or should be removed. | |
26847 | 1793 |
29104 | 1794 ============================================================================== |
1795 *41.10* Line continuation | |
7 | 1796 |
29104 | 1797 In legacy Vim script line continuation is done by preceding a continuation |
1798 line with a backslash: > | |
1799 let mylist = [ | |
1800 \ 'one', | |
1801 \ 'two', | |
1802 \ ] | |
1803 | |
1804 This requires the 'cpo' option to exclude the "C" flag. Normally this is done | |
1805 by putting this at the start of the script: > | |
1806 let s:save_cpo = &cpo | |
1807 set cpo&vim | |
1808 | |
1809 And restore the option at the end of the script: > | |
1810 let &cpo = s:save_cpo | |
1811 unlet s:save_cpo | |
1812 | |
1813 A few more details can be found here: |line-continuation|. | |
1814 | |
1815 In |Vim9| script the backslash can still be used, but in most places it is not | |
1816 needed: > | |
1817 var mylist = [ | |
1818 'one', | |
1819 'two', | |
1820 ] | |
1821 | |
1822 Also, the 'cpo' option does not need to be changed. See | |
1823 |vim9-line-continuation| for details. | |
1824 | |
1825 ============================================================================== | |
1826 *41.11* Comments | |
7 | 1827 |
29066 | 1828 In |Vim9| script the character # starts a comment. That character and |
1829 everything after it until the end-of-line is considered a comment and | |
7 | 1830 is ignored, except for commands that don't consider comments, as shown in |
26847 | 1831 examples below. A comment can start on any character position on the line, |
29066 | 1832 but not when it is part of the command, e.g. inside a string. |
26847 | 1833 |
29290 | 1834 The character " (the double quote mark) starts a comment in legacy script. |
29066 | 1835 This involves some cleverness to make sure double quoted strings are not |
1836 recognized as comments (just one reason to prefer |Vim9| script). | |
7 | 1837 |
1838 There is a little "catch" with comments for some commands. Examples: > | |
1839 | |
26847 | 1840 abbrev dev development # shorthand |
1841 map <F3> o#include # insert include | |
1842 execute cmd # do it | |
1843 !ls *.c # list C files | |
1844 | |
29066 | 1845 - The abbreviation 'dev' will be expanded to 'development # shorthand'. |
1846 - The mapping of <F3> will actually be the whole line after the 'o# ....' | |
1847 including the '# insert include'. | |
1848 - The `execute` command will give an error. | |
1849 - The `!` command will send everything after it to the shell, most likely | |
1850 causing an error. | |
26847 | 1851 |
1852 There can be no comment after `map`, `abbreviate`, `execute` and `!` commands | |
1853 (there are a few more commands with this restriction). For the `map`, | |
1854 `abbreviate` and `execute` commands there is a trick: > | |
1855 | |
1856 abbrev dev development|# shorthand | |
1857 map <F3> o#include|# insert include | |
1858 execute '!ls *.c' |# do it | |
7 | 1859 |
1860 With the '|' character the command is separated from the next one. And that | |
26847 | 1861 next command is only a comment. The last command, using `execute` is a |
1862 general solution, it works for all commands that do not accept a comment or a | |
1863 '|' to separate the next command. | |
7 | 1864 |
1865 Notice that there is no white space before the '|' in the abbreviation and | |
1866 mapping. For these commands, any character until the end-of-line or '|' is | |
1867 included. As a consequence of this behavior, you don't always see that | |
1868 trailing whitespace is included: > | |
1869 | |
26847 | 1870 map <F4> o#include |
1871 | |
29066 | 1872 Here it is intended, in other cases it might be accidental. To spot these |
1873 problems, you can highlight trailing spaces: > | |
26847 | 1874 match Search /\s\+$/ |
7 | 1875 |
1146 | 1876 For Unix there is one special way to comment a line, that allows making a Vim |
26847 | 1877 script executable, and it also works in legacy script: > |
1146 | 1878 #!/usr/bin/env vim -S |
1879 echo "this is a Vim script" | |
1880 quit | |
1881 | |
29104 | 1882 ============================================================================== |
1883 *41.12* Fileformat | |
1884 | |
1885 The end-of-line character depends on the system. For Vim scripts it is | |
29269 | 1886 recommended to always use the Unix fileformat. Lines are then separated with |
1887 the Newline character. This also works on any other system. That way you can | |
1888 copy your Vim scripts from MS-Windows to Unix and they still work. See | |
1889 |:source_crnl|. To be sure it is set right, do this before writing the file: | |
1890 > | |
1891 :setlocal fileformat=unix | |
29104 | 1892 |
29269 | 1893 When using "dos" fileformat, lines are separated with CR-NL, two characters. |
1894 The CR character causes various problems, better avoid this. | |
29104 | 1895 |
1896 ============================================================================== | |
7 | 1897 |
29066 | 1898 Advance information about writing Vim script is in |usr_50.txt|. |
28933 | 1899 |
7 | 1900 Next chapter: |usr_42.txt| Add new menus |
1901 | |
14519 | 1902 Copyright: see |manual-copyright| vim:tw=78:ts=8:noet:ft=help:norl: |