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