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