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