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