annotate runtime/doc/eval.txt @ 834:5117153003bd v7.0e

updated for version 7.0e
author vimboss
date Sun, 16 Apr 2006 18:30:08 +0000
parents f24a95dae8ee
children 1f3b1021f002
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
834
5117153003bd updated for version 7.0e
vimboss
parents: 831
diff changeset
1 *eval.txt* For Vim version 7.0e. Last change: 2006 Apr 15
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Expression evaluation *expression* *expr* *E15* *eval*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 Note: Expression evaluation can be disabled at compile time. If this has been
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
12 done, the features in this document are not available. See |+eval| and
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
13 |no-eval-feature|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
15 1. Variables |variables|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
16 1.1 Variable types
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
17 1.2 Function references |Funcref|
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
18 1.3 Lists |Lists|
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
19 1.4 Dictionaries |Dictionaries|
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
20 1.5 More about variables |more-variables|
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
21 2. Expression syntax |expression-syntax|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
22 3. Internal variable |internal-variables|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
23 4. Builtin Functions |functions|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
24 5. Defining functions |user-functions|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
25 6. Curly braces names |curly-braces-names|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
26 7. Commands |expression-commands|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
27 8. Exception handling |exception-handling|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
28 9. Examples |eval-examples|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
29 10. No +eval feature |no-eval-feature|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
30 11. The sandbox |eval-sandbox|
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
31 12. Textlock |textlock|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 {Vi does not have any of these commands}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 1. Variables *variables*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
38 1.1 Variable types ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
39 *E712*
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
40 There are five types of variables:
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
41
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
42 Number A 32 bit signed number.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
43 Examples: -123 0x10 0177
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
44
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
45 String A NUL terminated string of 8-bit unsigned characters (bytes).
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
46 Examples: "ab\txx\"--" 'x-z''a,c'
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
47
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
48 Funcref A reference to a function |Funcref|.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
49 Example: function("strlen")
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
50
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
51 List An ordered sequence of items |List|.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
52 Example: [1, 2, ['a', 'b']]
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
53
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
54 Dictionary An associative, unordered array: Each entry has a key and a
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
55 value. |Dictionary|
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
56 Example: {'blue': "#0000ff", 'red': "#ff0000"}
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
57
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
58 The Number and String types are converted automatically, depending on how they
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
59 are used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 Conversion from a Number to a String is by making the ASCII representation of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 the Number. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 Number 123 --> String "123"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 Number 0 --> String "0"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 Number -1 --> String "-1"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 Conversion from a String to a Number is done by converting the first digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 the String doesn't start with digits, the result is zero. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 String "456" --> Number 456
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 String "6bar" --> Number 6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 String "foo" --> Number 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 String "0xf1" --> Number 241
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 String "0100" --> Number 64
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 String "-8" --> Number -8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 String "+8" --> Number 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 To force conversion from String to Number, add zero to it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 :echo "0100" + 0
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
80 < 64 ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
81
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
82 To avoid a leading zero to cause octal conversion, or for using a different
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
83 base, use |str2nr()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 Note that in the command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 :if "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 "foo" is converted to 0, which means FALSE. To test for a non-empty string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 use strlen(): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 :if strlen("foo")
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
92 < *E745* *E728* *E703* *E729* *E730* *E731*
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
93 List, Dictionary and Funcref types are not automatically converted.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
94
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
95 *E706*
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
96 You will get an error if you try to change the type of a variable. You need
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
97 to |:unlet| it first to avoid this error. String and Number are considered
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
98 equivalent though. Consider this sequence of commands: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
99 :let l = "string"
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
100 :let l = 44 " changes type from String to Number
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
101 :let l = [1, 2, 3] " error!
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
102
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
103
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
104 1.2 Function references ~
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
105 *Funcref* *E695* *E718*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
106 A Funcref variable is obtained with the |function()| function. It can be used
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
107 in an expression in the place of a function name, before the parenthesis
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
108 around the arguments, to invoke the function it refers to. Example: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
109
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
110 :let Fn = function("MyFunc")
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
111 :echo Fn()
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
112 < *E704* *E705* *E707*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
113 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
114 cannot have both a Funcref variable and a function with the same name.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
115
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
116 A special case is defining a function and directly assigning its Funcref to a
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
117 Dictionary entry. Example: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
118 :function dict.init() dict
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
119 : let self.val = 0
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
120 :endfunction
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
121
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
122 The key of the Dictionary can start with a lower case letter. The actual
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
123 function name is not used here. Also see |numbered-function|.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
124
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
125 A Funcref can also be used with the |:call| command: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
126 :call Fn()
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
127 :call dict.init()
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
128
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
129 The name of the referenced function can be obtained with |string()|. >
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
130 :let func = string(Fn)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
131
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
132 You can use |call()| to invoke a Funcref and use a list variable for the
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
133 arguments: >
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
134 :let r = call(Fn, mylist)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
135
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
136
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
137 1.3 Lists ~
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
138 *List* *Lists* *E686*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
139 A List is an ordered sequence of items. An item can be of any type. Items
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
140 can be accessed by their index number. Items can be added and removed at any
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
141 position in the sequence.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
142
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
143
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
144 List creation ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
145 *E696* *E697*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
146 A List is created with a comma separated list of items in square brackets.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
147 Examples: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
148 :let mylist = [1, two, 3, "four"]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
149 :let emptylist = []
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
150
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
151 An item can be any expression. Using a List for an item creates a
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
152 nested List: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
153 :let nestlist = [[11, 12], [21, 22], [31, 32]]
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
154
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
155 An extra comma after the last item is ignored.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
156
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
157
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
158 List index ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
159 *list-index* *E684*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
160 An item in the List can be accessed by putting the index in square brackets
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
161 after the List. Indexes are zero-based, thus the first item has index zero. >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
162 :let item = mylist[0] " get the first item: 1
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
163 :let item = mylist[2] " get the third item: 3
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
164
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
165 When the resulting item is a list this can be repeated: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
166 :let item = nestlist[0][1] " get the first list, second item: 12
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
167 <
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
168 A negative index is counted from the end. Index -1 refers to the last item in
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
169 the List, -2 to the last but one item, etc. >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
170 :let last = mylist[-1] " get the last item: "four"
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
171
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
172 To avoid an error for an invalid index use the |get()| function. When an item
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
173 is not available it returns zero or the default value you specify: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
174 :echo get(mylist, idx)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
175 :echo get(mylist, idx, "NONE")
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
176
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
177
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
178 List concatenation ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
179
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
180 Two lists can be concatenated with the "+" operator: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
181 :let longlist = mylist + [5, 6]
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
182 :let mylist += [7, 8]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
183
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
184 To prepend or append an item turn the item into a list by putting [] around
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
185 it. To change a list in-place see |list-modification| below.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
186
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
187
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
188 Sublist ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
189
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
190 A part of the List can be obtained by specifying the first and last index,
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
191 separated by a colon in square brackets: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
192 :let shortlist = mylist[2:-1] " get List [3, "four"]
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
193
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
194 Omitting the first index is similar to zero. Omitting the last index is
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
195 similar to -1. The difference is that there is no error if the items are not
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
196 available. >
90
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
197 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
198 :let shortlist = mylist[2:2] " List with one item: [3]
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
199 :let otherlist = mylist[:] " make a copy of the List
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
200
829
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
201 If the second index is equal to or greater than the length of the list there
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
202 is no error and the length minus one is used: >
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
203 :let mylist = [0, 1, 2, 3]
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
204 :echo mylist[2:8] " result: [2, 3]
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
205
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
206 The second index can be just before the first index. In that case the result
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
207 is an empty list. If the second index is lower, this results in an error. >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
208 :echo mylist[2:1] " result: []
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
209 :echo mylist[2:0] " error!
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
210
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
211 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
212 using a single letter variable before the ":". Insert a space when needed:
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
213 mylist[s : e].
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
214
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
215
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
216 List identity ~
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
217 *list-identity*
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
218 When variable "aa" is a list and you assign it to another variable "bb", both
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
219 variables refer to the same list. Thus changing the list "aa" will also
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
220 change "bb": >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
221 :let aa = [1, 2, 3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
222 :let bb = aa
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
223 :call add(aa, 4)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
224 :echo bb
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
225 < [1, 2, 3, 4]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
226
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
227 Making a copy of a list is done with the |copy()| function. Using [:] also
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
228 works, as explained above. This creates a shallow copy of the list: Changing
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
229 a list item in the list will also change the item in the copied list: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
230 :let aa = [[1, 'a'], 2, 3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
231 :let bb = copy(aa)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
232 :call add(aa, 4)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
233 :let aa[0][1] = 'aaa'
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
234 :echo aa
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
235 < [[1, aaa], 2, 3, 4] >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
236 :echo bb
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
237 < [[1, aaa], 2, 3]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
238
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
239 To make a completely independent list use |deepcopy()|. This also makes a
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
240 copy of the values in the list, recursively. Up to a hundred levels deep.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
241
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
242 The operator "is" can be used to check if two variables refer to the same
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
243 List. "isnot" does the opposite. In contrast "==" compares if two lists have
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
244 the same value. >
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
245 :let alist = [1, 2, 3]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
246 :let blist = [1, 2, 3]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
247 :echo alist is blist
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
248 < 0 >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
249 :echo alist == blist
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
250 < 1
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
251
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
252 Note about comparing lists: Two lists are considered equal if they have the
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
253 same length and all items compare equal, as with using "==". There is one
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
254 exception: When comparing a number with a string they are considered
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
255 different. There is no automatic type conversion, as with using "==" on
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
256 variables. Example: >
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
257 echo 4 == "4"
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
258 < 1 >
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
259 echo [4] == ["4"]
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
260 < 0
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
261
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
262 Thus comparing Lists is more strict than comparing numbers and strings. You
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
263 can compare simple values this way too by putting them in a string: >
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
264
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
265 :let a = 5
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
266 :let b = "5"
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
267 echo a == b
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
268 < 1 >
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
269 echo [a] == [b]
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
270 < 0
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
271
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
272
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
273 List unpack ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
274
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
275 To unpack the items in a list to individual variables, put the variables in
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
276 square brackets, like list items: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
277 :let [var1, var2] = mylist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
278
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
279 When the number of variables does not match the number of items in the list
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
280 this produces an error. To handle any extra items from the list append ";"
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
281 and a variable name: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
282 :let [var1, var2; rest] = mylist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
283
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
284 This works like: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
285 :let var1 = mylist[0]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
286 :let var2 = mylist[1]
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
287 :let rest = mylist[2:]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
288
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
289 Except that there is no error if there are only two items. "rest" will be an
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
290 empty list then.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
291
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
292
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
293 List modification ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
294 *list-modification*
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
295 To change a specific item of a list use |:let| this way: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
296 :let list[4] = "four"
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
297 :let listlist[0][3] = item
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
298
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
299 To change part of a list you can specify the first and last item to be
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
300 modified. The value must at least have the number of items in the range: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
301 :let list[3:5] = [3, 4, 5]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
302
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
303 Adding and removing items from a list is done with functions. Here are a few
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
304 examples: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
305 :call insert(list, 'a') " prepend item 'a'
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
306 :call insert(list, 'a', 3) " insert item 'a' before list[3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
307 :call add(list, "new") " append String item
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
308 :call add(list, [1, 2]) " append a List as one new item
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
309 :call extend(list, [1, 2]) " extend the list with two more items
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
310 :let i = remove(list, 3) " remove item 3
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
311 :unlet list[3] " idem
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
312 :let l = remove(list, 3, -1) " remove items 3 to last item
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
313 :unlet list[3 : ] " idem
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
314 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
315
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
316 Changing the order of items in a list: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
317 :call sort(list) " sort a list alphabetically
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
318 :call reverse(list) " reverse the order of items
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
319
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
320
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
321 For loop ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
322
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
323 The |:for| loop executes commands for each item in a list. A variable is set
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
324 to each item in the list in sequence. Example: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
325 :for item in mylist
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
326 : call Doit(item)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
327 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
328
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
329 This works like: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
330 :let index = 0
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
331 :while index < len(mylist)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
332 : let item = mylist[index]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
333 : :call Doit(item)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
334 : let index = index + 1
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
335 :endwhile
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
336
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
337 Note that all items in the list should be of the same type, otherwise this
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
338 results in error |E706|. To avoid this |:unlet| the variable at the end of
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
339 the loop.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
340
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
341 If all you want to do is modify each item in the list then the |map()|
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
342 function will be a simpler method than a for loop.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
343
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
344 Just like the |:let| command, |:for| also accepts a list of variables. This
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
345 requires the argument to be a list of lists. >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
346 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
347 : call Doit(lnum, col)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
348 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
349
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
350 This works like a |:let| command is done for each list item. Again, the types
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
351 must remain the same to avoid an error.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
352
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
353 It is also possible to put remaining items in a List variable: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
354 :for [i, j; rest] in listlist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
355 : call Doit(i, j)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
356 : if !empty(rest)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
357 : echo "remainder: " . string(rest)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
358 : endif
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
359 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
360
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
361
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
362 List functions ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
363 *E714*
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
364 Functions that are useful with a List: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
365 :let r = call(funcname, list) " call a function with an argument list
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
366 :if empty(list) " check if list is empty
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
367 :let l = len(list) " number of items in list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
368 :let big = max(list) " maximum value in list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
369 :let small = min(list) " minimum value in list
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
370 :let xs = count(list, 'x') " count nr of times 'x' appears in list
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
371 :let i = index(list, 'x') " index of first 'x' in list
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
372 :let lines = getline(1, 10) " get ten text lines from buffer
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
373 :call append('$', lines) " append text lines in buffer
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
374 :let list = split("a b c") " create list from items in a string
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
375 :let string = join(list, ', ') " create string from list items
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
376 :let s = string(list) " String representation of list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
377 :call map(list, '">> " . v:val') " prepend ">> " to each item
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
378
258
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
379 Don't forget that a combination of features can make things simple. For
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
380 example, to add up all the numbers in a list: >
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
381 :exe 'let sum = ' . join(nrlist, '+')
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
382
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
383
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
384 1.4 Dictionaries ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
385 *Dictionaries* *Dictionary*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
386 A Dictionary is an associative array: Each entry has a key and a value. The
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
387 entry can be located with the key. The entries are stored without a specific
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
388 ordering.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
389
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
390
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
391 Dictionary creation ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
392 *E720* *E721* *E722* *E723*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
393 A Dictionary is created with a comma separated list of entries in curly
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
394 braces. Each entry has a key and a value, separated by a colon. Each key can
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
395 only appear once. Examples: >
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
396 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
397 :let emptydict = {}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
398 < *E713* *E716* *E717*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
399 A key is always a String. You can use a Number, it will be converted to a
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
400 String automatically. Thus the String '4' and the number 4 will find the same
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
401 entry. Note that the String '04' and the Number 04 are different, since the
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
402 Number will be converted to the String '4'.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
403
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
404 A value can be any expression. Using a Dictionary for a value creates a
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
405 nested Dictionary: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
406 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
407
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
408 An extra comma after the last entry is ignored.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
409
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
410
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
411 Accessing entries ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
412
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
413 The normal way to access an entry is by putting the key in square brackets: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
414 :let val = mydict["one"]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
415 :let mydict["four"] = 4
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
416
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
417 You can add new entries to an existing Dictionary this way, unlike Lists.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
418
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
419 For keys that consist entirely of letters, digits and underscore the following
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
420 form can be used |expr-entry|: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
421 :let val = mydict.one
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
422 :let mydict.four = 4
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
423
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
424 Since an entry can be any type, also a List and a Dictionary, the indexing and
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
425 key lookup can be repeated: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
426 :echo dict.key[idx].key
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
427
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
428
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
429 Dictionary to List conversion ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
430
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
431 You may want to loop over the entries in a dictionary. For this you need to
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
432 turn the Dictionary into a List and pass it to |:for|.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
433
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
434 Most often you want to loop over the keys, using the |keys()| function: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
435 :for key in keys(mydict)
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
436 : echo key . ': ' . mydict[key]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
437 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
438
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
439 The List of keys is unsorted. You may want to sort them first: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
440 :for key in sort(keys(mydict))
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
441
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
442 To loop over the values use the |values()| function: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
443 :for v in values(mydict)
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
444 : echo "value: " . v
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
445 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
446
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
447 If you want both the key and the value use the |items()| function. It returns
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
448 a List in which each item is a List with two items, the key and the value: >
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
449 :for entry in items(mydict)
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
450 : echo entry[0] . ': ' . entry[1]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
451 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
452
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
453
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
454 Dictionary identity ~
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
455 *dict-identity*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
456 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
457 Dictionary. Otherwise, assignment results in referring to the same
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
458 Dictionary: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
459 :let onedict = {'a': 1, 'b': 2}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
460 :let adict = onedict
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
461 :let adict['a'] = 11
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
462 :echo onedict['a']
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
463 11
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
464
327
8f38b35904c0 updated for version 7.0085
vimboss
parents: 323
diff changeset
465 Two Dictionaries compare equal if all the key-value pairs compare equal. For
8f38b35904c0 updated for version 7.0085
vimboss
parents: 323
diff changeset
466 more info see |list-identity|.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
467
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
468
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
469 Dictionary modification ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
470 *dict-modification*
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
471 To change an already existing entry of a Dictionary, or to add a new entry,
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
472 use |:let| this way: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
473 :let dict[4] = "four"
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
474 :let dict['one'] = item
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
475
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
476 Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
477 Three ways to remove the entry with key "aaa" from dict: >
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
478 :let i = remove(dict, 'aaa')
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
479 :unlet dict.aaa
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
480 :unlet dict['aaa']
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
481
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
482 Merging a Dictionary with another is done with |extend()|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
483 :call extend(adict, bdict)
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
484 This extends adict with all entries from bdict. Duplicate keys cause entries
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
485 in adict to be overwritten. An optional third argument can change this.
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
486 Note that the order of entries in a Dictionary is irrelevant, thus don't
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
487 expect ":echo adict" to show the items from bdict after the older entries in
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
488 adict.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
489
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
490 Weeding out entries from a Dictionary can be done with |filter()|: >
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
491 :call filter(dict 'v:val =~ "x"')
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
492 This removes all entries from "dict" with a value not matching 'x'.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
493
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
494
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
495 Dictionary function ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
496 *Dictionary-function* *self* *E725*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
497 When a function is defined with the "dict" attribute it can be used in a
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
498 special way with a dictionary. Example: >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
499 :function Mylen() dict
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
500 : return len(self.data)
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
501 :endfunction
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
502 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
503 :echo mydict.len()
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
504
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
505 This is like a method in object oriented programming. The entry in the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
506 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
507 the function was invoked from.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
508
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
509 It is also possible to add a function without the "dict" attribute as a
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
510 Funcref to a Dictionary, but the "self" variable is not available then.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
511
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
512 *numbered-function* *anonymous-function*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
513 To avoid the extra name for the function it can be defined and directly
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
514 assigned to a Dictionary in this way: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
515 :let mydict = {'data': [0, 1, 2, 3]}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
516 :function mydict.len() dict
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
517 : return len(self.data)
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
518 :endfunction
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
519 :echo mydict.len()
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
520
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
521 The function will then get a number and the value of dict.len is a |Funcref|
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
522 that references this function. The function can only be used through a
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
523 |Funcref|. It will automatically be deleted when there is no |Funcref|
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
524 remaining that refers to it.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
525
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
526 It is not necessary to use the "dict" attribute for a numbered function.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
527
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
528
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
529 Functions for Dictionaries ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
530 *E715*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
531 Functions that can be used with a Dictionary: >
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
532 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
533 :if empty(dict) " TRUE if dict is empty
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
534 :let l = len(dict) " number of items in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
535 :let big = max(dict) " maximum value in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
536 :let small = min(dict) " minimum value in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
537 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
538 :let s = string(dict) " String representation of dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
539 :call map(dict, '">> " . v:val') " prepend ">> " to each item
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
540
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
541
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
542 1.5 More about variables ~
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
543 *more-variables*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544 If you need to know the type of a variable or expression, use the |type()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
546
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
547 When the '!' flag is included in the 'viminfo' option, global variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 start with an uppercase letter, and don't contain a lowercase letter, are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549 stored in the viminfo file |viminfo-file|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 When the 'sessionoptions' option contains "global", global variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552 start with an uppercase letter and contain at least one lowercase letter are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 stored in the session file |session-file|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555 variable name can be stored where ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 my_var_6 not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
557 My_Var_6 session file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
558 MY_VAR_6 viminfo file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
559
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
560
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 It's possible to form a variable name with curly braces, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 |curly-braces-names|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565 2. Expression syntax *expression-syntax*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
567 Expression syntax summary, from least to most significant:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
569 |expr1| expr2 ? expr1 : expr1 if-then-else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
570
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
571 |expr2| expr3 || expr3 .. logical OR
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
572
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573 |expr3| expr4 && expr4 .. logical AND
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
574
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575 |expr4| expr5 == expr5 equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 expr5 != expr5 not equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
577 expr5 > expr5 greater than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
578 expr5 >= expr5 greater than or equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 expr5 < expr5 smaller than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 expr5 <= expr5 smaller than or equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581 expr5 =~ expr5 regexp matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 expr5 !~ expr5 regexp doesn't match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
584 expr5 ==? expr5 equal, ignoring case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
585 expr5 ==# expr5 equal, match case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
586 etc. As above, append ? for ignoring case, # for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587 matching case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
589 expr5 is expr5 same |List| instance
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
590 expr5 isnot expr5 different |List| instance
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
591
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
592 |expr5| expr6 + expr6 .. number addition or list concatenation
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593 expr6 - expr6 .. number subtraction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594 expr6 . expr6 .. string concatenation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
595
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 |expr6| expr7 * expr7 .. number multiplication
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
597 expr7 / expr7 .. number division
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
598 expr7 % expr7 .. number modulo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
599
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
600 |expr7| ! expr7 logical NOT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
601 - expr7 unary minus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
602 + expr7 unary plus
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
603
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
604
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
605 |expr8| expr8[expr1] byte of a String or item of a |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
606 expr8[expr1 : expr1] substring of a String or sublist of a |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
607 expr8.name entry in a |Dictionary|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
608 expr8(expr1, ...) function call with |Funcref| variable
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
609
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
610 |expr9| number number constant
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
611 "string" string constant, backslash is special
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
612 'string' string constant, ' is doubled
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
613 [expr1, ...] |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
614 {expr1: expr1, ...} |Dictionary|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615 &option option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617 variable internal variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
618 va{ria}ble internal variable with curly braces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
619 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622 func{ti}on(expr1, ...) function call with curly braces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
625 ".." indicates that the operations in this level can be concatenated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627 &nu || &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
628
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
629 All expressions within one level are parsed from left to right.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
630
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
631
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
632 expr1 *expr1* *E109*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
633 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
634
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635 expr2 ? expr1 : expr1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
636
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
637 The expression before the '?' is evaluated to a number. If it evaluates to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
638 non-zero, the result is the value of the expression between the '?' and ':',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
639 otherwise the result is the value of the expression after the ':'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
640 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
641 :echo lnum == 1 ? "top" : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
642
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
643 Since the first expression is an "expr2", it cannot contain another ?:. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
644 other two expressions can, thus allow for recursive use of ?:.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
645 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
646 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
647
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
648 To keep this readable, using |line-continuation| is suggested: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
649 :echo lnum == 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650 :\ ? "top"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 :\ : lnum == 1000
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652 :\ ? "last"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653 :\ : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
656 expr2 and expr3 *expr2* *expr3*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
657 ---------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
658
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 *expr-barbar* *expr-&&*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 The "||" and "&&" operators take one argument on each side. The arguments
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661 are (converted to) Numbers. The result is:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
662
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663 input output ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664 n1 n2 n1 || n2 n1 && n2 ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665 zero zero zero zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666 zero non-zero non-zero zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
667 non-zero zero non-zero zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668 non-zero non-zero non-zero non-zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670 The operators can be concatenated, for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672 &nu || &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
674 Note that "&&" takes precedence over "||", so this has the meaning of: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
675
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
676 &nu || (&list && &shell == "csh")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
678 Once the result is known, the expression "short-circuits", that is, further
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
679 arguments are not evaluated. This is like what happens in C. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
680
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
681 let a = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
682 echo a || b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
683
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
684 This is valid even if there is no variable called "b" because "a" is non-zero,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
685 so the result must be non-zero. Similarly below: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
686
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
687 echo exists("b") && b == "yes"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
688
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
689 This is valid whether "b" has been defined or not. The second clause will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
690 only be evaluated if "b" has been defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
691
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
692
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
693 expr4 *expr4*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 expr5 {cmp} expr5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
697
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699 if it evaluates to true.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
700
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701 *expr-==* *expr-!=* *expr->* *expr->=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702 *expr-<* *expr-<=* *expr-=~* *expr-!~*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
704 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
706 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
707 *expr-is*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
708 use 'ignorecase' match case ignore case ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
709 equal == ==# ==?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
710 not equal != !=# !=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
711 greater than > ># >?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
712 greater than or equal >= >=# >=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
713 smaller than < <# <?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
714 smaller than or equal <= <=# <=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
715 regexp matches =~ =~# =~?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
716 regexp doesn't match !~ !~# !~?
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
717 same instance is
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
718 different instance isnot
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
719
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 "abc" ==# "Abc" evaluates to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722 "abc" ==? "Abc" evaluates to 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
724
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
725 *E691* *E692*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
726 A |List| can only be compared with a |List| and only "equal", "not equal" and
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
727 "is" can be used. This compares the values of the list, recursively.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
728 Ignoring case means case is ignored when comparing item values.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
729
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
730 *E735* *E736*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
731 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
732 equal" and "is" can be used. This compares the key/values of the |Dictionary|
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
733 recursively. Ignoring case means case is ignored when comparing item values.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
734
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
735 *E693* *E694*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
736 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
737 equal" can be used. Case is never ignored.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
738
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
739 When using "is" or "isnot" with a |List| this checks if the expressions are
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
740 referring to the same |List| instance. A copy of a |List| is different from
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
741 the original |List|. When using "is" without a |List| it is equivalent to
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
742 using "equal", using "isnot" equivalent to using "not equal". Except that a
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
743 different type means the values are different. "4 == '4'" is true, "4 is '4'"
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
744 is false.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
745
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746 When comparing a String with a Number, the String is converted to a Number,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 because 'x' converted to a Number is zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750 When comparing two Strings, this is done with strcmp() or stricmp(). This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 results in the mathematical difference (comparing byte values), not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752 necessarily the alphabetical difference in the local language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
753
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754 When using the operators with a trailing '#", or the short version and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755 'ignorecase' is off, the comparing is done with strcmp().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 When using the operators with a trailing '?', or the short version and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 'ignorecase' is set, the comparing is done with stricmp().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 The "=~" and "!~" operators match the lefthand argument with the righthand
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
761 argument, which is used as a pattern. See |pattern| for what a pattern is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
762 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 portable. To avoid backslashes in the regexp pattern to be doubled, use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 single-quote string, see |literal-string|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766 Since a string is considered to be a single line, a multi-line pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 (containing \n, backslash-n) will not match. However, a literal NL character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768 can be matched like an ordinary character. Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
769 "foo\nbar" =~ "\n" evaluates to 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
770 "foo\nbar" =~ "\\n" evaluates to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
771
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
772
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
773 expr5 and expr6 *expr5* *expr6*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
774 ---------------
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
775 expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
776 expr6 - expr6 .. Number subtraction *expr--*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
777 expr6 . expr6 .. String concatenation *expr-.*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
778
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
779 For |Lists| only "+" is possible and then both expr6 must be a list. The
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
780 result is a new list with the two lists Concatenated.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
781
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
782 expr7 * expr7 .. number multiplication *expr-star*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
783 expr7 / expr7 .. number division *expr-/*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
784 expr7 % expr7 .. number modulo *expr-%*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786 For all, except ".", Strings are converted to Numbers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 Note the difference between "+" and ".":
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789 "123" + "456" = 579
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 "123" . "456" = "123456"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792 When the righthand side of '/' is zero, the result is 0x7fffffff.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
793 When the righthand side of '%' is zero, the result is 0.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
794
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
795 None of these work for |Funcref|s.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
796
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
797
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798 expr7 *expr7*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
799 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800 ! expr7 logical NOT *expr-!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801 - expr7 unary minus *expr-unary--*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
802 + expr7 unary plus *expr-unary-+*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
803
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
804 For '!' non-zero becomes zero, zero becomes one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805 For '-' the sign of the number is changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
806 For '+' the number is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
807
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
808 A String will be converted to a Number first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
809
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 These three can be repeated and mixed. Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811 !-1 == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812 !!8 == 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
813 --9 == 9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
814
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
815
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
816 expr8 *expr8*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
817 -----
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
818 expr8[expr1] item of String or |List| *expr-[]* *E111*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
819
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
820 If expr8 is a Number or String this results in a String that contains the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
821 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
822 Number. Note that this doesn't recognize multi-byte encodings.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
823
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
824 Index zero gives the first character. This is like it works in C. Careful:
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
825 text column numbers start with one! Example, to get the character under the
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
826 cursor: >
823
9ab23f1e137f updated for version 7.0c12
vimboss
parents: 819
diff changeset
827 :let c = getline(".")[col(".") - 1]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829 If the length of the String is less than the index, the result is an empty
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
830 String. A negative index always results in an empty string (reason: backwards
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
831 compatibility). Use [-1:] to get the last byte.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
832
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
833 If expr8 is a |List| then it results the item at index expr1. See |list-index|
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
834 for possible index values. If the index is out of range this results in an
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
835 error. Example: >
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
836 :let item = mylist[-1] " get last item
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
837
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
838 Generally, if a |List| index is equal to or higher than the length of the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
839 |List|, or more negative than the length of the |List|, this results in an
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
840 error.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
841
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
842
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
843 expr8[expr1a : expr1b] substring or sublist *expr-[:]*
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
844
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
845 If expr8 is a Number or String this results in the substring with the bytes
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
846 from expr1a to and including expr1b. expr8 is used as a String, expr1a and
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
847 expr1b are used as a Number. Note that this doesn't recognize multi-byte
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
848 encodings.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
849
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
850 If expr1a is omitted zero is used. If expr1b is omitted the length of the
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
851 string minus one is used.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
852
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
853 A negative number can be used to measure from the end of the string. -1 is
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
854 the last character, -2 the last but one, etc.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
855
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
856 If an index goes out of range for the string characters are omitted. If
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
857 expr1b is smaller than expr1a the result is an empty string.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
858
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
859 Examples: >
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
860 :let c = name[-1:] " last byte of a string
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
861 :let c = name[-2:-2] " last but one byte of a string
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
862 :let s = line(".")[4:] " from the fifth byte to the end
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
863 :let s = s[:-3] " remove last two bytes
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
864
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
865 If expr8 is a |List| this results in a new |List| with the items indicated by
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
866 the indexes expr1a and expr1b. This works like with a String, as explained
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
867 just above, except that indexes out of range cause an error. Examples: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
868 :let l = mylist[:3] " first four items
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
869 :let l = mylist[4:4] " List with one item
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
870 :let l = mylist[:] " shallow copy of a List
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
871
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
872 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
873 error.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
874
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
875
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
876 expr8.name entry in a |Dictionary| *expr-entry*
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
877
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
878 If expr8 is a |Dictionary| and it is followed by a dot, then the following
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
879 name will be used as a key in the |Dictionary|. This is just like:
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
880 expr8[name].
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
881
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
882 The name must consist of alphanumeric characters, just like a variable name,
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
883 but it may start with a number. Curly braces cannot be used.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
884
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
885 There must not be white space before or after the dot.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
886
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
887 Examples: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
888 :let dict = {"one": 1, 2: "two"}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
889 :echo dict.one
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
890 :echo dict .2
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
891
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
892 Note that the dot is also used for String concatenation. To avoid confusion
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
893 always put spaces around the dot for String concatenation.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
894
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
895
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
896 expr8(expr1, ...) |Funcref| function call
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
897
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
898 When expr8 is a |Funcref| type variable, invoke the function it refers to.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
899
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
900
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
901
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
902 *expr9*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904 ------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905 number number constant *expr-number*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910 string *expr-string* *E114*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911 ------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912 "string" string constant *expr-quote*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914 Note that double quotes are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916 A string constant accepts these special characters:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 \... three-digit octal number (e.g., "\316")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918 \.. two-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919 \. one-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
920 \x.. byte specified with two hex numbers (e.g., "\x1f")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
921 \x. byte specified with one hex number (must be followed by non-hex char)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922 \X.. same as \x..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 \X. same as \x.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924 \u.... character specified with up to 4 hex numbers, stored according to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 current value of 'encoding' (e.g., "\u02a4")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
926 \U.... same as \u....
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
927 \b backspace <BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928 \e escape <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929 \f formfeed <FF>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
930 \n newline <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
931 \r return <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
932 \t tab <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933 \\ backslash
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934 \" double quote
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 Note that "\000" and "\x00" force the end of the string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
939
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940 literal-string *literal-string* *E115*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 ---------------
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
942 'string' string constant *expr-'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
944 Note that single quotes are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
945
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
946 This string is taken as it is. No backslashes are removed or have a special
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
947 meaning. The only exception is that two quotes stand for one quote.
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
948
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
949 Single quoted strings are useful for patterns, so that backslashes do not need
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
950 to be doubled. These two commands are equivalent: >
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
951 if a =~ "\\s*"
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
952 if a =~ '\s*'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
953
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
954
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
955 option *expr-option* *E112* *E113*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
956 ------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
957 &option option value, local value if possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
958 &g:option global option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 &l:option local option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
962 echo "tabstop is " . &tabstop
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
963 if &insertmode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
965 Any option name can be used here. See |options|. When using the local value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
966 and there is no buffer-local or window-local value, the global value is used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
967 anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
968
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
970 register *expr-register*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
971 --------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
972 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974 The result is the contents of the named register, as a single string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 Newlines are inserted where required. To get the contents of the unnamed
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
976 register use @" or @@. See |registers| for an explanation of the available
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
977 registers.
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
978
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
979 When using the '=' register you get the expression itself, not what it
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
980 evaluates to. Use |eval()| to evaluate it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
981
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
982
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
983 nesting *expr-nesting* *E110*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984 -------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
988 environment variable *expr-env*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 --------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
990 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992 The String value of any environment variable. When it is not defined, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
993 result is an empty string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
994 *expr-env-expand*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995 Note that there is a difference between using $VAR directly and using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 expand("$VAR"). Using it directly will only expand environment variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 are known inside the current Vim session. Using expand() will first try using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 the environment variables known inside the current Vim session. If that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 fails, a shell will be used to expand the variable. This can be slow, but it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000 does expand all variables that the shell knows about. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001 :echo $version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1002 :echo expand("$version")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1003 The first one probably doesn't echo anything, the second echoes the $version
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1004 variable (if your shell supports it).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1007 internal variable *expr-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008 -----------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009 variable internal variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010 See below |internal-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1012
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1013 function call *expr-function* *E116* *E118* *E119* *E120*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1014 -------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1016 See below |functions|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1018
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1019 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1020 3. Internal variable *internal-variables* *E121*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1021 *E461*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022 An internal variable name can be made up of letters, digits and '_'. But it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 cannot start with a digit. It's also possible to use curly braces, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1024 |curly-braces-names|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1025
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1026 An internal variable is created with the ":let" command |:let|.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1027 An internal variable is explicitly destroyed with the ":unlet" command
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1028 |:unlet|.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1029 Using a name that is not an internal variable or refers to a variable that has
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1030 been destroyed results in an error.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1031
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1032 There are several name spaces for variables. Which one is to be used is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1033 specified by what is prepended:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1034
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1035 (nothing) In a function: local to a function; otherwise: global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1036 |buffer-variable| b: Local to the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1037 |window-variable| w: Local to the current window.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1038 |tabpage-variable| t: Local to the current tab page.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1039 |global-variable| g: Global.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 |local-variable| l: Local to a function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041 |script-variable| s: Local to a |:source|'ed Vim script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 |function-argument| a: Function argument (only inside a function).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 |vim-variable| v: Global, predefined by Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1045 The scope name by itself can be used as a |Dictionary|. For example, to
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1046 delete all script-local variables: >
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1047 :for k in keys(s:)
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1048 : unlet s:[k]
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1049 :endfor
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1050 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051 *buffer-variable* *b:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 A variable name that is preceded with "b:" is local to the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 Thus you can have several "b:foo" variables, one for each buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054 This kind of variable is deleted when the buffer is wiped out or deleted with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 |:bdelete|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 One local buffer variable is predefined:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058 *b:changedtick-variable* *changetick*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 b:changedtick The total number of changes to the current buffer. It is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060 incremented for each change. An undo command is also a change
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 in this case. This can be used to perform an action only when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 the buffer has changed. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 :if my_changedtick != b:changedtick
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 : let my_changedtick = b:changedtick
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065 : call My_Update()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1066 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 *window-variable* *w:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069 A variable name that is preceded with "w:" is local to the current window. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070 is deleted when the window is closed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1072 *tabpage-variable* *t:var*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1073 A variable name that is preceded with "t:" is local to the current tab page,
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1074 It is deleted when the tab page is closed. {not available when compiled
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1075 without the +windows feature}
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1076
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077 *global-variable* *g:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 Inside functions global variables are accessed with "g:". Omitting this will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079 access a variable local to a function. But "g:" can also be used in any other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1080 place if you like.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1081
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1082 *local-variable* *l:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1083 Inside functions local variables are accessed without prepending anything.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1084 But you can also prepend "l:" if you like.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1085
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1086 *script-variable* *s:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1087 In a Vim script variables starting with "s:" can be used. They cannot be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1088 accessed from outside of the scripts, thus are local to the script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1089
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1090 They can be used in:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1091 - commands executed while the script is sourced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1092 - functions defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1093 - autocommands defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1094 - functions and autocommands defined in functions and autocommands which were
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095 defined in the script (recursively)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096 - user defined commands defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1097 Thus not in:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098 - other scripts sourced from this one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 - mappings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100 - etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102 script variables can be used to avoid conflicts with global variable names.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1103 Take this example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1105 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1106 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1107 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1108 echo s:counter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1109 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1110 command Tick call MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1111
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1112 You can now invoke "Tick" from any script, and the "s:counter" variable in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1113 that script will not be changed, only the "s:counter" in the script where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1114 "Tick" was defined is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1115
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1116 Another example that does the same: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1118 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1119 command Tick let s:counter = s:counter + 1 | echo s:counter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1120
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1121 When calling a function and invoking a user-defined command, the context for
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1122 script variables is set to the script where the function or command was
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1123 defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1124
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1125 The script variables are also available when a function is defined inside a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1126 function that is defined in a script. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1128 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1129 function StartCounting(incr)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1130 if a:incr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1131 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1132 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1133 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1134 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1135 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1136 let s:counter = s:counter - 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1137 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1138 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1139 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1140
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1141 This defines the MyCounter() function either for counting up or counting down
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1142 when calling StartCounting(). It doesn't matter from where StartCounting() is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1143 called, the s:counter variable will be accessible in MyCounter().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1144
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1145 When the same script is sourced again it will use the same script variables.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1146 They will remain valid as long as Vim is running. This can be used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1147 maintain a counter: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1148
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1149 if !exists("s:counter")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1150 let s:counter = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1151 echo "script executed for the first time"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1152 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1153 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1154 echo "script executed " . s:counter . " times now"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1155 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1156
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1157 Note that this means that filetype plugins don't get a different set of script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1158 variables for each buffer. Use local buffer variables instead |b:var|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1160
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1161 Predefined Vim variables: *vim-variable* *v:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1162
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1163 *v:beval_col* *beval_col-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1164 v:beval_col The number of the column, over which the mouse pointer is.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1165 This is the byte index in the |v:beval_lnum| line.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1166 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1167
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1168 *v:beval_bufnr* *beval_bufnr-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1169 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1170 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1171
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1172 *v:beval_lnum* *beval_lnum-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1173 v:beval_lnum The number of the line, over which the mouse pointer is. Only
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1174 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1175
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1176 *v:beval_text* *beval_text-variable*
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1177 v:beval_text The text under or after the mouse pointer. Usually a word as
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1178 it is useful for debugging a C program. 'iskeyword' applies,
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1179 but a dot and "->" before the position is included. When on a
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1180 ']' the text before it is used, including the matching '[' and
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1181 word before it. When on a Visual area within one line the
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1182 highlighted text is used.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1183 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1184
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1185 *v:beval_winnr* *beval_winnr-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1186 v:beval_winnr The number of the window, over which the mouse pointer is. Only
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1187 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1188
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1189 *v:charconvert_from* *charconvert_from-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1190 v:charconvert_from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1191 The name of the character encoding of a file to be converted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1192 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1193
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1194 *v:charconvert_to* *charconvert_to-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1195 v:charconvert_to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1196 The name of the character encoding of a file after conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1197 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1198
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1199 *v:cmdarg* *cmdarg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1200 v:cmdarg This variable is used for two purposes:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1201 1. The extra arguments given to a file read/write command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1202 Currently these are "++enc=" and "++ff=". This variable is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1203 set before an autocommand event for a file read/write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1204 command is triggered. There is a leading space to make it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1205 possible to append this variable directly after the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1206 read/write command. Note: The "+cmd" argument isn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1207 included here, because it will be executed anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1208 2. When printing a PostScript file with ":hardcopy" this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1209 the argument for the ":hardcopy" command. This can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1210 in 'printexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1211
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1212 *v:cmdbang* *cmdbang-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1213 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1214 was used the value is 1, otherwise it is 0. Note that this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1215 can only be used in autocommands. For user commands |<bang>|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1216 can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1217
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1218 *v:count* *count-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1219 v:count The count given for the last Normal mode command. Can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1220 to get the count before a mapping. Read-only. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1221 :map _x :<C-U>echo "the count is " . v:count<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1222 < Note: The <C-U> is required to remove the line range that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1223 get when typing ':' after a count.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
1224 Also used for evaluating the 'formatexpr' option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1225 "count" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1226
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1227 *v:count1* *count1-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1228 v:count1 Just like "v:count", but defaults to one when no count is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1229 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1230
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1231 *v:ctype* *ctype-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1232 v:ctype The current locale setting for characters of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1233 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1234 current locale encoding. Technical: it's the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1235 LC_CTYPE. When not using a locale the value is "C".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1236 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1237 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1238 See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1239
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1240 *v:dying* *dying-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1241 v:dying Normally zero. When a deadly signal is caught it's set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1242 one. When multiple signals are caught the number increases.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1243 Can be used in an autocommand to check if Vim didn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1244 terminate normally. {only works on Unix}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1245 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1246 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1247 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1248 *v:errmsg* *errmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1249 v:errmsg Last given error message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1250 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1251 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1252 :silent! next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1253 :if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1254 : ... handle error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1255 < "errmsg" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1256
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1257 *v:exception* *exception-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1258 v:exception The value of the exception most recently caught and not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1259 finished. See also |v:throwpoint| and |throw-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1260 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1261 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1262 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1263 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1264 : echo "caught" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1265 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1266 < Output: "caught oops".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1267
179
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1268 *v:fcs_reason* *fcs_reason-variable*
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1269 v:fcs_reason The reason why the |FileChangedShell| event was triggered.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1270 Can be used in an autocommand to decide what to do and/or what
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1271 to set v:fcs_choice to. Possible values:
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1272 deleted file no longer exists
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1273 conflict file contents, mode or timestamp was
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1274 changed and buffer is modified
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1275 changed file contents has changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1276 mode mode of file changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1277 time only file timestamp changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1278
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1279 *v:fcs_choice* *fcs_choice-variable*
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1280 v:fcs_choice What should happen after a |FileChangedShell| event was
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1281 triggered. Can be used in an autocommand to tell Vim what to
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1282 do with the affected buffer:
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1283 reload Reload the buffer (does not work if
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1284 the file was deleted).
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1285 ask Ask the user what to do, as if there
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1286 was no autocommand. Except that when
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1287 only the timestamp changed nothing
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1288 will happen.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1289 <empty> Nothing, the autocommand should do
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1290 everything that needs to be done.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1291 The default is empty. If another (invalid) value is used then
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1292 Vim behaves like it is empty, there is no warning message.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1293
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1294 *v:fname_in* *fname_in-variable*
579
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1295 v:fname_in The name of the input file. Valid while evaluating:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1296 option used for ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1297 'charconvert' file to be converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1298 'diffexpr' original file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1299 'patchexpr' original file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1300 'printexpr' file to be printed
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
1301 And set to the swap file name for |SwapExists|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1302
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1303 *v:fname_out* *fname_out-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1304 v:fname_out The name of the output file. Only valid while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1305 evaluating:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1306 option used for ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1307 'charconvert' resulting converted file (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1308 'diffexpr' output of diff
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1309 'patchexpr' resulting patched file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1310 (*) When doing conversion for a write command (e.g., ":w
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1311 file") it will be equal to v:fname_in. When doing conversion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1312 for a read command (e.g., ":e file") it will be a temporary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1313 file and different from v:fname_in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1314
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1315 *v:fname_new* *fname_new-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1316 v:fname_new The name of the new version of the file. Only valid while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1317 evaluating 'diffexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1318
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1319 *v:fname_diff* *fname_diff-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1320 v:fname_diff The name of the diff (patch) file. Only valid while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1321 evaluating 'patchexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1322
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1323 *v:folddashes* *folddashes-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1324 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1325 fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1326 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1327
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1328 *v:foldlevel* *foldlevel-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1329 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1330 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1331
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1332 *v:foldend* *foldend-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1333 v:foldend Used for 'foldtext': last line of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1334 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1335
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1336 *v:foldstart* *foldstart-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1337 v:foldstart Used for 'foldtext': first line of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1338 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1339
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1340 *v:insertmode* *insertmode-variable*
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1341 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1342 events. Values:
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1343 i Insert mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1344 r Replace mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1345 v Virtual Replace mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1346
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1347 *v:key* *key-variable*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1348 v:key Key of the current item of a |Dictionary|. Only valid while
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1349 evaluating the expression used with |map()| and |filter()|.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1350 Read-only.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1351
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1352 *v:lang* *lang-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1353 v:lang The current locale setting for messages of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1354 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1355 current language. Technical: it's the value of LC_MESSAGES.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1356 The value is system dependent.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1357 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1358 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1359 It can be different from |v:ctype| when messages are desired
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1360 in a different language than what is used for character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1361 encoding. See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1363 *v:lc_time* *lc_time-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1364 v:lc_time The current locale setting for time messages of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1365 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1366 current language. Technical: it's the value of LC_TIME.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1367 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1368 command. See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1369
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1370 *v:lnum* *lnum-variable*
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1371 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr'
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
1372 expressions, tab page number for 'guitablabel'. Only valid
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
1373 while one of these expressions is being evaluated. Read-only
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
1374 when in the |sandbox|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1375
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1376 *v:prevcount* *prevcount-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1377 v:prevcount The count given for the last but one Normal mode command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1378 This is the v:count value of the previous command. Useful if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1379 you want to cancel Visual mode and then use the count. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1380 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1381 < Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1382
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1383 *v:profiling* *profiling-variable*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1384 v:profiling Normally zero. Set to one after using ":profile start".
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1385 See |profiling|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1386
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1387 *v:progname* *progname-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1388 v:progname Contains the name (with path removed) with which Vim was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1389 invoked. Allows you to do special initialisations for "view",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1390 "evim" etc., or any other name you might symlink to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1391 Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1392
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1393 *v:register* *register-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1394 v:register The name of the register supplied to the last normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1395 command. Empty if none were supplied. |getreg()| |setreg()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1396
540
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1397 *v:scrollstart* *scrollstart-variable*
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1398 v:scrollstart String describing the script or function that caused the
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1399 screen to scroll up. It's only set when it is empty, thus the
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1400 first reason is remembered. It is set to "Unknown" for a
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1401 typed command.
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1402 This can be used to find out why your script causes the
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1403 hit-enter prompt.
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1404
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1405 *v:servername* *servername-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1406 v:servername The resulting registered |x11-clientserver| name if any.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1407 Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1408
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1409 *v:shell_error* *shell_error-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1410 v:shell_error Result of the last shell command. When non-zero, the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1411 shell command had an error. When zero, there was no problem.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1412 This only works when the shell returns the error code to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1413 The value -1 is often used when the command could not be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1414 executed. Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1415 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1416 :!mv foo bar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1417 :if v:shell_error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1418 : echo 'could not rename "foo" to "bar"!'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1419 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1420 < "shell_error" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1421
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1422 *v:statusmsg* *statusmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1423 v:statusmsg Last given status message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1424
579
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1425 *v:swapname* *swapname-variable*
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1426 v:swapname Only valid when executing |SwapExists| autocommands: Name of
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1427 the swap file found. Read-only.
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1428
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1429 *v:swapchoice* *swapchoice-variable*
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1430 v:swapchoice |SwapExists| autocommands can set this to the selected choice
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1431 for handling an existing swap file:
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1432 'o' Open read-only
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1433 'e' Edit anyway
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1434 'r' Recover
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1435 'd' Delete swapfile
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1436 'q' Quit
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1437 'a' Abort
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1438 The value should be a single-character string. An empty value
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1439 results in the user being asked, as would happen when there is
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1440 no SwapExists autocommand. The default is empty.
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1441
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
1442 *v:swapcommand* *swapcommand-variable*
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
1443 v:swapcommand Normal mode command to be executed after a file has been
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
1444 opened. Can be used for a |SwapExists| autocommand to have
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
1445 another Vim open the file and jump to the right place. For
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
1446 example, when jumping to a tag the value is ":tag tagname\r".
716
8ae24f338cab updated for version 7.0217
vimboss
parents: 714
diff changeset
1447 For ":edit +cmd file" the value is ":cmd\r".
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
1448
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1449 *v:termresponse* *termresponse-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1450 v:termresponse The escape sequence returned by the terminal for the |t_RV|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1451 termcap entry. It is set when Vim receives an escape sequence
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1452 that starts with ESC [ or CSI and ends in a 'c', with only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1453 digits, ';' and '.' in between.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1454 When this option is set, the TermResponse autocommand event is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1455 fired, so that you can react to the response from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1456 terminal.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1457 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1458 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1459 patch level (since this was introduced in patch 95, it's
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1460 always 95 or bigger). Pc is always zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1461 {only when compiled with |+termresponse| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1462
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1463 *v:this_session* *this_session-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1464 v:this_session Full filename of the last loaded or saved session file. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1465 |:mksession|. It is allowed to set this variable. When no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1466 session file has been saved, this variable is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1467 "this_session" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1468
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1469 *v:throwpoint* *throwpoint-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1470 v:throwpoint The point where the exception most recently caught and not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1471 finished was thrown. Not set when commands are typed. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1472 also |v:exception| and |throw-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1473 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1474 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1475 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1476 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1477 : echo "Exception from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1478 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1479 < Output: "Exception from test.vim, line 2"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1480
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1481 *v:val* *val-variable*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1482 v:val Value of the current item of a |List| or |Dictionary|. Only
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1483 valid while evaluating the expression used with |map()| and
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1484 |filter()|. Read-only.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1485
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1486 *v:version* *version-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1487 v:version Version number of Vim: Major version number times 100 plus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1488 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1489 is 501. Read-only. "version" also works, for backwards
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1490 compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1491 Use |has()| to check if a certain patch was included, e.g.: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1492 if has("patch123")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1493 < Note that patch numbers are specific to the version, thus both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1494 version 5.0 and 5.1 may have a patch 123, but these are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1495 completely different.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1496
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1497 *v:warningmsg* *warningmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1498 v:warningmsg Last given warning message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1499
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1500 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1501 4. Builtin Functions *functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1502
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1503 See |function-list| for a list grouped by what the function is used for.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1504
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
1505 (Use CTRL-] on the function name to jump to the full explanation.)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1506
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1507 USAGE RESULT DESCRIPTION ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1508
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1509 add( {list}, {item}) List append {item} to |List| {list}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1510 append( {lnum}, {string}) Number append {string} below line {lnum}
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
1511 append( {lnum}, {list}) Number append lines {list} below line {lnum}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1512 argc() Number number of files in the argument list
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1513 argidx() Number current index in the argument list
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1514 argv( {nr}) String {nr} entry of the argument list
818
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
1515 argv( ) List the argument list
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1516 browse( {save}, {title}, {initdir}, {default})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1517 String put up a file requester
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1518 browsedir( {title}, {initdir}) String put up a directory requester
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1519 bufexists( {expr}) Number TRUE if buffer {expr} exists
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1520 buflisted( {expr}) Number TRUE if buffer {expr} is listed
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1521 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1522 bufname( {expr}) String Name of the buffer {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1523 bufnr( {expr}) Number Number of the buffer {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1524 bufwinnr( {expr}) Number window number of buffer {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1525 byte2line( {byte}) Number line number at byte count {byte}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1526 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1527 call( {func}, {arglist} [, {dict}])
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1528 any call {func} with arguments {arglist}
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1529 changenr() Number current change number
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1530 char2nr( {expr}) Number ASCII value of first char in {expr}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1531 cindent( {lnum}) Number C indent for line {lnum}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1532 col( {expr}) Number column nr of cursor or mark
724
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
1533 complete({startcol}, {matches}) String set Insert mode completion
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
1534 complete_add( {expr}) Number add completion match
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
1535 complete_check() Number check for key typed during completion
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1536 confirm( {msg} [, {choices} [, {default} [, {type}]]])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1537 Number number of choice picked by user
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1538 copy( {expr}) any make a shallow copy of {expr}
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1539 count( {list}, {expr} [, {start} [, {ic}]])
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1540 Number count how many {expr} are in {list}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1541 cscope_connection( [{num} , {dbpath} [, {prepend}]])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1542 Number checks existence of cscope connection
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1543 cursor( {lnum}, {col} [, {coladd}])
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1544 Number move cursor to {lnum}, {col}, {coladd}
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1545 cursor( {list}) Number move cursor to position in {list}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1546 deepcopy( {expr}) any make a full copy of {expr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1547 delete( {fname}) Number delete file {fname}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1548 did_filetype() Number TRUE if FileType autocommand event used
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1549 diff_filler( {lnum}) Number diff filler lines about {lnum}
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1550 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
1551 empty( {expr}) Number TRUE if {expr} is empty
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1552 escape( {string}, {chars}) String escape {chars} in {string} with '\'
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
1553 eval( {string}) any evaluate {string} into its value
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1554 eventhandler( ) Number TRUE if inside an event handler
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1555 executable( {expr}) Number 1 if executable {expr} exists
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1556 exists( {expr}) Number TRUE if {expr} exists
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1557 extend({expr1}, {expr2} [, {expr3}])
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1558 List/Dict insert items of {expr2} into {expr1}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1559 expand( {expr}) String expand special keywords in {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1560 filereadable( {file}) Number TRUE if {file} is a readable file
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1561 filewritable( {file}) Number TRUE if {file} is a writable file
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1562 filter( {expr}, {string}) List/Dict remove items from {expr} where
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1563 {string} is 0
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1564 finddir( {name}[, {path}[, {count}]])
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1565 String find directory {name} in {path}
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
1566 findfile( {name}[, {path}[, {count}]])
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1567 String find file {name} in {path}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1568 fnamemodify( {fname}, {mods}) String modify file name
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1569 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1570 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1571 foldlevel( {lnum}) Number fold level at {lnum}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1572 foldtext( ) String line displayed for closed fold
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1573 foldtextresult( {lnum}) String text for closed fold at {lnum}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1574 foreground( ) Number bring the Vim window to the foreground
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1575 function( {name}) Funcref reference to function {name}
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1576 garbagecollect() none free memory, breaking cyclic references
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1577 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1578 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
1579 getbufline( {expr}, {lnum} [, {end}])
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
1580 List lines {lnum} to {end} of buffer {expr}
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1581 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1582 getchar( [expr]) Number get one character from the user
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1583 getcharmod( ) Number modifiers for the last typed character
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1584 getcmdline() String return the current command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1585 getcmdpos() Number return cursor position in command-line
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
1586 getcmdtype() String return the current command-line type
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1587 getcwd() String the current working directory
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
1588 getfperm( {fname}) String file permissions of file {fname}
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
1589 getfsize( {fname}) Number size in bytes of file {fname}
37
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
1590 getfontname( [{name}]) String name of font being used
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1591 getftime( {fname}) Number last modification time of file
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
1592 getftype( {fname}) String description of type of file {fname}
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
1593 getline( {lnum}) String line {lnum} of current buffer
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
1594 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
1595 getloclist({nr}) List list of location list items
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1596 getpos( {expr}) List position of cursor, mark, etc.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
1597 getqflist() List list of quickfix items
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
1598 getreg( [{regname} [, 1]]) String contents of register
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1599 getregtype( [{regname}]) String type of register
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
1600 gettabwinvar( {tabnr}, {winnr}, {name})
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
1601 any {name} in {winnr} in tab page {tabnr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1602 getwinposx() Number X coord in pixels of GUI Vim window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1603 getwinposy() Number Y coord in pixels of GUI Vim window
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1604 getwinvar( {nr}, {varname}) any variable {varname} in window {nr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1605 glob( {expr}) String expand file wildcards in {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1606 globpath( {path}, {expr}) String do glob({expr}) for all dirs in {path}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1607 has( {feature}) Number TRUE if feature {feature} supported
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1608 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1609 hasmapto( {what} [, {mode} [, {abbr}]])
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1610 Number TRUE if mapping to {what} exists
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1611 histadd( {history},{item}) String add an item to a history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1612 histdel( {history} [, {item}]) String remove an item from a history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1613 histget( {history} [, {index}]) String get the item {index} from a history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1614 histnr( {history}) Number highest index of a history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1615 hlexists( {name}) Number TRUE if highlight group {name} exists
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1616 hlID( {name}) Number syntax ID of highlight group {name}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1617 hostname() String name of the machine Vim is running on
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1618 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1619 indent( {lnum}) Number indent of line {lnum}
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1620 index( {list}, {expr} [, {start} [, {ic}]])
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1621 Number index in {list} where {expr} appears
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
1622 input( {prompt} [, {text} [, {completion}]])
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
1623 String get input from the user
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1624 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1625 inputlist( {textlist}) Number let the user pick from a choice list
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1626 inputrestore() Number restore typeahead
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1627 inputsave() Number save and clear typeahead
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1628 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1629 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1630 isdirectory( {directory}) Number TRUE if {directory} is a directory
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
1631 islocked( {expr}) Number TRUE if {expr} is locked
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1632 items( {dict}) List key-value pairs in {dict}
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1633 join( {list} [, {sep}]) String join {list} items into one String
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1634 keys( {dict}) List keys in {dict}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1635 len( {expr}) Number the length of {expr}
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1636 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1637 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1638 line( {expr}) Number line nr of cursor, last line or mark
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1639 line2byte( {lnum}) Number byte count of line {lnum}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1640 lispindent( {lnum}) Number Lisp indent for line {lnum}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1641 localtime() Number current time
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1642 map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1643 maparg( {name}[, {mode} [, {abbr}]])
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1644 String rhs of mapping {name} in mode {mode}
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1645 mapcheck( {name}[, {mode} [, {abbr}]])
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1646 String check for mappings matching {name}
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
1647 match( {expr}, {pat}[, {start}[, {count}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1648 Number position where {pat} matches in {expr}
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1649 matcharg( {nr}) List arguments of |:match|
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
1650 matchend( {expr}, {pat}[, {start}[, {count}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1651 Number position where {pat} ends in {expr}
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
1652 matchlist( {expr}, {pat}[, {start}[, {count}]])
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
1653 List match and submatches of {pat} in {expr}
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
1654 matchstr( {expr}, {pat}[, {start}[, {count}]])
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
1655 String {count}'th match of {pat} in {expr}
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1656 max({list}) Number maximum value of items in {list}
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1657 min({list}) Number minumum value of items in {list}
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
1658 mkdir({name} [, {path} [, {prot}]])
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
1659 Number create directory {name}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1660 mode() String current editing mode
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1661 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1662 nr2char( {expr}) String single char with ASCII value {expr}
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1663 pathshorten( {expr}) String shorten directory names in a path
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1664 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
1665 printf( {fmt}, {expr1}...) String format text
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
1666 pumvisible() Number whether popup menu is visible
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1667 range( {expr} [, {max} [, {stride}]])
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1668 List items from {expr} to {max}
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
1669 readfile({fname} [, {binary} [, {max}]])
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
1670 List get list of lines from file {fname}
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
1671 reltime( [{start} [, {end}]]) List get time value
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
1672 reltimestr( {time}) String turn time value into a String
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1673 remote_expr( {server}, {string} [, {idvar}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1674 String send expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1675 remote_foreground( {server}) Number bring Vim server to the foreground
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1676 remote_peek( {serverid} [, {retvar}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1677 Number check for reply string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1678 remote_read( {serverid}) String read reply string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1679 remote_send( {server}, {string} [, {idvar}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1680 String send key sequence
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1681 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1682 remove( {dict}, {key}) any remove entry {key} from {dict}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1683 rename( {from}, {to}) Number rename (move) file from {from} to {to}
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1684 repeat( {expr}, {count}) String repeat {expr} {count} times
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1685 resolve( {filename}) String get filename a shortcut points to
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1686 reverse( {list}) List reverse {list} in-place
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1687 search( {pattern} [, {flags}]) Number search for {pattern}
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
1688 searchdecl({name} [, {global} [, {thisblock}]])
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
1689 Number search for variable declaration
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
1690 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1691 Number search for other end of start/end pair
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
1692 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
1693 List search for other end of start/end pair
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
1694 searchpos( {pattern} [, {flags} [, {stopline}]])
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
1695 List search for {pattern}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1696 server2client( {clientid}, {string})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1697 Number send reply string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1698 serverlist() String get a list of available servers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1699 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1700 setcmdpos( {pos}) Number set cursor position in command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1701 setline( {lnum}, {line}) Number set line {lnum} to {line}
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
1702 setloclist( {nr}, {list}[, {action}])
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
1703 Number modify location list using {list}
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
1704 setpos( {expr}, {list}) none set the {expr} position to {list}
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
1705 setqflist( {list}[, {action}]) Number modify quickfix list using {list}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1706 setreg( {n}, {v}[, {opt}]) Number set register to value and type
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
1707 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
1708 {winnr} in tab page {tabnr} to {val}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1709 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1710 simplify( {filename}) String simplify filename as much as possible
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1711 sort( {list} [, {func}]) List sort {list}, using {func} to compare
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1712 soundfold( {word}) String sound-fold {word}
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
1713 spellbadword() String badly spelled word at cursor
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
1714 spellsuggest( {word} [, {max} [, {capital}]])
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
1715 List spelling suggestions
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
1716 split( {expr} [, {pat} [, {keepempty}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1717 List make |List| from {pat} separated {expr}
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
1718 str2nr( {expr} [, {base}]) Number convert string to number
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1719 strftime( {format}[, {time}]) String time in specified format
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1720 stridx( {haystack}, {needle}[, {start}])
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1721 Number index of {needle} in {haystack}
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
1722 string( {expr}) String String representation of {expr} value
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1723 strlen( {expr}) Number length of the String {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1724 strpart( {src}, {start}[, {len}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1725 String {len} characters of {src} at {start}
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
1726 strridx( {haystack}, {needle} [, {start}])
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
1727 Number last index of {needle} in {haystack}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1728 strtrans( {expr}) String translate string to make it printable
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1729 submatch( {nr}) String specific match in ":substitute"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1730 substitute( {expr}, {pat}, {sub}, {flags})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1731 String all {pat} in {expr} replaced with {sub}
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
1732 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1733 synIDattr( {synID}, {what} [, {mode}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1734 String attribute {what} of syntax ID {synID}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1735 synIDtrans( {synID}) Number translated syntax ID of {synID}
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1736 system( {expr} [, {input}]) String output of shell command/filter {expr}
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
1737 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
1738 tabpagenr( [{arg}]) Number number of current or last tab page
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
1739 tabpagewinnr( {tabarg}[, {arg}])
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
1740 Number number of current window in tab page
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
1741 taglist( {expr}) List list of tags matching {expr}
515
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 504
diff changeset
1742 tagfiles() List tags files used
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1743 tempname() String name for a temporary file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1744 tolower( {expr}) String the String {expr} switched to lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1745 toupper( {expr}) String the String {expr} switched to uppercase
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
1746 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
1747 to chars in {tostr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1748 type( {name}) Number type of variable {name}
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1749 values( {dict}) List values in {dict}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1750 virtcol( {expr}) Number screen column of cursor or mark
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1751 visualmode( [expr]) String last visual mode used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1752 winbufnr( {nr}) Number buffer number of window {nr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1753 wincol() Number window column of the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1754 winheight( {nr}) Number height of window {nr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1755 winline() Number window line of the cursor
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
1756 winnr( [{expr}]) Number number of current window
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1757 winrestcmd() String returns command to restore window sizes
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
1758 winrestview({dict}) None restore view of current window
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
1759 winsaveview() Dict save view of current window
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1760 winwidth( {nr}) Number width of window {nr}
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
1761 writefile({list}, {fname} [, {binary}])
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
1762 Number write list of lines to file {fname}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1763
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1764 add({list}, {expr}) *add()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1765 Append the item {expr} to |List| {list}. Returns the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1766 resulting |List|. Examples: >
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1767 :let alist = add([1, 2, 3], item)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1768 :call add(mylist, "woodstock")
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1769 < Note that when {expr} is a |List| it is appended as a single
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
1770 item. Use |extend()| to concatenate |Lists|.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
1771 Use |insert()| to add an item at another position.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1772
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1773
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1774 append({lnum}, {expr}) *append()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1775 When {expr} is a |List|: Append each item of the |List| as a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1776 text line below line {lnum} in the current buffer.
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
1777 Otherwise append {expr} as one text line below line {lnum} in
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
1778 the current buffer.
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
1779 {lnum} can be zero to insert a line before the first one.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1780 Returns 1 for failure ({lnum} out of range or out of memory),
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1781 0 for success. Example: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1782 :let failed = append(line('$'), "# THE END")
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
1783 :let failed = append(0, ["Chapter 1", "the beginning"])
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1784 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1785 *argc()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1786 argc() The result is the number of files in the argument list of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1787 current window. See |arglist|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1788
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1789 *argidx()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1790 argidx() The result is the current index in the argument list. 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1791 the first file. argc() - 1 is the last one. See |arglist|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1792
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1793 *argv()*
818
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
1794 argv([{nr}]) The result is the {nr}th file in the argument list of the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1795 current window. See |arglist|. "argv(0)" is the first one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1796 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1797 :let i = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1798 :while i < argc()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1799 : let f = escape(argv(i), '. ')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1800 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1801 : let i = i + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1802 :endwhile
818
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
1803 < Without the {nr} argument a |List| with the whole |arglist| is
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
1804 returned.
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
1805
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1806 *browse()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1807 browse({save}, {title}, {initdir}, {default})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1808 Put up a file requester. This only works when "has("browse")"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1809 returns non-zero (only in some GUI versions).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1810 The input fields are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1811 {save} when non-zero, select file to write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1812 {title} title for the requester
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1813 {initdir} directory to start browsing in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1814 {default} default file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1815 When the "Cancel" button is hit, something went wrong, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1816 browsing is not possible, an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1817
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1818 *browsedir()*
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1819 browsedir({title}, {initdir})
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1820 Put up a directory requester. This only works when
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1821 "has("browse")" returns non-zero (only in some GUI versions).
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1822 On systems where a directory browser is not supported a file
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1823 browser is used. In that case: select a file in the directory
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1824 to be used.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1825 The input fields are:
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1826 {title} title for the requester
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1827 {initdir} directory to start browsing in
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1828 When the "Cancel" button is hit, something went wrong, or
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1829 browsing is not possible, an empty string is returned.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1830
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1831 bufexists({expr}) *bufexists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1832 The result is a Number, which is non-zero if a buffer called
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1833 {expr} exists.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1834 If the {expr} argument is a number, buffer numbers are used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1835 If the {expr} argument is a string it must match a buffer name
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1836 exactly. The name can be:
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1837 - Relative to the current directory.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1838 - A full path.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1839 - The name of a buffer with 'filetype' set to "nofile".
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1840 - A URL name.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1841 Unlisted buffers will be found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1842 Note that help files are listed by their short name in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1843 output of |:buffers|, but bufexists() requires using their
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1844 long name to be able to find them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1845 Use "bufexists(0)" to test for the existence of an alternate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1846 file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1847 *buffer_exists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1848 Obsolete name: buffer_exists().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1849
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1850 buflisted({expr}) *buflisted()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1851 The result is a Number, which is non-zero if a buffer called
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1852 {expr} exists and is listed (has the 'buflisted' option set).
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1853 The {expr} argument is used like with |bufexists()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1854
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1855 bufloaded({expr}) *bufloaded()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1856 The result is a Number, which is non-zero if a buffer called
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1857 {expr} exists and is loaded (shown in a window or hidden).
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1858 The {expr} argument is used like with |bufexists()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1859
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1860 bufname({expr}) *bufname()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1861 The result is the name of a buffer, as it is displayed by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1862 ":ls" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1863 If {expr} is a Number, that buffer number's name is given.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1864 Number zero is the alternate buffer for the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1865 If {expr} is a String, it is used as a |file-pattern| to match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1866 with the buffer names. This is always done like 'magic' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1867 set and 'cpoptions' is empty. When there is more than one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1868 match an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1869 "" or "%" can be used for the current buffer, "#" for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1870 alternate buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1871 A full match is preferred, otherwise a match at the start, end
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1872 or middle of the buffer name is accepted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1873 Listed buffers are found first. If there is a single match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1874 with a listed buffer, that one is returned. Next unlisted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1875 buffers are searched for.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1876 If the {expr} is a String, but you want to use it as a buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1877 number, force it to be a Number by adding zero to it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1878 :echo bufname("3" + 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1879 < If the buffer doesn't exist, or doesn't have a name, an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1880 string is returned. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1881 bufname("#") alternate buffer name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1882 bufname(3) name of buffer 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1883 bufname("%") name of current buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1884 bufname("file2") name of buffer where "file2" matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1885 < *buffer_name()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1886 Obsolete name: buffer_name().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1887
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1888 *bufnr()*
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1889 bufnr({expr} [, {create}])
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1890 The result is the number of a buffer, as it is displayed by
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1891 the ":ls" command. For the use of {expr}, see |bufname()|
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1892 above.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1893 If the buffer doesn't exist, -1 is returned. Or, if the
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1894 {create} argument is present and not zero, a new, unlisted,
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
1895 buffer is created and its number is returned.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1896 bufnr("$") is the last buffer: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1897 :let last_buffer = bufnr("$")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1898 < The result is a Number, which is the highest buffer number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1899 of existing buffers. Note that not all buffers with a smaller
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1900 number necessarily exist, because ":bwipeout" may have removed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1901 them. Use bufexists() to test for the existence of a buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1902 *buffer_number()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1903 Obsolete name: buffer_number().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1904 *last_buffer_nr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1905 Obsolete name for bufnr("$"): last_buffer_nr().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1906
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1907 bufwinnr({expr}) *bufwinnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1908 The result is a Number, which is the number of the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1909 window associated with buffer {expr}. For the use of {expr},
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1910 see |bufname()| above. If buffer {expr} doesn't exist or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1911 there is no such window, -1 is returned. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1912
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1913 echo "A window containing buffer 1 is " . (bufwinnr(1))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1914
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1915 < The number can be used with |CTRL-W_w| and ":wincmd w"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1916 |:wincmd|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1917
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1919 byte2line({byte}) *byte2line()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1920 Return the line number that contains the character at byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1921 count {byte} in the current buffer. This includes the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1922 end-of-line character, depending on the 'fileformat' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1923 for the current buffer. The first character has byte count
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1924 one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1925 Also see |line2byte()|, |go| and |:goto|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1926 {not available when compiled without the |+byte_offset|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1927 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1928
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1929 byteidx({expr}, {nr}) *byteidx()*
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1930 Return byte index of the {nr}'th character in the string
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1931 {expr}. Use zero for the first character, it returns zero.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1932 This function is only useful when there are multibyte
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1933 characters, otherwise the returned value is equal to {nr}.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1934 Composing characters are counted as a separate character.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1935 Example : >
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1936 echo matchstr(str, ".", byteidx(str, 3))
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1937 < will display the fourth character. Another way to do the
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1938 same: >
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1939 let s = strpart(str, byteidx(str, 3))
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1940 echo strpart(s, 0, byteidx(s, 1))
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1941 < If there are less than {nr} characters -1 is returned.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1942 If there are exactly {nr} characters the length of the string
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1943 is returned.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
1944
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1945 call({func}, {arglist} [, {dict}]) *call()* *E699*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1946 Call function {func} with the items in |List| {arglist} as
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1947 arguments.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1948 {func} can either be a |Funcref| or the name of a function.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1949 a:firstline and a:lastline are set to the cursor line.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1950 Returns the return value of the called function.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1951 {dict} is for functions with the "dict" attribute. It will be
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1952 used to set the local variable "self". |Dictionary-function|
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1953
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1954 changenr() *changenr()*
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1955 Return the number of the most recent change. This is the same
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1956 number as what is displayed with |:undolist| and can be used
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1957 with the |:undo| command.
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1958 When a change was made it is the number of that change. After
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1959 redo it is the number of the redone change. After undo it is
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1960 one less than the number of the undone change.
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
1961
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1962 char2nr({expr}) *char2nr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1963 Return number value of the first char in {expr}. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1964 char2nr(" ") returns 32
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1965 char2nr("ABC") returns 65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1966 < The current 'encoding' is used. Example for "utf-8": >
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
1967 char2nr("?") returns 225
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
1968 char2nr("?"[0]) returns 195
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
1969 < nr2char() does the opposite.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1970
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1971 cindent({lnum}) *cindent()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1972 Get the amount of indent for line {lnum} according the C
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1973 indenting rules, as with 'cindent'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1974 The indent is counted in spaces, the value of 'tabstop' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1975 relevant. {lnum} is used just like in |getline()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1976 When {lnum} is invalid or Vim was not compiled the |+cindent|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1977 feature, -1 is returned.
548
f43150a669dc updated for version 7.0155
vimboss
parents: 540
diff changeset
1978 See |C-indenting|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1979
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1980 *col()*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
1981 col({expr}) The result is a Number, which is the byte index of the column
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1982 position given with {expr}. The accepted positions are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1983 . the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1984 $ the end of the cursor line (the result is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1985 number of characters in the cursor line plus one)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1986 'x position of mark x (if the mark is not set, 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1987 returned)
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1988 To get the line number use |col()|. To get both use
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
1989 |getpos()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1990 For the screen column position use |virtcol()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1991 Note that only marks in the current file can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1992 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1993 col(".") column of cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1994 col("$") length of cursor line plus one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1995 col("'t") column of mark t
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1996 col("'" . markname) column of mark markname
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1997 < The first column is 1. 0 is returned for an error.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1998 For the cursor position, when 'virtualedit' is active, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1999 column is one higher if the cursor is after the end of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2000 line. This can be used to obtain the column in Insert mode: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2001 :imap <F2> <C-O>:let save_ve = &ve<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2002 \<C-O>:set ve=all<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2003 \<C-O>:echo col(".") . "\n" <Bar>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2004 \let &ve = save_ve<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2005 <
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2006
724
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2007 complete({startcol}, {matches}) *complete()* *E785*
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2008 Set the matches for Insert mode completion.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2009 Can only be used in Insert mode. You need to use a mapping
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2010 with an expression argument |:map-<expr>| or CTRL-R =
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2011 |i_CTRL-R|. It does not work after CTRL-O.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2012 {startcol} is the byte offset in the line where the completed
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2013 text start. The text up to the cursor is the original text
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2014 that will be replaced by the matches. Use col('.') for an
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2015 empty string. "col('.') - 1" will replace one character by a
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2016 match.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2017 {matches} must be a |List|. Each |List| item is one match.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2018 See |complete-items| for the kind of items that are possible.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2019 Note that the after calling this function you need to avoid
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2020 inserting anything that would completion to stop.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2021 The match can be selected with CTRL-N and CTRL-P as usual with
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2022 Insert mode completion. The popup menu will appear if
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2023 specified, see |ins-completion-menu|.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2024 Example: >
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2025 inoremap <expr> <F5> ListMonths()
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2026
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2027 func! ListMonths()
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2028 call complete(col('.'), ['January', 'February', 'March',
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2029 \ 'April', 'May', 'June', 'July', 'August', 'September',
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2030 \ 'October', 'November', 'December'])
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2031 return ''
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2032 endfunc
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2033 < This isn't very useful, but it shows how it works. Note that
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2034 an empty string is returned to avoid a zero being inserted.
a35dce0cabc5 updated for version 7.0220
vimboss
parents: 716
diff changeset
2035
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2036 complete_add({expr}) *complete_add()*
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2037 Add {expr} to the list of matches. Only to be used by the
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2038 function specified with the 'completefunc' option.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2039 Returns 0 for failure (empty string or out of memory),
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2040 1 when the match was added, 2 when the match was already in
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2041 the list.
786
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
2042 See |complete-functions| for an explanation of {expr}. It is
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
2043 the same as one item in the list that 'omnifunc' would return.
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2044
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2045 complete_check() *complete_check()*
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2046 Check for a key typed while looking for completion matches.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2047 This is to be used when looking for matches takes some time.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2048 Returns non-zero when searching for matches is to be aborted,
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2049 zero otherwise.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2050 Only to be used by the function specified with the
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2051 'completefunc' option.
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
2052
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2053 *confirm()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2054 confirm({msg} [, {choices} [, {default} [, {type}]]])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2055 Confirm() offers the user a dialog, from which a choice can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2056 made. It returns the number of the choice. For the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2057 choice this is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2058 Note: confirm() is only supported when compiled with dialog
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2059 support, see |+dialog_con| and |+dialog_gui|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2060 {msg} is displayed in a |dialog| with {choices} as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2061 alternatives. When {choices} is missing or empty, "&OK" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2062 used (and translated).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2063 {msg} is a String, use '\n' to include a newline. Only on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2064 some systems the string is wrapped when it doesn't fit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2065 {choices} is a String, with the individual choices separated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2066 by '\n', e.g. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2067 confirm("Save changes?", "&Yes\n&No\n&Cancel")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2068 < The letter after the '&' is the shortcut key for that choice.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2069 Thus you can type 'c' to select "Cancel". The shortcut does
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2070 not need to be the first letter: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2071 confirm("file has been modified", "&Save\nSave &All")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2072 < For the console, the first letter of each choice is used as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2073 the default shortcut key.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2074 The optional {default} argument is the number of the choice
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2075 that is made if the user hits <CR>. Use 1 to make the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2076 choice the default one. Use 0 to not set a default. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2077 {default} is omitted, 1 is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2078 The optional {type} argument gives the type of dialog. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2079 is only used for the icon of the Win32 GUI. It can be one of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2080 these values: "Error", "Question", "Info", "Warning" or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2081 "Generic". Only the first character is relevant. When {type}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2082 is omitted, "Generic" is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2083 If the user aborts the dialog by pressing <Esc>, CTRL-C,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2084 or another valid interrupt key, confirm() returns 0.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2085
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2086 An example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2087 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2088 :if choice == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2089 : echo "make up your mind!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2090 :elseif choice == 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2091 : echo "tasteful"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2092 :else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2093 : echo "I prefer bananas myself."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2094 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2095 < In a GUI dialog, buttons are used. The layout of the buttons
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2096 depends on the 'v' flag in 'guioptions'. If it is included,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2097 the buttons are always put vertically. Otherwise, confirm()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2098 tries to put the buttons in one horizontal line. If they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2099 don't fit, a vertical layout is used anyway. For some systems
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2100 the horizontal layout is always used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2101
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2102 *copy()*
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2103 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2104 different from using {expr} directly.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2105 When {expr} is a |List| a shallow copy is created. This means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2106 that the original |List| can be changed without changing the
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2107 copy, and vise versa. But the items are identical, thus
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2108 changing an item changes the contents of both |Lists|. Also
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2109 see |deepcopy()|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2110
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2111 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2112 Return the number of times an item with value {expr} appears
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2113 in |List| or |Dictionary| {comp}.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2114 If {start} is given then start with the item with this index.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2115 {start} can only be used with a |List|.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2116 When {ic} is given and it's non-zero then case is ignored.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2117
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2118
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2119 *cscope_connection()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2120 cscope_connection([{num} , {dbpath} [, {prepend}]])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2121 Checks for the existence of a |cscope| connection. If no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2122 parameters are specified, then the function returns:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2123 0, if cscope was not available (not compiled in), or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2124 if there are no cscope connections;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2125 1, if there is at least one cscope connection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2127 If parameters are specified, then the value of {num}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2128 determines how existence of a cscope connection is checked:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2129
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2130 {num} Description of existence check
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2131 ----- ------------------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2132 0 Same as no parameters (e.g., "cscope_connection()").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2133 1 Ignore {prepend}, and use partial string matches for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2134 {dbpath}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2135 2 Ignore {prepend}, and use exact string matches for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2136 {dbpath}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2137 3 Use {prepend}, use partial string matches for both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2138 {dbpath} and {prepend}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2139 4 Use {prepend}, use exact string matches for both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2140 {dbpath} and {prepend}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2141
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2142 Note: All string comparisons are case sensitive!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2143
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2144 Examples. Suppose we had the following (from ":cs show"): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2145
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2146 # pid database name prepend path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2147 0 27664 cscope.out /usr/local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2148 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2149 Invocation Return Val ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2150 ---------- ---------- >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2151 cscope_connection() 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2152 cscope_connection(1, "out") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2153 cscope_connection(2, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2154 cscope_connection(3, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2155 cscope_connection(3, "out", "local") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2156 cscope_connection(4, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2157 cscope_connection(4, "out", "local") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2158 cscope_connection(4, "cscope.out", "/usr/local") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2159 <
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2160 cursor({lnum}, {col} [, {off}]) *cursor()*
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2161 cursor({list})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2162 Positions the cursor at the column {col} in the line {lnum}.
493
06364aa0d597 updated for version 7.0135
vimboss
parents: 484
diff changeset
2163 The first column is one.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2164 When there is one argument {list} this is used as a |List|
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
2165 with two or three items {lnum}, {col} and {off}. This is like
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
2166 the return value of |getpos()|, but without the first item.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2167 Does not change the jumplist.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2168 If {lnum} is greater than the number of lines in the buffer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2169 the cursor will be positioned at the last line in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2170 If {lnum} is zero, the cursor will stay in the current line.
493
06364aa0d597 updated for version 7.0135
vimboss
parents: 484
diff changeset
2171 If {col} is greater than the number of bytes in the line,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2172 the cursor will be positioned at the last character in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2173 line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2174 If {col} is zero, the cursor will stay in the current column.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2175 When 'virtualedit' is used {off} specifies the offset in
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2176 screen columns from the start of the character. E.g., a
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
2177 position within a Tab or after the last character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2178
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2179
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2180 deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2181 Make a copy of {expr}. For Numbers and Strings this isn't
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2182 different from using {expr} directly.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2183 When {expr} is a |List| a full copy is created. This means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2184 that the original |List| can be changed without changing the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2185 copy, and vise versa. When an item is a |List|, a copy for it
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2186 is made, recursively. Thus changing an item in the copy does
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2187 not change the contents of the original |List|.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2188 When {noref} is omitted or zero a contained |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2189 |Dictionary| is only copied once. All references point to
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2190 this single copy. With {noref} set to 1 every occurrence of a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2191 |List| or |Dictionary| results in a new copy. This also means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2192 that a cyclic reference causes deepcopy() to fail.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
2193 *E724*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
2194 Nesting is possible up to 100 levels. When there is an item
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2195 that refers back to a higher level making a deep copy with
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
2196 {noref} set to 1 will fail.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2197 Also see |copy()|.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2198
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2199 delete({fname}) *delete()*
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2200 Deletes the file by the name {fname}. The result is a Number,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2201 which is 0 if the file was deleted successfully, and non-zero
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2202 when the deletion failed.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2203 Use |remove()| to delete an item from a |List|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2204
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2205 *did_filetype()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2206 did_filetype() Returns non-zero when autocommands are being executed and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2207 FileType event has been triggered at least once. Can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2208 to avoid triggering the FileType event again in the scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2209 that detect the file type. |FileType|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2210 When editing another file, the counter is reset, thus this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2211 really checks if the FileType event has been triggered for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2212 current buffer. This allows an autocommand that starts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2213 editing another buffer to set 'filetype' and load a syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2214 file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2215
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2216 diff_filler({lnum}) *diff_filler()*
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2217 Returns the number of filler lines above line {lnum}.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2218 These are the lines that were inserted at this point in
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2219 another diff'ed window. These filler lines are shown in the
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2220 display but don't exist in the buffer.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2221 {lnum} is used like with |getline()|. Thus "." is the current
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2222 line, "'m" mark m, etc.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2223 Returns 0 if the current window is not in diff mode.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2224
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2225 diff_hlID({lnum}, {col}) *diff_hlID()*
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2226 Returns the highlight ID for diff mode at line {lnum} column
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2227 {col} (byte index). When the current line does not have a
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2228 diff change zero is returned.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2229 {lnum} is used like with |getline()|. Thus "." is the current
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2230 line, "'m" mark m, etc.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2231 {col} is 1 for the leftmost column, {lnum} is 1 for the first
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2232 line.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2233 The highlight ID can be used with |synIDattr()| to obtain
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2234 syntax information about the highlighting.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
2235
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
2236 empty({expr}) *empty()*
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
2237 Return the Number 1 if {expr} is empty, zero otherwise.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2238 A |List| or |Dictionary| is empty when it does not have any
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2239 items. A Number is empty when its value is zero.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2240 For a long |List| this is much faster then comparing the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2241 length with zero.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
2242
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2243 escape({string}, {chars}) *escape()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2244 Escape the characters in {chars} that occur in {string} with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2245 backslash. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2246 :echo escape('c:\program files\vim', ' \')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2247 < results in: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2248 c:\\program\ files\\vim
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2249
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2250 < *eval()*
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2251 eval({string}) Evaluate {string} and return the result. Especially useful to
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2252 turn the result of |string()| back into the original value.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2253 This works for Numbers, Strings and composites of them.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2254 Also works for |Funcref|s that refer to existing functions.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2255
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2256 eventhandler() *eventhandler()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2257 Returns 1 when inside an event handler. That is that Vim got
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2258 interrupted while waiting for the user to type a character,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2259 e.g., when dropping a file on Vim. This means interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2260 commands cannot be used. Otherwise zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2261
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2262 executable({expr}) *executable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2263 This function checks if an executable with the name {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2264 exists. {expr} must be the name of the program without any
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2265 arguments.
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2266 executable() uses the value of $PATH and/or the normal
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2267 searchpath for programs. *PATHEXT*
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2268 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2269 optionally be included. Then the extensions in $PATHEXT are
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2270 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2271 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2272 used. A dot by itself can be used in $PATHEXT to try using
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2273 the name without an extension. When 'shell' looks like a
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2274 Unix shell, then the name is also tried without adding an
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2275 extension.
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2276 On MS-DOS and MS-Windows it only checks if the file exists and
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
2277 is not a directory, not if it's really executable.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
2278 On MS-Windows an executable in the same directory as Vim is
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
2279 always found. Since this directory is added to $PATH it
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
2280 should also work to execute it |win32-PATH|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2281 The result is a Number:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2282 1 exists
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2283 0 does not exist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2284 -1 not implemented on this system
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2286 *exists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2287 exists({expr}) The result is a Number, which is non-zero if {expr} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2288 defined, zero otherwise. The {expr} argument is a string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2289 which contains one of these:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2290 &option-name Vim option (only checks if it exists,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2291 not if it really works)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2292 +option-name Vim option that works.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2293 $ENVNAME environment variable (could also be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2294 done by comparing with an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2295 string)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2296 *funcname built-in function (see |functions|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2297 or user defined function (see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2298 |user-functions|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2299 varname internal variable (see
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
2300 |internal-variables|). Also works
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2301 for |curly-braces-names|, |Dictionary|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2302 entries, |List| items, etc. Beware
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2303 that this may cause functions to be
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
2304 invoked cause an error message for an
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
2305 invalid expression.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2306 :cmdname Ex command: built-in command, user
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2307 command or command modifier |:command|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2308 Returns:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2309 1 for match with start of a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2310 2 full match with a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2311 3 matches several user commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2312 To check for a supported command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2313 always check the return value to be 2.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2314 #event autocommand defined for this event
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2315 #event#pattern autocommand defined for this event and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2316 pattern (the pattern is taken
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2317 literally and compared to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2318 autocommand patterns character by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2319 character)
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2320 #group autocommand group exists
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2321 #group#event autocommand defined for this group and
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2322 event.
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2323 #group#event#pattern
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2324 autocommand defined for this group,
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2325 event and pattern.
615
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
2326 ##event autocommand for this event is
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
2327 supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2328 For checking for a supported feature use |has()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2329
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2330 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2331 exists("&shortname")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2332 exists("$HOSTNAME")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2333 exists("*strftime")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2334 exists("*s:MyFunc")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2335 exists("bufcount")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2336 exists(":Make")
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2337 exists("#CursorHold")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2338 exists("#BufReadPre#*.gz")
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2339 exists("#filetypeindent")
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2340 exists("#filetypeindent#FileType")
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
2341 exists("#filetypeindent#FileType#*")
615
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
2342 exists("##ColorScheme")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2343 < There must be no space between the symbol (&/$/*/#) and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2344 name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2345 Note that the argument must be a string, not the name of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2346 variable itself! For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2347 exists(bufcount)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2348 < This doesn't check for existence of the "bufcount" variable,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2349 but gets the contents of "bufcount", and checks if that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2350 exists.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2351
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2352 expand({expr} [, {flag}]) *expand()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2353 Expand wildcards and the following special keywords in {expr}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2354 The result is a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2355
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2356 When there are several matches, they are separated by <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2357 characters. [Note: in version 5.0 a space was used, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2358 caused problems when a file name contains a space]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2359
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2360 If the expansion fails, the result is an empty string. A name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2361 for a non-existing file is not included.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2363 When {expr} starts with '%', '#' or '<', the expansion is done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2364 like for the |cmdline-special| variables with their associated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2365 modifiers. Here is a short overview:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2366
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2367 % current file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2368 # alternate file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2369 #n alternate file name n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2370 <cfile> file name under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2371 <afile> autocmd file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2372 <abuf> autocmd buffer number (as a String!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2373 <amatch> autocmd matched name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2374 <sfile> sourced script file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2375 <cword> word under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2376 <cWORD> WORD under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2377 <client> the {clientid} of the last received
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2378 message |server2client()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2379 Modifiers:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2380 :p expand to full path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2381 :h head (last path component removed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2382 :t tail (last path component only)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2383 :r root (one extension removed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2384 :e extension only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2385
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2386 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2387 :let &tags = expand("%:p:h") . "/tags"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2388 < Note that when expanding a string that starts with '%', '#' or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2389 '<', any following text is ignored. This does NOT work: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2390 :let doesntwork = expand("%:h.bak")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2391 < Use this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2392 :let doeswork = expand("%:h") . ".bak"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2393 < Also note that expanding "<cfile>" and others only returns the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2394 referenced file name without further expansion. If "<cfile>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2395 is "~/.cshrc", you need to do another expand() to have the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2396 "~/" expanded into the path of the home directory: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2397 :echo expand(expand("<cfile>"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2398 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2399 There cannot be white space between the variables and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2400 following modifier. The |fnamemodify()| function can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2401 to modify normal file names.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2402
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2403 When using '%' or '#', and the current or alternate file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2404 is not defined, an empty string is used. Using "%:p" in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2405 buffer with no name, results in the current directory, with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2406 '/' added.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2407
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2408 When {expr} does not start with '%', '#' or '<', it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2409 expanded like a file name is expanded on the command line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2410 'suffixes' and 'wildignore' are used, unless the optional
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2411 {flag} argument is given and it is non-zero. Names for
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2412 non-existing files are included. The "**" item can be used to
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2413 search in a directory tree. For example, to find all "README"
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2414 files in the current directory and below: >
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2415 :echo expand("**/README")
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2416 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2417 Expand() can also be used to expand variables and environment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2418 variables that are only known in a shell. But this can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2419 slow, because a shell must be started. See |expr-env-expand|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2420 The expanded variable is still handled like a list of file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2421 names. When an environment variable cannot be expanded, it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2422 left unchanged. Thus ":echo expand('$FOOBAR')" results in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2423 "$FOOBAR".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2424
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2425 See |glob()| for finding existing files. See |system()| for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2426 getting the raw output of an external command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2427
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2428 extend({expr1}, {expr2} [, {expr3}]) *extend()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2429 {expr1} and {expr2} must be both |Lists| or both
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2430 |Dictionaries|.
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2431
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2432 If they are |Lists|: Append {expr2} to {expr1}.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2433 If {expr3} is given insert the items of {expr2} before item
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2434 {expr3} in {expr1}. When {expr3} is zero insert before the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2435 first item. When {expr3} is equal to len({expr1}) then
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2436 {expr2} is appended.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2437 Examples: >
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2438 :echo sort(extend(mylist, [7, 5]))
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2439 :call extend(mylist, [2, 3], 1)
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2440 < Use |add()| to concatenate one item to a list. To concatenate
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2441 two lists into a new list use the + operator: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2442 :let newlist = [1, 2, 3] + [4, 5]
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2443 <
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2444 If they are |Dictionaries|:
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2445 Add all entries from {expr2} to {expr1}.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2446 If a key exists in both {expr1} and {expr2} then {expr3} is
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2447 used to decide what to do:
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2448 {expr3} = "keep": keep the value of {expr1}
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2449 {expr3} = "force": use the value of {expr2}
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
2450 {expr3} = "error": give an error message *E737*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2451 When {expr3} is omitted then "force" is assumed.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2452
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2453 {expr1} is changed when {expr2} is not empty. If necessary
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2454 make a copy of {expr1} first.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2455 {expr2} remains unchanged.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2456 Returns {expr1}.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2457
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
2458
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2459 filereadable({file}) *filereadable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2460 The result is a Number, which is TRUE when a file with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2461 name {file} exists, and can be read. If {file} doesn't exist,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2462 or is a directory, the result is FALSE. {file} is any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2463 expression, which is used as a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2464 *file_readable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2465 Obsolete name: file_readable().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2466
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2467
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2468 filter({expr}, {string}) *filter()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2469 {expr} must be a |List| or a |Dictionary|.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2470 For each item in {expr} evaluate {string} and when the result
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2471 is zero remove the item from the |List| or |Dictionary|.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2472 Inside {string} |v:val| has the value of the current item.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2473 For a |Dictionary| |v:key| has the key of the current item.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2474 Examples: >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2475 :call filter(mylist, 'v:val !~ "OLD"')
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2476 < Removes the items where "OLD" appears. >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2477 :call filter(mydict, 'v:key >= 8')
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2478 < Removes the items with a key below 8. >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2479 :call filter(var, 0)
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2480 < Removes all the items, thus clears the |List| or |Dictionary|.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
2481
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2482 Note that {string} is the result of expression and is then
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2483 used as an expression again. Often it is good to use a
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2484 |literal-string| to avoid having to double backslashes.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2485
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2486 The operation is done in-place. If you want a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2487 |Dictionary| to remain unmodified make a copy first: >
650
662e40bd2be1 updated for version 7.0191
vimboss
parents: 648
diff changeset
2488 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2489
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2490 < Returns {expr}, the |List| or |Dictionary| that was filtered.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
2491 When an error is encountered while evaluating {string} no
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
2492 further items in {expr} are processed.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2493
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2494
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2495 finddir({name}[, {path}[, {count}]]) *finddir()*
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2496 Find directory {name} in {path}. Returns the path of the
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2497 first found match. When the found directory is below the
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2498 current directory a relative path is returned. Otherwise a
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2499 full path is returned.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2500 If {path} is omitted or empty then 'path' is used.
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2501 If the optional {count} is given, find {count}'s occurrence of
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2502 {name} in {path} instead of the first one.
809
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 805
diff changeset
2503 When {count} is negative return all the matches in a |List|.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2504 This is quite similar to the ex-command |:find|.
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2505 {only available when compiled with the +file_in_path feature}
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2506
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2507 findfile({name}[, {path}[, {count}]]) *findfile()*
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2508 Just like |finddir()|, but find a file instead of a directory.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
2509 Uses 'suffixesadd'.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2510 Example: >
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2511 :echo findfile("tags.vim", ".;")
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2512 < Searches from the current directory upwards until it finds
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2513 the file "tags.vim".
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2514
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2515 filewritable({file}) *filewritable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2516 The result is a Number, which is 1 when a file with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2517 name {file} exists, and can be written. If {file} doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2518 exist, or is not writable, the result is 0. If (file) is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2519 directory, and we can write to it, the result is 2.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2520
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2521 fnamemodify({fname}, {mods}) *fnamemodify()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2522 Modify file name {fname} according to {mods}. {mods} is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2523 string of characters like it is used for file names on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2524 command line. See |filename-modifiers|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2525 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2526 :echo fnamemodify("main.c", ":p:h")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2527 < results in: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2528 /home/mool/vim/vim/src
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2529 < Note: Environment variables and "~" don't work in {fname}, use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2530 |expand()| first then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2531
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2532 foldclosed({lnum}) *foldclosed()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2533 The result is a Number. If the line {lnum} is in a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2534 fold, the result is the number of the first line in that fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2535 If the line {lnum} is not in a closed fold, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2536
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2537 foldclosedend({lnum}) *foldclosedend()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2538 The result is a Number. If the line {lnum} is in a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2539 fold, the result is the number of the last line in that fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2540 If the line {lnum} is not in a closed fold, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2541
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2542 foldlevel({lnum}) *foldlevel()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2543 The result is a Number, which is the foldlevel of line {lnum}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2544 in the current buffer. For nested folds the deepest level is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2545 returned. If there is no fold at line {lnum}, zero is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2546 returned. It doesn't matter if the folds are open or closed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2547 When used while updating folds (from 'foldexpr') -1 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2548 returned for lines where folds are still to be updated and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2549 foldlevel is unknown. As a special case the level of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2550 previous line is usually available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2551
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2552 *foldtext()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2553 foldtext() Returns a String, to be displayed for a closed fold. This is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2554 the default function used for the 'foldtext' option and should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2555 only be called from evaluating 'foldtext'. It uses the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2556 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2557 The returned string looks like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2558 +-- 45 lines: abcdef
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2559 < The number of dashes depends on the foldlevel. The "45" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2560 the number of lines in the fold. "abcdef" is the text in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2561 first non-blank line of the fold. Leading white space, "//"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2562 or "/*" and the text from the 'foldmarker' and 'commentstring'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2563 options is removed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2564 {not available when compiled without the |+folding| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2565
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2566 foldtextresult({lnum}) *foldtextresult()*
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2567 Returns the text that is displayed for the closed fold at line
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2568 {lnum}. Evaluates 'foldtext' in the appropriate context.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2569 When there is no closed fold at {lnum} an empty string is
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2570 returned.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2571 {lnum} is used like with |getline()|. Thus "." is the current
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2572 line, "'m" mark m, etc.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2573 Useful when exporting folded text, e.g., to HTML.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2574 {not available when compiled without the |+folding| feature}
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
2575
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2576 *foreground()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2577 foreground() Move the Vim window to the foreground. Useful when sent from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2578 a client to a Vim server. |remote_send()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2579 On Win32 systems this might not work, the OS does not always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2580 allow a window to bring itself to the foreground. Use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2581 |remote_foreground()| instead.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2582 {only in the Win32, Athena, Motif and GTK GUI versions and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2583 Win32 console version}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2584
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2585
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
2586 function({name}) *function()* *E700*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2587 Return a |Funcref| variable that refers to function {name}.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2588 {name} can be a user defined function or an internal function.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2589
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2590
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2591 garbagecollect() *garbagecollect()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2592 Cleanup unused |Lists| and |Dictionaries| that have circular
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2593 references. There is hardly ever a need to invoke this
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2594 function, as it is automatically done when Vim runs out of
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2595 memory or is waiting for the user to press a key after
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2596 'updatetime'. Items without circular references are always
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2597 freed when they become unused.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2598 This is useful if you have deleted a very big |List| and/or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2599 |Dictionary| with circular references in a script that runs
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2600 for a long time.
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
2601
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
2602 get({list}, {idx} [, {default}]) *get()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2603 Get item {idx} from |List| {list}. When this item is not
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2604 available return {default}. Return zero when {default} is
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2605 omitted.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2606 get({dict}, {key} [, {default}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2607 Get item with key {key} from |Dictionary| {dict}. When this
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2608 item is not available return {default}. Return zero when
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2609 {default} is omitted.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2610
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2611 *getbufline()*
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2612 getbufline({expr}, {lnum} [, {end}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2613 Return a |List| with the lines starting from {lnum} to {end}
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2614 (inclusive) in the buffer {expr}. If {end} is omitted, a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2615 |List| with only the line {lnum} is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2616
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2617 For the use of {expr}, see |bufname()| above.
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2618
448
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
2619 For {lnum} and {end} "$" can be used for the last line of the
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
2620 buffer. Otherwise a number must be used.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2621
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2622 When {lnum} is smaller than 1 or bigger than the number of
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2623 lines in the buffer, an empty |List| is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2624
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2625 When {end} is greater than the number of lines in the buffer,
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2626 it is treated as {end} is set to the number of lines in the
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2627 buffer. When {end} is before {lnum} an empty |List| is
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2628 returned.
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2629
448
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
2630 This function works only for loaded buffers. For unloaded and
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2631 non-existing buffers, an empty |List| is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2632
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2633 Example: >
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2634 :let lines = getbufline(bufnr("myfile"), 1, "$")
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2635
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2636 getbufvar({expr}, {varname}) *getbufvar()*
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2637 The result is the value of option or local buffer variable
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2638 {varname} in buffer {expr}. Note that the name without "b:"
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2639 must be used.
216
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
2640 This also works for a global or buffer-local option, but it
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
2641 doesn't work for a global variable, window-local variable or
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
2642 window-local option.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2643 For the use of {expr}, see |bufname()| above.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2644 When the buffer or variable doesn't exist an empty string is
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2645 returned, there is no error message.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2646 Examples: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2647 :let bufmodified = getbufvar(1, "&mod")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2648 :echo "todo myvar = " . getbufvar("todo", "myvar")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2649 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2650 getchar([expr]) *getchar()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2651 Get a single character from the user. If it is an 8-bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2652 character, the result is a number. Otherwise a String is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2653 returned with the encoded character. For a special key it's a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2654 sequence of bytes starting with 0x80 (decimal: 128).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2655 If [expr] is omitted, wait until a character is available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2656 If [expr] is 0, only get a character when one is available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2657 If [expr] is 1, only check if a character is available, it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2658 not consumed. If a normal character is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2659 available, it is returned, otherwise a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2660 non-zero value is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2661 If a normal character available, it is returned as a Number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2662 Use nr2char() to convert it to a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2663 The returned value is zero if no character is available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2664 The returned value is a string of characters for special keys
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2665 and when a modifier (shift, control, alt) was used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2666 There is no prompt, you will somehow have to make clear to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2667 user that a character has to be typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2668 There is no mapping for the character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2669 Key codes are replaced, thus when the user presses the <Del>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2670 key you get the code for the <Del> key, not the raw character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2671 sequence. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2672 getchar() == "\<Del>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2673 getchar() == "\<S-Left>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2674 < This example redefines "f" to ignore case: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2675 :nmap f :call FindChar()<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2676 :function FindChar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2677 : let c = nr2char(getchar())
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2678 : while col('.') < col('$') - 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2679 : normal l
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2680 : if getline('.')[col('.') - 1] ==? c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2681 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2682 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2683 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2684 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2685
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2686 getcharmod() *getcharmod()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2687 The result is a Number which is the state of the modifiers for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2688 the last obtained character with getchar() or in another way.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2689 These values are added together:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2690 2 shift
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2691 4 control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2692 8 alt (meta)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2693 16 mouse double click
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2694 32 mouse triple click
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2695 64 mouse quadruple click
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2696 128 Macintosh only: command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2697 Only the modifiers that have not been included in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2698 character itself are obtained. Thus Shift-a results in "A"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2699 with no modifier.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2700
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2701 getcmdline() *getcmdline()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2702 Return the current command-line. Only works when the command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2703 line is being edited, thus requires use of |c_CTRL-\_e| or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2704 |c_CTRL-R_=|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2705 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2706 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2707 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2708
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
2709 getcmdpos() *getcmdpos()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2710 Return the position of the cursor in the command line as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2711 byte count. The first column is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2712 Only works when editing the command line, thus requires use of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2713 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2714 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2715
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2716 getcmdtype() *getcmdtype()*
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2717 Return the current command-line type. Possible return values
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2718 are:
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2719 : normal Ex command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2720 > debug mode command |debug-mode|
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2721 / forward search command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2722 ? backward search command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2723 @ |input()| command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
2724 - |:insert| or |:append| command
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2725 Only works when editing the command line, thus requires use of
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2726 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2727 otherwise.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2728 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2729
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2730 *getcwd()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2731 getcwd() The result is a String, which is the name of the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2732 working directory.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2733
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2734 getfsize({fname}) *getfsize()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2735 The result is a Number, which is the size in bytes of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2736 given file {fname}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2737 If {fname} is a directory, 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2738 If the file {fname} can't be found, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2739
37
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2740 getfontname([{name}]) *getfontname()*
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2741 Without an argument returns the name of the normal font being
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2742 used. Like what is used for the Normal highlight group
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2743 |hl-Normal|.
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2744 With an argument a check is done whether {name} is a valid
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2745 font name. If not then an empty string is returned.
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2746 Otherwise the actual font name is returned, or {name} if the
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2747 GUI does not support obtaining the real name.
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
2748 Only works when the GUI is running, thus not in your vimrc or
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
2749 gvimrc file. Use the |GUIEnter| autocommand to use this
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
2750 function just after the GUI has started.
37
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2751 Note that the GTK 2 GUI accepts any font name, thus checking
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2752 for a valid name does not work.
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
2753
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2754 getfperm({fname}) *getfperm()*
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2755 The result is a String, which is the read, write, and execute
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2756 permissions of the given file {fname}.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2757 If {fname} does not exist or its directory cannot be read, an
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2758 empty string is returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2759 The result is of the form "rwxrwxrwx", where each group of
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2760 "rwx" flags represent, in turn, the permissions of the owner
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2761 of the file, the group the file belongs to, and other users.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2762 If a user does not have a given permission the flag for this
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2763 is replaced with the string "-". Example: >
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2764 :echo getfperm("/etc/passwd")
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2765 < This will hopefully (from a security point of view) display
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2766 the string "rw-r--r--" or even "rw-------".
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
2767
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2768 getftime({fname}) *getftime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2769 The result is a Number, which is the last modification time of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2770 the given file {fname}. The value is measured as seconds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2771 since 1st Jan 1970, and may be passed to strftime(). See also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2772 |localtime()| and |strftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2773 If the file {fname} can't be found -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2774
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2775 getftype({fname}) *getftype()*
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2776 The result is a String, which is a description of the kind of
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2777 file of the given file {fname}.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2778 If {fname} does not exist an empty string is returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2779 Here is a table over different kinds of files and their
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2780 results:
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2781 Normal file "file"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2782 Directory "dir"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2783 Symbolic link "link"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2784 Block device "bdev"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2785 Character device "cdev"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2786 Socket "socket"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2787 FIFO "fifo"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2788 All other "other"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2789 Example: >
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2790 getftype("/home")
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2791 < Note that a type such as "link" will only be returned on
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2792 systems that support it. On some systems only "dir" and
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2793 "file" are returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
2794
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2795 *getline()*
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2796 getline({lnum} [, {end}])
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2797 Without {end} the result is a String, which is line {lnum}
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2798 from the current buffer. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2799 getline(1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2800 < When {lnum} is a String that doesn't start with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2801 digit, line() is called to translate the String into a Number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2802 To get the line under the cursor: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2803 getline(".")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2804 < When {lnum} is smaller than 1 or bigger than the number of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2805 lines in the buffer, an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2806
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2807 When {end} is given the result is a |List| where each item is
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2808 a line from the current buffer in the range {lnum} to {end},
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2809 including line {end}.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2810 {end} is used in the same way as {lnum}.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2811 Non-existing lines are silently omitted.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2812 When {end} is before {lnum} an empty |List| is returned.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2813 Example: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2814 :let start = line('.')
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2815 :let end = search("^$") - 1
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2816 :let lines = getline(start, end)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2817
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
2818 getloclist({nr}) *getloclist()*
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
2819 Returns a list with all the entries in the location list for
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
2820 window {nr}. When {nr} is zero the current window is used.
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
2821 For a location list window, the displayed location list is
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
2822 returned. For an invalid window number {nr}, an empty list is
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
2823 returned. Otherwise, same as getqflist().
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2824
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2825 getqflist() *getqflist()*
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2826 Returns a list with all the current quickfix errors. Each
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2827 list item is a dictionary with these entries:
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2828 bufnr number of buffer that has the file name, use
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2829 bufname() to get the name
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2830 lnum line number in the buffer (first line is 1)
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2831 col column number (first column is 1)
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
2832 vcol non-zero: "col" is visual column
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
2833 zero: "col" is byte index
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2834 nr error number
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2835 text description of the error
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2836 type type of the error, 'E', '1', etc.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2837 valid non-zero: recognized error message
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2838
515
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 504
diff changeset
2839 When there is no error list or it's empty an empty list is
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 504
diff changeset
2840 returned.
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 504
diff changeset
2841
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2842 Useful application: Find pattern matches in multiple files and
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2843 do something with them: >
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2844 :vimgrep /theword/jg *.c
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2845 :for d in getqflist()
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2846 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2847 :endfor
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2848
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
2849
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
2850 getreg([{regname} [, 1]]) *getreg()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2851 The result is a String, which is the contents of register
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
2852 {regname}. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2853 :let cliptext = getreg('*')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2854 < getreg('=') returns the last evaluated value of the expression
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
2855 register. (For use in maps.)
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
2856 getreg('=', 1) returns the expression itself, so that it can
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
2857 be restored with |setreg()|. For other registers the extra
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
2858 argument is ignored, thus you can always give it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2859 If {regname} is not specified, |v:register| is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2860
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2861
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2862 getregtype([{regname}]) *getregtype()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2863 The result is a String, which is type of register {regname}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2864 The value will be one of:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2865 "v" for |characterwise| text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2866 "V" for |linewise| text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2867 "<CTRL-V>{width}" for |blockwise-visual| text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2868 0 for an empty or unknown register
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2869 <CTRL-V> is one character with value 0x16.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2870 If {regname} is not specified, |v:register| is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2871
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2872 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2873 Get the value of an option or local window variable {varname}
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2874 in window {winnr} in tab page {tabnr}.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2875 Tabs are numbered starting with one. For the current tabpage
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2876 use |getwinvar()|.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2877 When {winnr} is zero the current window is used.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2878 This also works for a global option, buffer-local option and
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2879 window-local option, but it doesn't work for a global variable
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2880 or buffer-local variable.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2881 Note that the name without "w:" must be used.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2882 Examples: >
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2883 :let list_is_on = gettabwinvar(1, 2, '&list')
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2884 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2885
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2886 *getwinposx()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2887 getwinposx() The result is a Number, which is the X coordinate in pixels of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2888 the left hand side of the GUI Vim window. The result will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2889 -1 if the information is not available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2890
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2891 *getwinposy()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2892 getwinposy() The result is a Number, which is the Y coordinate in pixels of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2893 the top of the GUI Vim window. The result will be -1 if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2894 information is not available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2895
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2896 getwinvar({winnr}, {varname}) *getwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2897 Like |gettabwinvar()| for the current tabpage.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2898 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2899 :let list_is_on = getwinvar(2, '&list')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2900 :echo "myvar = " . getwinvar(1, 'myvar')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2901 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2902 *glob()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2903 glob({expr}) Expand the file wildcards in {expr}. The result is a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2904 When there are several matches, they are separated by <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2905 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2906 If the expansion fails, the result is an empty string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2907 A name for a non-existing file is not included.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2908
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2909 For most systems backticks can be used to get files names from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2910 any external command. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2911 :let tagfiles = glob("`find . -name tags -print`")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2912 :let &tags = substitute(tagfiles, "\n", ",", "g")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2913 < The result of the program inside the backticks should be one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2914 item per line. Spaces inside an item are allowed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2915
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2916 See |expand()| for expanding special Vim variables. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2917 |system()| for getting the raw output of an external command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2919 globpath({path}, {expr}) *globpath()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2920 Perform glob() on all directories in {path} and concatenate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2921 the results. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2922 :echo globpath(&rtp, "syntax/c.vim")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2923 < {path} is a comma-separated list of directory names. Each
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2924 directory name is prepended to {expr} and expanded like with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2925 glob(). A path separator is inserted when needed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2926 To add a comma inside a directory name escape it with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2927 backslash. Note that on MS-Windows a directory may have a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2928 trailing backslash, remove it if you put a comma after it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2929 If the expansion fails for one of the directories, there is no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2930 error message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2931 The 'wildignore' option applies: Names matching one of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2932 patterns in 'wildignore' will be skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2933
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2934 The "**" item can be used to search in a directory tree.
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2935 For example, to find all "README.txt" files in the directories
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2936 in 'runtimepath' and below: >
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2937 :echo globpath(&rtp, "**/README.txt")
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
2938 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2939 *has()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2940 has({feature}) The result is a Number, which is 1 if the feature {feature} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2941 supported, zero otherwise. The {feature} argument is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2942 string. See |feature-list| below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2943 Also see |exists()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2944
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2945
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2946 has_key({dict}, {key}) *has_key()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2947 The result is a Number, which is 1 if |Dictionary| {dict} has
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2948 an entry with key {key}. Zero otherwise.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2949
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2950
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
2951 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2952 The result is a Number, which is 1 if there is a mapping that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2953 contains {what} in somewhere in the rhs (what it is mapped to)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2954 and this mapping exists in one of the modes indicated by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2955 {mode}.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
2956 When {abbr} is there and it is non-zero use abbreviations
786
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
2957 instead of mappings. Don't forget to specify Insert and/or
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
2958 Command-line mode.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2959 Both the global mappings and the mappings local to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2960 buffer are checked for a match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2961 If no matching mapping is found 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2962 The following characters are recognized in {mode}:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2963 n Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2964 v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2965 o Operator-pending mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2966 i Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2967 l Language-Argument ("r", "f", "t", etc.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2968 c Command-line mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2969 When {mode} is omitted, "nvo" is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2970
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2971 This function is useful to check if a mapping already exists
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2972 to a function in a Vim script. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2973 :if !hasmapto('\ABCdoit')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2974 : map <Leader>d \ABCdoit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2975 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2976 < This installs the mapping to "\ABCdoit" only if there isn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2977 already a mapping to "\ABCdoit".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2978
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2979 histadd({history}, {item}) *histadd()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2980 Add the String {item} to the history {history} which can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2981 one of: *hist-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2982 "cmd" or ":" command line history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2983 "search" or "/" search pattern history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2984 "expr" or "=" typed expression history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2985 "input" or "@" input line history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2986 If {item} does already exist in the history, it will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2987 shifted to become the newest entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2988 The result is a Number: 1 if the operation was successful,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2989 otherwise 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2990
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2991 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2992 :call histadd("input", strftime("%Y %b %d"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2993 :let date=input("Enter date: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2994 < This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2995
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2996 histdel({history} [, {item}]) *histdel()*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
2997 Clear {history}, i.e. delete all its entries. See |hist-names|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2998 for the possible values of {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2999
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3000 If the parameter {item} is given as String, this is seen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3001 as regular expression. All entries matching that expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3002 will be removed from the history (if there are any).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3003 Upper/lowercase must match, unless "\c" is used |/\c|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3004 If {item} is a Number, it will be interpreted as index, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3005 |:history-indexing|. The respective entry will be removed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3006 if it exists.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3007
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3008 The result is a Number: 1 for a successful operation,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3009 otherwise 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3010
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3011 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3012 Clear expression register history: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3013 :call histdel("expr")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3014 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3015 Remove all entries starting with "*" from the search history: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3016 :call histdel("/", '^\*')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3017 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3018 The following three are equivalent: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3019 :call histdel("search", histnr("search"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3020 :call histdel("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3021 :call histdel("search", '^'.histget("search", -1).'$')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3022 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3023 To delete the last search pattern and use the last-but-one for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3024 the "n" command and 'hlsearch': >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3025 :call histdel("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3026 :let @/ = histget("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3027
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3028 histget({history} [, {index}]) *histget()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3029 The result is a String, the entry with Number {index} from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3030 {history}. See |hist-names| for the possible values of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3031 {history}, and |:history-indexing| for {index}. If there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3032 no such entry, an empty String is returned. When {index} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3033 omitted, the most recent item from the history is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3034
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3035 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3036 Redo the second last search from history. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3037 :execute '/' . histget("search", -2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3038
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3039 < Define an Ex command ":H {num}" that supports re-execution of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3040 the {num}th entry from the output of |:history|. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3041 :command -nargs=1 H execute histget("cmd", 0+<args>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3042 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3043 histnr({history}) *histnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3044 The result is the Number of the current entry in {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3045 See |hist-names| for the possible values of {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3046 If an error occurred, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3047
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3048 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3049 :let inp_index = histnr("expr")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3050 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3051 hlexists({name}) *hlexists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3052 The result is a Number, which is non-zero if a highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3053 called {name} exists. This is when the group has been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3054 defined in some way. Not necessarily when highlighting has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3055 been defined for it, it may also have been used for a syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3056 item.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3057 *highlight_exists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3058 Obsolete name: highlight_exists().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3059
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3060 *hlID()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3061 hlID({name}) The result is a Number, which is the ID of the highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3062 with name {name}. When the highlight group doesn't exist,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3063 zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3064 This can be used to retrieve information about the highlight
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3065 group. For example, to get the background color of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3066 "Comment" group: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3067 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3068 < *highlightID()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3069 Obsolete name: highlightID().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3070
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3071 hostname() *hostname()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3072 The result is a String, which is the name of the machine on
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
3073 which Vim is currently running. Machine names greater than
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3074 256 characters long are truncated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3075
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3076 iconv({expr}, {from}, {to}) *iconv()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3077 The result is a String, which is the text {expr} converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3078 from encoding {from} to encoding {to}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3079 When the conversion fails an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3080 The encoding names are whatever the iconv() library function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3081 can accept, see ":!man 3 iconv".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3082 Most conversions require Vim to be compiled with the |+iconv|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3083 feature. Otherwise only UTF-8 to latin1 conversion and back
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3084 can be done.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3085 This can be used to display messages with special characters,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3086 no matter what 'encoding' is set to. Write the message in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3087 UTF-8 and use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3088 echo iconv(utf8_str, "utf-8", &enc)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3089 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3090 from/to UCS-2 is automatically changed to use UTF-8. You
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3091 cannot use UCS-2 in a string anyway, because of the NUL bytes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3092 {only available when compiled with the +multi_byte feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3093
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3094 *indent()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3095 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3096 current buffer. The indent is counted in spaces, the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3097 of 'tabstop' is relevant. {lnum} is used just like in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3098 |getline()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3099 When {lnum} is invalid -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3100
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3101
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3102 index({list}, {expr} [, {start} [, {ic}]]) *index()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3103 Return the lowest index in |List| {list} where the item has a
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3104 value equal to {expr}.
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
3105 If {start} is given then start looking at the item with index
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
3106 {start} (may be negative for an item relative to the end).
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3107 When {ic} is given and it is non-zero, ignore case. Otherwise
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3108 case must match.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3109 -1 is returned when {expr} is not found in {list}.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3110 Example: >
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3111 :let idx = index(words, "the")
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3112 :if index(numbers, 123) >= 0
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3113
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3114
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3115 input({prompt} [, {text} [, {completion}]]) *input()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3116 The result is a String, which is whatever the user typed on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3117 the command-line. The parameter is either a prompt string, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3118 a blank string (for no prompt). A '\n' can be used in the
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3119 prompt to start a new line.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3120 The highlighting set with |:echohl| is used for the prompt.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3121 The input is entered just like a command-line, with the same
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3122 editing commands and mappings. There is a separate history
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3123 for lines typed for input().
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3124 Example: >
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3125 :if input("Coffee or beer? ") == "beer"
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3126 : echo "Cheers!"
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3127 :endif
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3128 <
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
3129 If the optional {text} is present and not empty, this is used
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
3130 for the default reply, as if the user typed this. Example: >
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3131 :let color = input("Color? ", "white")
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3132
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3133 < The optional {completion} argument specifies the type of
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3134 completion supported for the input. Without it completion is
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3135 not performed. The supported completion types are the same as
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3136 that can be supplied to a user-defined command using the
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3137 "-complete=" argument. Refer to |:command-completion| for
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3138 more information. Example: >
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3139 let fname = input("File: ", "", "file")
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3140 <
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3141 NOTE: This function must not be used in a startup file, for
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3142 the versions that only run in GUI mode (e.g., the Win32 GUI).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3143 Note: When input() is called from within a mapping it will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3144 consume remaining characters from that mapping, because a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3145 mapping is handled like the characters were typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3146 Use |inputsave()| before input() and |inputrestore()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3147 after input() to avoid that. Another solution is to avoid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3148 that further characters follow in the mapping, e.g., by using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3149 |:execute| or |:normal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3150
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3151 Example with a mapping: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3152 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3153 :function GetFoo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3154 : call inputsave()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3155 : let g:Foo = input("enter search pattern: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3156 : call inputrestore()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3157 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3158
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3159 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3160 Like input(), but when the GUI is running and text dialogs are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3161 supported, a dialog window pops up to input the text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3162 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3163 :let n = inputdialog("value for shiftwidth", &sw)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3164 :if n != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3165 : let &sw = n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3166 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3167 < When the dialog is cancelled {cancelreturn} is returned. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3168 omitted an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3169 Hitting <Enter> works like pressing the OK button. Hitting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3170 <Esc> works like pressing the Cancel button.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3171 NOTE: Command-line completion is not supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3172
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3173 inputlist({textlist}) *inputlist()*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3174 {textlist} must be a |List| of strings. This |List| is
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3175 displayed, one string per line. The user will be prompted to
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3176 enter a number, which is returned.
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3177 The user can also select an item by clicking on it with the
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3178 mouse. For the first string 0 is returned. When clicking
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3179 above the first item a negative number is returned. When
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3180 clicking on the prompt one more than the length of {textlist}
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3181 is returned.
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3182 Make sure {textlist} has less then 'lines' entries, otherwise
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3183 it won't work. It's a good idea to put the entry number at
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3184 the start of the string. Example: >
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3185 let color = inputlist(['Select color:', '1. red',
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3186 \ '2. green', '3. blue'])
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
3187
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3188 inputrestore() *inputrestore()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3189 Restore typeahead that was saved with a previous inputsave().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3190 Should be called the same number of times inputsave() is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3191 called. Calling it more often is harmless though.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3192 Returns 1 when there is nothing to restore, 0 otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3193
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3194 inputsave() *inputsave()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3195 Preserve typeahead (also from mappings) and clear it, so that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3196 a following prompt gets input from the user. Should be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3197 followed by a matching inputrestore() after the prompt. Can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3198 be used several times, in which case there must be just as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3199 many inputrestore() calls.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3200 Returns 1 when out of memory, 0 otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3201
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3202 inputsecret({prompt} [, {text}]) *inputsecret()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3203 This function acts much like the |input()| function with but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3204 two exceptions:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3205 a) the user's response will be displayed as a sequence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3206 asterisks ("*") thereby keeping the entry secret, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3207 b) the user's response will not be recorded on the input
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3208 |history| stack.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3209 The result is a String, which is whatever the user actually
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3210 typed on the command-line in response to the issued prompt.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
3211 NOTE: Command-line completion is not supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3212
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3213 insert({list}, {item} [, {idx}]) *insert()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3214 Insert {item} at the start of |List| {list}.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3215 If {idx} is specified insert {item} before the item with index
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3216 {idx}. If {idx} is zero it goes before the first item, just
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3217 like omitting {idx}. A negative {idx} is also possible, see
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3218 |list-index|. -1 inserts just before the last item.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3219 Returns the resulting |List|. Examples: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3220 :let mylist = insert([2, 3, 5], 1)
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3221 :call insert(mylist, 4, -1)
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3222 :call insert(mylist, 6, len(mylist))
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
3223 < The last example can be done simpler with |add()|.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3224 Note that when {item} is a |List| it is inserted as a single
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3225 item. Use |extend()| to concatenate |Lists|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3226
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3227 isdirectory({directory}) *isdirectory()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3228 The result is a Number, which is non-zero when a directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3229 with the name {directory} exists. If {directory} doesn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3230 exist, or isn't a directory, the result is FALSE. {directory}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3231 is any expression, which is used as a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3232
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3233 islocked({expr}) *islocked()* *E786*
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3234 The result is a Number, which is non-zero when {expr} is the
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3235 name of a locked variable.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3236 {expr} must be the name of a variable, |List| item or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3237 |Dictionary| entry, not the variable itself! Example: >
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3238 :let alist = [0, ['a', 'b'], 2, 3]
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3239 :lockvar 1 alist
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3240 :echo islocked('alist') " 1
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3241 :echo islocked('alist[1]') " 0
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3242
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3243 < When {expr} is a variable that does not exist you get an error
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3244 message. Use |exists()| to check for existance.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
3245
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
3246 items({dict}) *items()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3247 Return a |List| with all the key-value pairs of {dict}. Each
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3248 |List| item is a list with two items: the key of a {dict}
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3249 entry and the value of this entry. The |List| is in arbitrary
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3250 order.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
3251
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3252
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3253 join({list} [, {sep}]) *join()*
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3254 Join the items in {list} together into one String.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3255 When {sep} is specified it is put in between the items. If
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3256 {sep} is omitted a single space is used.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3257 Note that {sep} is not added at the end. You might want to
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3258 add it there too: >
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3259 let lines = join(mylist, "\n") . "\n"
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3260 < String items are used as-is. |Lists| and |Dictionaries| are
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3261 converted into a string like with |string()|.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3262 The opposite function is |split()|.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3263
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3264 keys({dict}) *keys()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3265 Return a |List| with all the keys of {dict}. The |List| is in
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3266 arbitrary order.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3267
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
3268 *len()* *E701*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3269 len({expr}) The result is a Number, which is the length of the argument.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3270 When {expr} is a String or a Number the length in bytes is
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3271 used, as with |strlen()|.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3272 When {expr} is a |List| the number of items in the |List| is
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3273 returned.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3274 When {expr} is a |Dictionary| the number of entries in the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3275 |Dictionary| is returned.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3276 Otherwise an error is given.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3277
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3278 *libcall()* *E364* *E368*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3279 libcall({libname}, {funcname}, {argument})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3280 Call function {funcname} in the run-time library {libname}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3281 with single argument {argument}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3282 This is useful to call functions in a library that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3283 especially made to be used with Vim. Since only one argument
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3284 is possible, calling standard library functions is rather
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3285 limited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3286 The result is the String returned by the function. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3287 function returns NULL, this will appear as an empty string ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3288 to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3289 If the function returns a number, use libcallnr()!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3290 If {argument} is a number, it is passed to the function as an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3291 int; if {argument} is a string, it is passed as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3292 null-terminated string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3293 This function will fail in |restricted-mode|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3294
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3295 libcall() allows you to write your own 'plug-in' extensions to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3296 Vim without having to recompile the program. It is NOT a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3297 means to call system functions! If you try to do so Vim will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3298 very probably crash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3299
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3300 For Win32, the functions you write must be placed in a DLL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3301 and use the normal C calling convention (NOT Pascal which is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3302 used in Windows System DLLs). The function must take exactly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3303 one parameter, either a character pointer or a long integer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3304 and must return a character pointer or NULL. The character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3305 pointer returned must point to memory that will remain valid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3306 after the function has returned (e.g. in static data in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3307 DLL). If it points to allocated memory, that memory will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3308 leak away. Using a static buffer in the function should work,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3309 it's then freed when the DLL is unloaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3311 WARNING: If the function returns a non-valid pointer, Vim may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3312 crash! This also happens if the function returns a number,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3313 because Vim thinks it's a pointer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3314 For Win32 systems, {libname} should be the filename of the DLL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3315 without the ".DLL" suffix. A full path is only required if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3316 the DLL is not in the usual places.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3317 For Unix: When compiling your own plugins, remember that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3318 object code must be compiled as position-independent ('PIC').
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3319 {only in Win32 on some Unix versions, when the |+libcall|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3320 feature is present}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3321 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3322 :echo libcall("libc.so", "getenv", "HOME")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3323 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3324 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3325 *libcallnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3326 libcallnr({libname}, {funcname}, {argument})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3327 Just like libcall(), but used for a function that returns an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3328 int instead of a string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3329 {only in Win32 on some Unix versions, when the |+libcall|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3330 feature is present}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3331 Example (not very useful...): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3332 :call libcallnr("libc.so", "printf", "Hello World!\n")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3333 :call libcallnr("libc.so", "sleep", 10)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3334 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3335 *line()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3336 line({expr}) The result is a Number, which is the line number of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3337 position given with {expr}. The accepted positions are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3338 . the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3339 $ the last line in the current buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3340 'x position of mark x (if the mark is not set, 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3341 returned)
665
21ab9abf0f08 updated for version 7.0196
vimboss
parents: 653
diff changeset
3342 w0 first line visible in current window
21ab9abf0f08 updated for version 7.0196
vimboss
parents: 653
diff changeset
3343 w$ last line visible in current window
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3344 Note that a mark in another file can be used.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3345 To get the column number use |col()|. To get both use
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3346 |getpos()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3347 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3348 line(".") line number of the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3349 line("'t") line number of mark t
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3350 line("'" . marker) line number of mark marker
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3351 < *last-position-jump*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3352 This autocommand jumps to the last known position in a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3353 just after opening it, if the '" mark is set: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3354 :au BufReadPost * if line("'\"") > 0 && line("'\"") <= line("$") | exe "normal g'\"" | endif
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3355
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3356 line2byte({lnum}) *line2byte()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3357 Return the byte count from the start of the buffer for line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3358 {lnum}. This includes the end-of-line character, depending on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3359 the 'fileformat' option for the current buffer. The first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3360 line returns 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3361 This can also be used to get the byte count for the line just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3362 below the last line: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3363 line2byte(line("$") + 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3364 < This is the file size plus one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3365 When {lnum} is invalid, or the |+byte_offset| feature has been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3366 disabled at compile time, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3367 Also see |byte2line()|, |go| and |:goto|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3368
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3369 lispindent({lnum}) *lispindent()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3370 Get the amount of indent for line {lnum} according the lisp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3371 indenting rules, as with 'lisp'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3372 The indent is counted in spaces, the value of 'tabstop' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3373 relevant. {lnum} is used just like in |getline()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3374 When {lnum} is invalid or Vim was not compiled the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3375 |+lispindent| feature, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3376
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3377 localtime() *localtime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3378 Return the current time, measured as seconds since 1st Jan
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3379 1970. See also |strftime()| and |getftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3380
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3381
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3382 map({expr}, {string}) *map()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3383 {expr} must be a |List| or a |Dictionary|.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3384 Replace each item in {expr} with the result of evaluating
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3385 {string}.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3386 Inside {string} |v:val| has the value of the current item.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3387 For a |Dictionary| |v:key| has the key of the current item.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3388 Example: >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3389 :call map(mylist, '"> " . v:val . " <"')
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3390 < This puts "> " before and " <" after each item in "mylist".
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3391
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3392 Note that {string} is the result of an expression and is then
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3393 used as an expression again. Often it is good to use a
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3394 |literal-string| to avoid having to double backslashes. You
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3395 still have to double ' quotes
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3396
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3397 The operation is done in-place. If you want a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3398 |Dictionary| to remain unmodified make a copy first: >
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3399 :let tlist = map(copy(mylist), ' & . "\t"')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3400
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3401 < Returns {expr}, the |List| or |Dictionary| that was filtered.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
3402 When an error is encountered while evaluating {string} no
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
3403 further items in {expr} are processed.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3404
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3405
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3406 maparg({name}[, {mode} [, {abbr}]]) *maparg()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3407 Return the rhs of mapping {name} in mode {mode}. When there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3408 is no mapping for {name}, an empty String is returned.
644
e4fa26ce8769 updated for version 7.0187
vimboss
parents: 634
diff changeset
3409 {mode} can be one of these strings:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3410 "n" Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3411 "v" Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3412 "o" Operator-pending
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3413 "i" Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3414 "c" Cmd-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3415 "l" langmap |language-mapping|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3416 "" Normal, Visual and Operator-pending
644
e4fa26ce8769 updated for version 7.0187
vimboss
parents: 634
diff changeset
3417 When {mode} is omitted, the modes for "" are used.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3418 When {abbr} is there and it is non-zero use abbreviations
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3419 instead of mappings.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3420 The {name} can have special key names, like in the ":map"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3421 command. The returned String has special characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3422 translated like in the output of the ":map" command listing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3423 The mappings local to the current buffer are checked first,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3424 then the global mappings.
626
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
3425 This function can be used to map a key even when it's already
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
3426 mapped, and have it do the original mapping too. Sketch: >
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
3427 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
3428
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3429
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3430 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3431 Check if there is a mapping that matches with {name} in mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3432 {mode}. See |maparg()| for {mode} and special names in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3433 {name}.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3434 When {abbr} is there and it is non-zero use abbreviations
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
3435 instead of mappings.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3436 A match happens with a mapping that starts with {name} and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3437 with a mapping which is equal to the start of {name}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3438
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3439 matches mapping "a" "ab" "abc" ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3440 mapcheck("a") yes yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3441 mapcheck("abc") yes yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3442 mapcheck("ax") yes no no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3443 mapcheck("b") no no no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3444
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3445 The difference with maparg() is that mapcheck() finds a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3446 mapping that matches with {name}, while maparg() only finds a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3447 mapping for {name} exactly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3448 When there is no mapping that starts with {name}, an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3449 String is returned. If there is one, the rhs of that mapping
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3450 is returned. If there are several mappings that start with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3451 {name}, the rhs of one of them is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3452 The mappings local to the current buffer are checked first,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3453 then the global mappings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3454 This function can be used to check if a mapping can be added
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3455 without being ambiguous. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3456 :if mapcheck("_vv") == ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3457 : map _vv :set guifont=7x13<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3458 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3459 < This avoids adding the "_vv" mapping when there already is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3460 mapping for "_v" or for "_vvv".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3461
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
3462 match({expr}, {pat}[, {start}[, {count}]]) *match()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3463 When {expr} is a |List| then this returns the index of the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3464 first item where {pat} matches. Each item is used as a
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
3465 String, |Lists| and |Dictionaries| are used as echoed.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3466 Otherwise, {expr} is used as a String. The result is a
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3467 Number, which gives the index (byte offset) in {expr} where
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3468 {pat} matches.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3469 A match at the first character or |List| item returns zero.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
3470 If there is no match -1 is returned.
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
3471 Example: >
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3472 :echo match("testing", "ing") " results in 4
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
3473 :echo match([1, 'x'], '\a') " results in 1
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3474 < See |string-match| for how {pat} is used.
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3475 *strpbrk()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3476 Vim doesn't have a strpbrk() function. But you can do: >
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3477 :let sepidx = match(line, '[.,;: \t]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3478 < *strcasestr()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3479 Vim doesn't have a strcasestr() function. But you can add
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3480 "\c" to the pattern to ignore case: >
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3481 :let idx = match(haystack, '\cneedle')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3482 <
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3483 If {start} is given, the search starts from byte index
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3484 {start} in a String or item {start} in a |List|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3485 The result, however, is still the index counted from the
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
3486 first character/item. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3487 :echo match("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3488 < result is again "4". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3489 :echo match("testing", "ing", 4)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3490 < result is again "4". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3491 :echo match("testing", "t", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3492 < result is "3".
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3493 For a String, if {start} > 0 then it is like the string starts
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3494 {start} bytes later, thus "^" will match at {start}. Except
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3495 when {count} is given, then it's like matches before the
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3496 {start} byte are ignored (this is a bit complicated to keep it
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3497 backwards compatible).
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3498 For a String, if {start} < 0, it will be set to 0. For a list
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3499 the index is counted from the end.
697
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
3500 If {start} is out of range ({start} > strlen({expr}) for a
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
3501 String or {start} > len({expr}) for a |List|) -1 is returned.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3502
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3503 When {count} is given use the {count}'th match. When a match
697
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
3504 is found in a String the search for the next one starts one
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3505 character further. Thus this example results in 1: >
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3506 echo match("testing", "..", 0, 2)
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3507 < In a |List| the search continues in the next item.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3508 Note that when {count} is added the way {start} works changes,
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3509 see above.
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
3510
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3511 See |pattern| for the patterns that are accepted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3512 The 'ignorecase' option is used to set the ignore-caseness of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3513 the pattern. 'smartcase' is NOT used. The matching is always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3514 done like 'magic' is set and 'cpoptions' is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3515
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3516
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3517 matcharg({nr}) *matcharg()*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3518 Selects the {nr} match item, as set with a |:match|,
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3519 |:2match| or |:3match| command.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3520 Return a |List| with two elements:
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3521 The name of the highlight group used
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3522 The pattern used.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3523 When {nr} is not 1, 2 or 3 returns an empty |List|.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3524 When there is no match item set returns ['', ''].
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3525 This is usef to save and restore a |:match|.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3526
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3527
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
3528 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3529 Same as match(), but return the index of first character after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3530 the match. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3531 :echo matchend("testing", "ing")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3532 < results in "7".
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3533 *strspn()* *strcspn()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3534 Vim doesn't have a strspn() or strcspn() function, but you can
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3535 do it with matchend(): >
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3536 :let span = matchend(line, '[a-zA-Z]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3537 :let span = matchend(line, '[^a-zA-Z]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3538 < Except that -1 is returned when there are no matches.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
3539
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3540 The {start}, if given, has the same meaning as for match(). >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3541 :echo matchend("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3542 < results in "7". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3543 :echo matchend("testing", "ing", 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3544 < result is "-1".
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3545 When {expr} is a |List| the result is equal to match().
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3546
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3547 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3548 Same as match(), but return a |List|. The first item in the
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3549 list is the matched string, same as what matchstr() would
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3550 return. Following items are submatches, like "\1", "\2", etc.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3551 in |:substitute|.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3552 When there is no match an empty list is returned.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3553
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
3554 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3555 Same as match(), but return the matched string. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3556 :echo matchstr("testing", "ing")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3557 < results in "ing".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3558 When there is no match "" is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3559 The {start}, if given, has the same meaning as for match(). >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3560 :echo matchstr("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3561 < results in "ing". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3562 :echo matchstr("testing", "ing", 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3563 < result is "".
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3564 When {expr} is a |List| then the matching item is returned.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3565 The type isn't changed, it's not necessarily a String.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3566
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3567 *max()*
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3568 max({list}) Return the maximum value of all items in {list}.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3569 If {list} is not a list or one of the items in {list} cannot
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3570 be used as a Number this results in an error.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3571 An empty |List| results in zero.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3572
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3573 *min()*
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3574 min({list}) Return the minumum value of all items in {list}.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3575 If {list} is not a list or one of the items in {list} cannot
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3576 be used as a Number this results in an error.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3577 An empty |List| results in zero.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
3578
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3579 *mkdir()* *E749*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3580 mkdir({name} [, {path} [, {prot}]])
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3581 Create directory {name}.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3582 If {path} is "p" then intermediate directories are created as
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3583 necessary. Otherwise it must be "".
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3584 If {prot} is given it is used to set the protection bits of
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3585 the new directory. The default is 0755 (rwxr-xr-x: r/w for
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3586 the user readable for others). Use 0700 to make it unreadable
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3587 for others.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3588 This function is not available in the |sandbox|.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3589 Not available on all systems. To check use: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3590 :if exists("*mkdir")
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3591 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3592 *mode()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3593 mode() Return a string that indicates the current mode:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3594 n Normal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3595 v Visual by character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3596 V Visual by line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3597 CTRL-V Visual blockwise
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3598 s Select by character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3599 S Select by line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3600 CTRL-S Select blockwise
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3601 i Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3602 R Replace
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3603 c Command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3604 r Hit-enter prompt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3605 This is useful in the 'statusline' option. In most other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3606 places it always returns "c" or "n".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3607
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3608 nextnonblank({lnum}) *nextnonblank()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3609 Return the line number of the first line at or below {lnum}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3610 that is not blank. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3611 if getline(nextnonblank(1)) =~ "Java"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3612 < When {lnum} is invalid or there is no non-blank line at or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3613 below it, zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3614 See also |prevnonblank()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3615
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3616 nr2char({expr}) *nr2char()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3617 Return a string with a single character, which has the number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3618 value {expr}. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3619 nr2char(64) returns "@"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3620 nr2char(32) returns " "
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3621 < The current 'encoding' is used. Example for "utf-8": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3622 nr2char(300) returns I with bow character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3623 < Note that a NUL character in the file is specified with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3624 nr2char(10), because NULs are represented with newline
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3625 characters. nr2char(0) is a real NUL and terminates the
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
3626 string, thus results in an empty string.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3627
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3628 *getpos()*
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3629 getpos({expr}) Get the position for {expr}. For possible values of {expr}
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3630 see |line()|.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3631 The result is a |List| with four numbers:
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3632 [bufnum, lnum, col, off]
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3633 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3634 is the buffer number of the mark.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3635 "lnum" and "col" are the position in the buffer. The first
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3636 column is 1.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3637 The "off" number is zero, unless 'virtualedit' is used. Then
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3638 it is the offset in screen columns from the start of the
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3639 character. E.g., a position within a Tab or after the last
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3640 character.
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3641 This can be used to save and restore the cursor position: >
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3642 let save_cursor = getpos(".")
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3643 MoveTheCursorAround
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
3644 call setpos('.', save_cursor)
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3645 < Also see |setpos()|.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3646
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3647 pathshorten({expr}) *pathshorten()*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3648 Shorten directory names in the path {expr} and return the
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3649 result. The tail, the file name, is kept as-is. The other
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3650 components in the path are reduced to single letters. Leading
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3651 '~' and '.' characters are kept. Example: >
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3652 :echo pathshorten('~/.vim/autoload/myfile.vim')
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3653 < ~/.v/a/myfile.vim ~
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3654 It doesn't matter if the path exists or not.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3655
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3656 prevnonblank({lnum}) *prevnonblank()*
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3657 Return the line number of the first line at or above {lnum}
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3658 that is not blank. Example: >
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3659 let ind = indent(prevnonblank(v:lnum - 1))
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3660 < When {lnum} is invalid or there is no non-blank line at or
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3661 above it, zero is returned.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3662 Also see |nextnonblank()|.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3663
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3664
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3665 printf({fmt}, {expr1} ...) *printf()*
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3666 Return a String with {fmt}, where "%" items are replaced by
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3667 the formatted form of their respective arguments. Example: >
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3668 printf("%4d: E%d %.30s", lnum, errno, msg)
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3669 < May result in:
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3670 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3671
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3672 Often used items are:
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3673 %s string
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3674 %6s string right-aligned in 6 bytes
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3675 %.9s string truncated to 9 bytes
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3676 %c single byte
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3677 %d decimal number
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3678 %5d decimal number padded with spaces to 5 characters
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3679 %x hex number
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3680 %04x hex number padded with zeros to at least 4 characters
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3681 %X hex number using upper case letters
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3682 %o octal number
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3683 %% the % character itself
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3684
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3685 Conversion specifications start with '%' and end with the
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3686 conversion type. All other characters are copied unchanged to
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3687 the result.
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3688
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3689 The "%" starts a conversion specification. The following
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3690 arguments appear in sequence:
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3691
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3692 % [flags] [field-width] [.precision] type
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3693
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3694 flags
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3695 Zero or more of the following flags:
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3696
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3697 # The value should be converted to an "alternate
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3698 form". For c, d, and s conversions, this option
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3699 has no effect. For o conversions, the precision
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3700 of the number is increased to force the first
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3701 character of the output string to a zero (except
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3702 if a zero value is printed with an explicit
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3703 precision of zero).
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3704 For x and X conversions, a non-zero result has
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3705 the string "0x" (or "0X" for X conversions)
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3706 prepended to it.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3707
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3708 0 (zero) Zero padding. For all conversions the converted
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3709 value is padded on the left with zeros rather
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3710 than blanks. If a precision is given with a
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3711 numeric conversion (d, o, x, and X), the 0 flag
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3712 is ignored.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3713
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3714 - A negative field width flag; the converted value
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3715 is to be left adjusted on the field boundary.
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3716 The converted value is padded on the right with
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3717 blanks, rather than on the left with blanks or
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3718 zeros. A - overrides a 0 if both are given.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3719
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3720 ' ' (space) A blank should be left before a positive
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3721 number produced by a signed conversion (d).
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3722
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3723 + A sign must always be placed before a number
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3724 produced by a signed conversion. A + overrides
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3725 a space if both are used.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3726
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3727 field-width
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3728 An optional decimal digit string specifying a minimum
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3729 field width. If the converted value has fewer bytes
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3730 than the field width, it will be padded with spaces on
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3731 the left (or right, if the left-adjustment flag has
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3732 been given) to fill out the field width.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3733
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3734 .precision
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3735 An optional precision, in the form of a period '.'
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3736 followed by an optional digit string. If the digit
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3737 string is omitted, the precision is taken as zero.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3738 This gives the minimum number of digits to appear for
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3739 d, o, x, and X conversions, or the maximum number of
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
3740 bytes to be printed from a string for s conversions.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3741
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3742 type
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3743 A character that specifies the type of conversion to
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3744 be applied, see below.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3745
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3746 A field width or precision, or both, may be indicated by an
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3747 asterisk '*' instead of a digit string. In this case, a
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3748 Number argument supplies the field width or precision. A
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3749 negative field width is treated as a left adjustment flag
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3750 followed by a positive field width; a negative precision is
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3751 treated as though it were missing. Example: >
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3752 :echo printf("%d: %.*s", nr, width, line)
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3753 < This limits the length of the text used from "line" to
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3754 "width" bytes.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3755
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3756 The conversion specifiers and their meanings are:
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3757
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3758 doxX The Number argument is converted to signed decimal
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3759 (d), unsigned octal (o), or unsigned hexadecimal (x
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3760 and X) notation. The letters "abcdef" are used for
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3761 x conversions; the letters "ABCDEF" are used for X
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3762 conversions.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3763 The precision, if any, gives the minimum number of
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3764 digits that must appear; if the converted value
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3765 requires fewer digits, it is padded on the left with
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3766 zeros.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3767 In no case does a non-existent or small field width
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3768 cause truncation of a numeric field; if the result of
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3769 a conversion is wider than the field width, the field
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3770 is expanded to contain the conversion result.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3771
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3772 c The Number argument is converted to a byte, and the
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3773 resulting character is written.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3774
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3775 s The text of the String argument is used. If a
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3776 precision is specified, no more bytes than the number
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3777 specified are used.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3778
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3779 % A '%' is written. No argument is converted. The
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3780 complete conversion specification is "%%".
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3781
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3782 Each argument can be Number or String and is converted
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3783 automatically to fit the conversion specifier. Any other
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3784 argument type results in an error message.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3785
459
d9d38102399f updated for version 7.0122
vimboss
parents: 452
diff changeset
3786 *E766* *E767*
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3787 The number of {exprN} arguments must exactly match the number
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3788 of "%" items. If there are not sufficient or too many
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
3789 arguments an error is given. Up to 18 arguments can be used.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3790
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
3791
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3792 pumvisible() *pumvisible()*
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3793 Returns non-zero when the popup menu is visible, zero
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3794 otherwise. See |ins-completion-menu|.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
3795 This can be used to avoid some things that would remove the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
3796 popup menu.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3797
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
3798 *E726* *E727*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3799 range({expr} [, {max} [, {stride}]]) *range()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3800 Returns a |List| with Numbers:
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3801 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3802 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3803 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3804 {max}] (increasing {expr} with {stride} each time, not
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3805 producing a value past {max}).
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
3806 When the maximum is one before the start the result is an
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
3807 empty list. When the maximum is more than one before the
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
3808 start this is an error.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3809 Examples: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3810 range(4) " [0, 1, 2, 3]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3811 range(2, 4) " [2, 3, 4]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3812 range(2, 9, 3) " [2, 5, 8]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3813 range(2, -2, -1) " [2, 1, 0, -1, -2]
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
3814 range(0) " []
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
3815 range(2, 0) " error!
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3816 <
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3817 *readfile()*
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3818 readfile({fname} [, {binary} [, {max}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3819 Read file {fname} and return a |List|, each line of the file
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3820 as an item. Lines broken at NL characters. Macintosh files
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3821 separated with CR will result in a single long line (unless a
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3822 NL appears somewhere).
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3823 When {binary} is equal to "b" binary mode is used:
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3824 - When the last line ends in a NL an extra empty list item is
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3825 added.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3826 - No CR characters are removed.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3827 Otherwise:
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3828 - CR characters that appear before a NL are removed.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3829 - Whether the last line ends in a NL or not does not matter.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3830 All NUL characters are replaced with a NL character.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3831 When {max} is given this specifies the maximum number of lines
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3832 to be read. Useful if you only want to check the first ten
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3833 lines of a file: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3834 :for line in readfile(fname, '', 10)
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3835 : if line =~ 'Date' | echo line | endif
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3836 :endfor
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
3837 < When {max} is negative -{max} lines from the end of the file
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
3838 are returned, or as many as there are.
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
3839 When {max} is zero the result is an empty list.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3840 Note that without {max} the whole file is read into memory.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3841 Also note that there is no recognition of encoding. Read a
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
3842 file into a buffer if you need to.
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3843 When the file can't be opened an error message is given and
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3844 the result is an empty list.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3845 Also see |writefile()|.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
3846
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3847 reltime([{start} [, {end}]]) *reltime()*
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3848 Return an item that represents a time value. The format of
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3849 the item depends on the system. It can be passed to
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3850 |reltimestr()| to convert it to a string.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3851 Without an argument it returns the current time.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3852 With one argument is returns the time passed since the time
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3853 specified in the argument.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3854 With two arguments it returns the time passed betweein {start}
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3855 and {end}.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3856 The {start} and {end} arguments must be values returned by
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3857 reltime().
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3858 {only available when compiled with the +reltime feature}
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3859
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3860 reltimestr({time}) *reltimestr()*
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3861 Return a String that represents the time value of {time}.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3862 This is the number of seconds, a dot and the number of
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3863 microseconds. Example: >
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3864 let start = reltime()
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3865 call MyFunction()
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3866 echo reltimestr(reltime(start))
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3867 < Note that overhead for the commands will be added to the time.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3868 The accuracy depends on the system.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3869 Also see |profiling|.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3870 {only available when compiled with the +reltime feature}
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
3871
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3872 *remote_expr()* *E449*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3873 remote_expr({server}, {string} [, {idvar}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3874 Send the {string} to {server}. The string is sent as an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3875 expression and the result is returned after evaluation.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
3876 The result must be a String or a |List|. A |List| is turned
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
3877 into a String by joining the items with a line break in
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
3878 between (not at the end), like with join(expr, "\n").
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3879 If {idvar} is present, it is taken as the name of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3880 variable and a {serverid} for later use with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3881 remote_read() is stored there.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3882 See also |clientserver| |RemoteReply|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3883 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3884 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3885 Note: Any errors will cause a local error message to be issued
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3886 and the result will be the empty string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3887 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3888 :echo remote_expr("gvim", "2+2")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3889 :echo remote_expr("gvim1", "b:current_syntax")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3890 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3891
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3892 remote_foreground({server}) *remote_foreground()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3893 Move the Vim server with the name {server} to the foreground.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3894 This works like: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3895 remote_expr({server}, "foreground()")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3896 < Except that on Win32 systems the client does the work, to work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3897 around the problem that the OS doesn't always allow the server
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3898 to bring itself to the foreground.
574
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
3899 Note: This does not restore the window if it was minimized,
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
3900 like foreground() does.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3901 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3902 {only in the Win32, Athena, Motif and GTK GUI versions and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3903 Win32 console version}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3904
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3905
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3906 remote_peek({serverid} [, {retvar}]) *remote_peek()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3907 Returns a positive number if there are available strings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3908 from {serverid}. Copies any reply string into the variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3909 {retvar} if specified. {retvar} must be a string with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3910 name of a variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3911 Returns zero if none are available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3912 Returns -1 if something is wrong.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3913 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3914 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3915 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3916 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3917 :let repl = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3918 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3919
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3920 remote_read({serverid}) *remote_read()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3921 Return the oldest available reply from {serverid} and consume
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3922 it. It blocks until a reply is available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3923 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3924 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3925 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3926 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3927 :echo remote_read(id)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3928 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3929 *remote_send()* *E241*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3930 remote_send({server}, {string} [, {idvar}])
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
3931 Send the {string} to {server}. The string is sent as input
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
3932 keys and the function returns immediately. At the Vim server
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
3933 the keys are not mapped |:map|.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3934 If {idvar} is present, it is taken as the name of a variable
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3935 and a {serverid} for later use with remote_read() is stored
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
3936 there.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3937 See also |clientserver| |RemoteReply|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3938 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3939 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3940 Note: Any errors will be reported in the server and may mess
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3941 up the display.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3942 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3943 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3944 \ remote_read(serverid)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3945
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3946 :autocmd NONE RemoteReply *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3947 \ echo remote_read(expand("<amatch>"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3948 :echo remote_send("gvim", ":sleep 10 | echo ".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3949 \ 'server2client(expand("<client>"), "HELLO")<CR>')
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
3950 <
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3951 remove({list}, {idx} [, {end}]) *remove()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3952 Without {end}: Remove the item at {idx} from |List| {list} and
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3953 return it.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3954 With {end}: Remove items from {idx} to {end} (inclusive) and
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3955 return a list with these items. When {idx} points to the same
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3956 item as {end} a list with one item is returned. When {end}
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3957 points to an item before {idx} this is an error.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3958 See |list-index| for possible values of {idx} and {end}.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3959 Example: >
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3960 :echo "last item: " . remove(mylist, -1)
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3961 :call remove(mylist, 0, 9)
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3962 remove({dict}, {key})
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3963 Remove the entry from {dict} with key {key}. Example: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3964 :echo "removed " . remove(dict, "one")
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3965 < If there is no {key} in {dict} this is an error.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3966
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
3967 Use |delete()| to remove a file.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3968
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3969 rename({from}, {to}) *rename()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3970 Rename the file by the name {from} to the name {to}. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3971 should also work to move files across file systems. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3972 result is a Number, which is 0 if the file was renamed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3973 successfully, and non-zero when the renaming failed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3974 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3975
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3976 repeat({expr}, {count}) *repeat()*
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3977 Repeat {expr} {count} times and return the concatenated
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3978 result. Example: >
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3979 :let seperator = repeat('-', 80)
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3980 < When {count} is zero or negative the result is empty.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3981 When {expr} is a |List| the result is {expr} concatenated
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
3982 {count} times. Example: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3983 :let longlist = repeat(['a', 'b'], 3)
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3984 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3985
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
3986
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3987 resolve({filename}) *resolve()* *E655*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3988 On MS-Windows, when {filename} is a shortcut (a .lnk file),
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3989 returns the path the shortcut points to in a simplified form.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3990 On Unix, repeat resolving symbolic links in all path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3991 components of {filename} and return the simplified result.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3992 To cope with link cycles, resolving of symbolic links is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3993 stopped after 100 iterations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3994 On other systems, return the simplified {filename}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3995 The simplification step is done as by |simplify()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3996 resolve() keeps a leading path component specifying the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3997 current directory (provided the result is still a relative
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3998 path name) and also keeps a trailing path separator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3999
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4000 *reverse()*
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4001 reverse({list}) Reverse the order of items in {list} in-place. Returns
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4002 {list}.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4003 If you want a list to remain unmodified make a copy first: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4004 :let revlist = reverse(copy(mylist))
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4005
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4006 search({pattern} [, {flags} [, {stopline}]]) *search()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4007 Search for regexp pattern {pattern}. The search starts at the
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
4008 cursor position (you can use |cursor()| to set it).
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4009
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4010 {flags} is a String, which can contain these character flags:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4011 'b' search backward instead of forward
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4012 'c' accept a match at the cursor position
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4013 'e' move to the End of the match
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4014 'n' do Not move the cursor
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4015 'p' return number of matching sub-pattern (see below)
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4016 's' set the ' mark at the previous location of the cursor
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4017 'w' wrap around the end of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4018 'W' don't wrap around the end of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4019 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4020
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4021 If the 's' flag is supplied, the ' mark is set, only if the
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4022 cursor is moved. The 's' flag cannot be combined with the 'n'
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4023 flag.
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4024
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4025 When the {stopline} argument is given then the search stops
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4026 after searching this line. This is useful to restrict the
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4027 search to a range of lines. Examples: >
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4028 let match = search('(', 'b', line("w0"))
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4029 let end = search('END', '', line("w$"))
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4030 < When {stopline} is used and it is not zero this also implies
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4031 that the search does not wrap around the end of the file.
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4032
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4033 If there is no match a 0 is returned and the cursor doesn't
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4034 move. No error message is given.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4035 When a match has been found its line number is returned.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4036 *search()-sub-match*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4037 With the 'p' flag the returned value is one more than the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4038 first sub-match in \(\). One if none of them matched but the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4039 whole pattern did match.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4040 To get the column number too use |searchpos()|.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4041
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4042 The cursor will be positioned at the match, unless the 'n'
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4043 flag is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4044
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4045 Example (goes over all files in the argument list): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4046 :let n = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4047 :while n <= argc() " loop over all files in arglist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4048 : exe "argument " . n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4049 : " start at the last char in the file and wrap for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4050 : " first search to find match at start of file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4051 : normal G$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4052 : let flags = "w"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4053 : while search("foo", flags) > 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4054 : s/foo/bar/g
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4055 : let flags = "W"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4056 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4057 : update " write the file if modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4058 : let n = n + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4059 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4060 <
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4061 Example for using some flags: >
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4062 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4063 < This will search for the keywords "if", "else", and "endif"
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4064 under or after the cursor. Because of the 'p' flag, it
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4065 returns 1, 2, or 3 depending on which keyword is found, or 0
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4066 if the search fails. With the cursor on the first word of the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4067 line:
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4068 if (foo == 0) | let foo = foo + 1 | endif ~
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4069 the function returns 1. Without the 'c' flag, the function
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4070 finds the "endif" and returns 3. The same thing happens
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4071 without the 'e' flag if the cursor is on the "f" of "if".
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4072 The 'n' flag tells the function not to move the cursor.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4073
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4074
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4075 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4076 Search for the declaration of {name}.
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4077
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4078 With a non-zero {global} argument it works like |gD|, find
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4079 first match in the file. Otherwise it works like |gd|, find
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4080 first match in the function.
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4081
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4082 With a non-zero {thisblock} argument matches in a {} block
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4083 that ends before the cursor position are ignored. Avoids
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4084 finding variable declarations only valid in another scope.
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
4085
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4086 Moves the cursor to the found match.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4087 Returns zero for success, non-zero for failure.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4088 Example: >
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4089 if searchdecl('myvar') == 0
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4090 echo getline('.')
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4091 endif
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
4092 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4093 *searchpair()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4094 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4095 Search for the match of a nested start-end pair. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4096 used to find the "endif" that matches an "if", while other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4097 if/endif pairs in between are ignored.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4098 The search starts at the cursor. The default is to search
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4099 forward, include 'b' in {flags} to search backward.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4100 If a match is found, the cursor is positioned at it and the
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4101 line number is returned. If no match is found 0 or -1 is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4102 returned and the cursor doesn't move. No error message is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4103 given.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4105 {start}, {middle} and {end} are patterns, see |pattern|. They
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4106 must not contain \( \) pairs. Use of \%( \) is allowed. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4107 {middle} is not empty, it is found when searching from either
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4108 direction, but only when not in a nested start-end pair. A
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4109 typical use is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4110 searchpair('\<if\>', '\<else\>', '\<endif\>')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4111 < By leaving {middle} empty the "else" is skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4112
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4113 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4114 |search()|. Additionally:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4115 'r' Repeat until no more matches found; will find the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4116 outer pair
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4117 'm' return number of Matches instead of line number with
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4118 the match; will be > 1 when 'r' is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4120 When a match for {start}, {middle} or {end} is found, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4121 {skip} expression is evaluated with the cursor positioned on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4122 the start of the match. It should return non-zero if this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4123 match is to be skipped. E.g., because it is inside a comment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4124 or a string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4125 When {skip} is omitted or empty, every match is accepted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4126 When evaluating {skip} causes an error the search is aborted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4127 and -1 returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4128
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4129 For {stopline} see |search()|.
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4130
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4131 The value of 'ignorecase' is used. 'magic' is ignored, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4132 patterns are used like it's on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4133
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4134 The search starts exactly at the cursor. A match with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4135 {start}, {middle} or {end} at the next character, in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4136 direction of searching, is the first one found. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4137 if 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4138 if 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4139 endif 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4140 endif 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4141 < When starting at the "if 2", with the cursor on the "i", and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4142 searching forwards, the "endif 2" is found. When starting on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4143 the character just before the "if 2", the "endif 1" will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4144 found. That's because the "if 2" will be found first, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4145 then this is considered to be a nested if/endif from "if 2" to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4146 "endif 2".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4147 When searching backwards and {end} is more than one character,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4148 it may be useful to put "\zs" at the end of the pattern, so
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4149 that when the cursor is inside a match with the end it finds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4150 the matching start.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4151
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4152 Example, to find the "endif" command in a Vim script: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4153
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4154 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4155 \ 'getline(".") =~ "^\\s*\""')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4156
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4157 < The cursor must be at or after the "if" for which a match is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4158 to be found. Note that single-quote strings are used to avoid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4159 having to double the backslashes. The skip expression only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4160 catches comments at the start of a line, not after a command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4161 Also, a word "en" or "if" halfway a line is considered a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4162 match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4163 Another example, to search for the matching "{" of a "}": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4165 :echo searchpair('{', '', '}', 'bW')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4166
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4167 < This works when the cursor is at or before the "}" for which a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4168 match is to be found. To reject matches that syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4169 highlighting recognized as strings: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4170
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4171 :echo searchpair('{', '', '}', 'bW',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4172 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4173 <
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4174 *searchpairpos()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4175 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4176 Same as searchpair(), but returns a |List| with the line and
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4177 column position of the match. The first element of the |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4178 is the line number and the second element is the byte index of
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4179 the column position of the match. If no match is found,
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4180 returns [0, 0].
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4181 >
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4182 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4183 <
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4184 See |match-parens| for a bigger and more useful example.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
4185
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4186 searchpos({pattern} [, {flags} [, {stopline}]]) *searchpos()*
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4187 Same as |search()|, but returns a |List| with the line and
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4188 column position of the match. The first element of the |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4189 is the line number and the second element is the byte index of
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4190 the column position of the match. If no match is found,
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4191 returns [0, 0].
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4192 Example: >
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4193 :let [lnum, col] = searchpos('mypattern', 'n')
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4194
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4195 < When the 'p' flag is given then there is an extra item with
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4196 the sub-pattern match number |search()-sub-match|. Example: >
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4197 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4198 < In this example "submatch" is 2 when a lowercase letter is
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4199 found |/\l|, 3 when an uppercase letter is found |/\u|.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
4200
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4201 server2client( {clientid}, {string}) *server2client()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4202 Send a reply string to {clientid}. The most recent {clientid}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4203 that sent a string can be retrieved with expand("<client>").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4204 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4205 Note:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4206 This id has to be stored before the next command can be
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4207 received. I.e. before returning from the received command and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4208 before calling any commands that waits for input.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4209 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4210 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4211 :echo server2client(expand("<client>"), "HELLO")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4212 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4213 serverlist() *serverlist()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4214 Return a list of available server names, one per line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4215 When there are no servers or the information is not available
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4216 an empty string is returned. See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4217 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4218 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4219 :echo serverlist()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4220 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4221 setbufvar({expr}, {varname}, {val}) *setbufvar()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4222 Set option or local variable {varname} in buffer {expr} to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4223 {val}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4224 This also works for a global or local window option, but it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4225 doesn't work for a global or local window variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4226 For a local window option the global value is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4227 For the use of {expr}, see |bufname()| above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4228 Note that the variable name without "b:" must be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4229 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4230 :call setbufvar(1, "&mod", 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4231 :call setbufvar("todo", "myvar", "foobar")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4232 < This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4234 setcmdpos({pos}) *setcmdpos()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4235 Set the cursor position in the command line to byte position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4236 {pos}. The first position is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4237 Use |getcmdpos()| to obtain the current position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4238 Only works while editing the command line, thus you must use
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4239 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4240 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4241 set after the command line is set to the expression. For
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4242 |c_CTRL-R_=| it is set after evaluating the expression but
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4243 before inserting the resulting text.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4244 When the number is too big the cursor is put at the end of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4245 line. A number smaller than one has undefined results.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4246 Returns 0 when successful, 1 when not editing the command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4247 line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4248
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4249 setline({lnum}, {line}) *setline()*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4250 Set line {lnum} of the current buffer to {line}.
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4251 {lnum} is used like with |getline()|.
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4252 When {lnum} is just below the last line the {line} will be
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4253 added as a new line.
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4254 If this succeeds, 0 is returned. If this fails (most likely
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4255 because {lnum} is invalid) 1 is returned. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4256 :call setline(5, strftime("%c"))
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4257 < When {line} is a |List| then line {lnum} and following lines
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4258 will be set to the items in the list. Example: >
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4259 :call setline(5, ['aaa', 'bbb', 'ccc'])
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4260 < This is equivalent to: >
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4261 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']]
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4262 : call setline(n, l)
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4263 :endfor
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4264 < Note: The '[ and '] marks are not set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4265
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4266 setloclist({nr}, {list} [, {action}]) *setloclist()*
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4267 Create or replace or add to the location list for window {nr}.
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4268 When {nr} is zero the current window is used. For a location
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4269 list window, the displayed location list is modified. For an
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4270 invalid window number {nr}, -1 is returned.
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4271 Otherwise, same as setqflist().
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4272
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4273 *setpos()*
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4274 setpos({expr}, {list})
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4275 Set the position for {expr}. Possible values:
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4276 . the cursor
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4277 'x mark x
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4278
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4279 {list} must be a |List| with four numbers:
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4280 [bufnum, lnum, col, off]
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4281
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4282 "bufnum" is the buffer number. Zero can be used for the
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4283 current buffer. Setting the cursor is only possible for
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4284 the current buffer. To set a mark in another buffer you can
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4285 use the |bufnr()| function to turn a file name into a buffer
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4286 number.
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
4287 Does not change the jumplist.
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4288
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4289 "lnum" and "col" are the position in the buffer. The first
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4290 column is 1. Use a zero "lnum" to delete a mark.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4291
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4292 The "off" number is only used when 'virtualedit' is set. Then
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4293 it is the offset in screen columns from the start of the
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4294 character. E.g., a position within a Tab or after the last
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4295 character.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4296
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4297 Also see |getpos()|
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4298
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
4299
277
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4300 setqflist({list} [, {action}]) *setqflist()*
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4301 Create or replace or add to the quickfix list using the items
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4302 in {list}. Each item in {list} is a dictionary.
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4303 Non-dictionary items in {list} are ignored. Each dictionary
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4304 item can contain the following entries:
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4305
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4306 filename name of a file
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4307 lnum line number in the file
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4308 pattern search pattern used to locate the error
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4309 col column number
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4310 vcol when non-zero: "col" is visual column
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4311 when zero: "col" is byte index
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4312 nr error number
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4313 text description of the error
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4314 type single-character error type, 'E', 'W', etc.
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4315
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4316 The "col", "vcol", "nr", "type" and "text" entries are
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4317 optional. Either "lnum" or "pattern" entry can be used to
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
4318 locate a matching error line.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4319 If the "filename" entry is not present or neither the "lnum"
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4320 or "pattern" entries are present, then the item will not be
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4321 handled as an error line.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4322 If both "pattern" and "lnum" are present then "pattern" will
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4323 be used.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4324
277
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4325 If {action} is set to 'a', then the items from {list} are
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4326 added to the existing quickfix list. If there is no existing
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4327 list, then a new list is created. If {action} is set to 'r',
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4328 then the items from the current quickfix list are replaced
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4329 with the items from {list}. If {action} is not present or is
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4330 set to ' ', then a new list is created.
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
4331
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4332 Returns zero for success, -1 for failure.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4333
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4334 This function can be used to create a quickfix list
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4335 independent of the 'errorformat' setting. Use a command like
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4336 ":cc 1" to jump to the first position.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4337
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
4338
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4339 *setreg()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4340 setreg({regname}, {value} [,{options}])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4341 Set the register {regname} to {value}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4342 If {options} contains "a" or {regname} is upper case,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4343 then the value is appended.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4344 {options} can also contains a register type specification:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4345 "c" or "v" |characterwise| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4346 "l" or "V" |linewise| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4347 "b" or "<CTRL-V>" |blockwise-visual| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4348 If a number immediately follows "b" or "<CTRL-V>" then this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4349 used as the width of the selection - if it is not specified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4350 then the width of the block is set to the number of characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4351 in the longest line (counting a <TAB> as 1 character).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4352
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4353 If {options} contains no register settings, then the default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4354 is to use character mode unless {value} ends in a <NL>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4355 Setting the '=' register is not possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4356 Returns zero for success, non-zero for failure.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4357
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4358 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4359 :call setreg(v:register, @*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4360 :call setreg('*', @%, 'ac')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4361 :call setreg('a', "1\n2\n3", 'b5')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4363 < This example shows using the functions to save and restore a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4364 register. >
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4365 :let var_a = getreg('a', 1)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4366 :let var_amode = getregtype('a')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4367 ....
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4368 :call setreg('a', var_a, var_amode)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4369
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4370 < You can also change the type of a register by appending
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4371 nothing: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4372 :call setreg('a', '', 'al')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4373
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4374 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4375 Set option or local variable {varname} in window {winnr} to
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4376 {val}.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4377 Tabs are numbered starting with one. For the current tabpage
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4378 use |setwinvar()|.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4379 When {winnr} is zero the current window is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4380 This also works for a global or local buffer option, but it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4381 doesn't work for a global or local buffer variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4382 For a local buffer option the global value is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4383 Note that the variable name without "w:" must be used.
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4384 Vim briefly goes to the tab page {tabnr}, this may trigger
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4385 TabLeave and TabEnter autocommands.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4386 Examples: >
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4387 :call settabwinvar(1, 1, "&list", 0)
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4388 :call settabwinvar(3, 2, "myvar", "foobar")
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4389 < This function is not available in the |sandbox|.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4390
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4391 setwinvar({nr}, {varname}, {val}) *setwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
4392 Like |settabwinvar()| for the current tab page.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4393 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4394 :call setwinvar(1, "&list", 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4395 :call setwinvar(2, "myvar", "foobar")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4396
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4397 simplify({filename}) *simplify()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4398 Simplify the file name as much as possible without changing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4399 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4400 Unix) are not resolved. If the first path component in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4401 {filename} designates the current directory, this will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4402 valid for the result as well. A trailing path separator is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4403 not removed either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4404 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4405 simplify("./dir/.././/file/") == "./file/"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4406 < Note: The combination "dir/.." is only removed if "dir" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4407 a searchable directory or does not exist. On Unix, it is also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4408 removed when "dir" is a symbolic link within the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4409 directory. In order to resolve all the involved symbolic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4410 links before simplifying the path name, use |resolve()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4411
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4412
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
4413 sort({list} [, {func}]) *sort()* *E702*
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4414 Sort the items in {list} in-place. Returns {list}. If you
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4415 want a list to remain unmodified make a copy first: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4416 :let sortedlist = sort(copy(mylist))
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4417 < Uses the string representation of each item to sort on.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4418 Numbers sort after Strings, |Lists| after Numbers.
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4419 For sorting text in the current buffer use |:sort|.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4420 When {func} is given and it is one then case is ignored.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4421 When {func} is a |Funcref| or a function name, this function
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4422 is called to compare items. The function is invoked with two
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4423 items as argument and must return zero if they are equal, 1 if
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4424 the first one sorts after the second one, -1 if the first one
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4425 sorts before the second one. Example: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4426 func MyCompare(i1, i2)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4427 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4428 endfunc
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4429 let sortedlist = sort(mylist, "MyCompare")
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4430 <
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4431
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4432 *soundfold()*
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4433 soundfold({word})
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4434 Return the sound-folded equivalent of {word}. Uses the first
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4435 language in 'spellang' for the current window that supports
375
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
4436 soundfolding. 'spell' must be set. When no sound folding is
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
4437 possible the {word} is returned unmodified.
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4438 This can be used for making spelling suggestions. Note that
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4439 the method can be quite slow.
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
4440
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4441 *spellbadword()*
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4442 spellbadword([{sentence}])
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4443 Without argument: The result is the badly spelled word under
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4444 or after the cursor. The cursor is moved to the start of the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4445 bad word. When no bad word is found in the cursor line the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4446 result is an empty string and the cursor doesn't move.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4447
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4448 With argument: The result is the first word in {sentence} that
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4449 is badly spelled. If there are no spelling mistakes the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4450 result is an empty string.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4451
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4452 The return value is a list with two items:
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4453 - The badly spelled word or an empty string.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4454 - The type of the spelling error:
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4455 "bad" spelling mistake
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4456 "rare" rare word
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4457 "local" word only valid in another region
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4458 "caps" word should start with Capital
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4459 Example: >
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4460 echo spellbadword("the quik brown fox")
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4461 < ['quik', 'bad'] ~
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4462
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4463 The spelling information for the current window is used. The
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4464 'spell' option must be set and the value of 'spelllang' is
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4465 used.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4466
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4467 *spellsuggest()*
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4468 spellsuggest({word} [, {max} [, {capital}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4469 Return a |List| with spelling suggestions to replace {word}.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4470 When {max} is given up to this number of suggestions are
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4471 returned. Otherwise up to 25 suggestions are returned.
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4472
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4473 When the {capital} argument is given and it's non-zero only
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4474 suggestions with a leading capital will be given. Use this
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4475 after a match with 'spellcapcheck'.
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4476
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4477 {word} can be a badly spelled word followed by other text.
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4478 This allows for joining two words that were split. The
359
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
4479 suggestions also include the following text, thus you can
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
4480 replace a line.
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
4481
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
4482 {word} may also be a good word. Similar words will then be
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4483 returned. {word} itself is not included in the suggestions,
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
4484 although it may appear capitalized.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4485
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4486 The spelling information for the current window is used. The
375
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
4487 'spell' option must be set and the values of 'spelllang' and
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
4488 'spellsuggest' are used.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
4489
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4490
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4491 split({expr} [, {pattern} [, {keepempty}]]) *split()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4492 Make a |List| out of {expr}. When {pattern} is omitted or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4493 empty each white-separated sequence of characters becomes an
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4494 item.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4495 Otherwise the string is split where {pattern} matches,
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4496 removing the matched characters.
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4497 When the first or last item is empty it is omitted, unless the
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4498 {keepempty} argument is given and it's non-zero.
293
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 282
diff changeset
4499 Other empty items are kept when {pattern} matches at least one
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 282
diff changeset
4500 character or when {keepempty} is non-zero.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4501 Example: >
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4502 :let words = split(getline('.'), '\W\+')
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4503 < To split a string in individual characters: >
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4504 :for c in split(mystring, '\zs')
258
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
4505 < If you want to keep the separator you can also use '\zs': >
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
4506 :echo split('abc:def:ghi', ':\zs')
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
4507 < ['abc:', 'def:', 'ghi'] ~
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4508 Splitting a table where the first element can be empty: >
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4509 :let items = split(line, ':', 1)
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
4510 < The opposite function is |join()|.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4511
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4512
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4513 str2nr( {expr} [, {base}]) *str2nr()*
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4514 Convert string {expr} to a number.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4515 {base} is the conversion base, it can be 8, 10 or 16.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4516 When {base} is omitted base 10 is used. This also means that
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4517 a leading zero doesn't cause octal conversion to be used, as
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4518 with the default String to Number conversion.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4519 When {base} is 16 a leading "0x" or "0X" is ignored. With a
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4520 different base the result will be zero.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4521 Text after the number is silently ignored.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4522
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
4523
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4524 strftime({format} [, {time}]) *strftime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4525 The result is a String, which is a formatted date and time, as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4526 specified by the {format} string. The given {time} is used,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4527 or the current time if no time is given. The accepted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4528 {format} depends on your system, thus this is not portable!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4529 See the manual page of the C function strftime() for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4530 format. The maximum length of the result is 80 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4531 See also |localtime()| and |getftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4532 The language can be changed with the |:language| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4533 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4534 :echo strftime("%c") Sun Apr 27 11:49:23 1997
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4535 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4536 :echo strftime("%y%m%d %T") 970427 11:53:55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4537 :echo strftime("%H:%M") 11:55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4538 :echo strftime("%c", getftime("file.c"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4539 Show mod time of file.c.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4540 < Not available on all systems. To check use: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4541 :if exists("*strftime")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4542
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4543 stridx({haystack}, {needle} [, {start}]) *stridx()*
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4544 The result is a Number, which gives the byte index in
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4545 {haystack} of the first occurrence of the String {needle}.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4546 If {start} is specified, the search starts at index {start}.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4547 This can be used to find a second match: >
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4548 :let comma1 = stridx(line, ",")
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4549 :let comma2 = stridx(line, ",", comma1 + 1)
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4550 < The search is done case-sensitive.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4551 For pattern searches use |match()|.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4552 -1 is returned if the {needle} does not occur in {haystack}.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4553 See also |strridx()|.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4554 Examples: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4555 :echo stridx("An Example", "Example") 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4556 :echo stridx("Starting point", "Start") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4557 :echo stridx("Starting point", "start") -1
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4558 < *strstr()* *strchr()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4559 stridx() works similar to the C function strstr(). When used
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4560 with a single character it works similar to strchr().
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4561
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4562 *string()*
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4563 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4564 String or a composition of them, then the result can be parsed
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4565 back with |eval()|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4566 {expr} type result ~
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4567 String 'string'
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4568 Number 123
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4569 Funcref function('name')
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4570 List [item, item]
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
4571 Dictionary {key: value, key: value}
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4572 Note that in String values the ' character is doubled.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4573
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4574 *strlen()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4575 strlen({expr}) The result is a Number, which is the length of the String
502
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 493
diff changeset
4576 {expr} in bytes.
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 493
diff changeset
4577 If you want to count the number of multi-byte characters (not
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 493
diff changeset
4578 counting composing characters) use something like this: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4579
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4580 :let len = strlen(substitute(str, ".", "x", "g"))
502
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 493
diff changeset
4581 <
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4582 If the argument is a Number it is first converted to a String.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4583 For other types an error is given.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
4584 Also see |len()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4585
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4586 strpart({src}, {start}[, {len}]) *strpart()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4587 The result is a String, which is part of {src}, starting from
574
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
4588 byte {start}, with the byte length {len}.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4589 When non-existing bytes are included, this doesn't result in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4590 an error, the bytes are simply omitted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4591 If {len} is missing, the copy continues from {start} till the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4592 end of the {src}. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4593 strpart("abcdefg", 3, 2) == "de"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4594 strpart("abcdefg", -2, 4) == "ab"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4595 strpart("abcdefg", 5, 4) == "fg"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4596 strpart("abcdefg", 3) == "defg"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4597 < Note: To get the first character, {start} must be 0. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4598 example, to get three bytes under and after the cursor: >
823
9ab23f1e137f updated for version 7.0c12
vimboss
parents: 819
diff changeset
4599 strpart(getline("."), col(".") - 1, 3)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4600 <
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4601 strridx({haystack}, {needle} [, {start}]) *strridx()*
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4602 The result is a Number, which gives the byte index in
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4603 {haystack} of the last occurrence of the String {needle}.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4604 When {start} is specified, matches beyond this index are
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4605 ignored. This can be used to find a match before a previous
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4606 match: >
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4607 :let lastcomma = strridx(line, ",")
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4608 :let comma2 = strridx(line, ",", lastcomma - 1)
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4609 < The search is done case-sensitive.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4610 For pattern searches use |match()|.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
4611 -1 is returned if the {needle} does not occur in {haystack}.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
4612 If the {needle} is empty the length of {haystack} is returned.
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4613 See also |stridx()|. Examples: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4614 :echo strridx("an angry armadillo", "an") 3
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4615 < *strrchr()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4616 When used with a single character it works similar to the C
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4617 function strrchr().
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4618
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4619 strtrans({expr}) *strtrans()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4620 The result is a String, which is {expr} with all unprintable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4621 characters translated into printable characters |'isprint'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4622 Like they are shown in a window. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4623 echo strtrans(@a)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4624 < This displays a newline in register a as "^@" instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4625 starting a new line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4626
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4627 submatch({nr}) *submatch()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4628 Only for an expression in a |:substitute| command. Returns
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4629 the {nr}'th submatch of the matched text. When {nr} is 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4630 the whole matched text is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4631 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4632 :s/\d\+/\=submatch(0) + 1/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4633 < This finds the first number in the line and adds one to it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4634 A line break is included as a newline character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4635
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4636 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4637 The result is a String, which is a copy of {expr}, in which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4638 the first match of {pat} is replaced with {sub}. This works
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4639 like the ":substitute" command (without any flags). But the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4640 matching with {pat} is always done like the 'magic' option is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4641 set and 'cpoptions' is empty (to make scripts portable).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4642 See |string-match| for how {pat} is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4643 And a "~" in {sub} is not replaced with the previous {sub}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4644 Note that some codes in {sub} have a special meaning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4645 |sub-replace-special|. For example, to replace something with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4646 "\n" (two characters), use "\\\\n" or '\\n'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4647 When {pat} does not match in {expr}, {expr} is returned
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4648 unmodified.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4649 When {flags} is "g", all matches of {pat} in {expr} are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4650 replaced. Otherwise {flags} should be "".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4651 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4652 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4653 < This removes the last component of the 'path' option. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4654 :echo substitute("testing", ".*", "\\U\\0", "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4655 < results in "TESTING".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4656
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
4657 synID({lnum}, {col}, {trans}) *synID()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4658 The result is a Number, which is the syntax ID at the position
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
4659 {lnum} and {col} in the current window.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4660 The syntax ID can be used with |synIDattr()| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4661 |synIDtrans()| to obtain syntax information about text.
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
4662
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
4663 {col} is 1 for the leftmost column, {lnum} is 1 for the first
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
4664 line. 'synmaxcol' applies, in a longer line zero is returned.
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
4665
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4666 When {trans} is non-zero, transparent items are reduced to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4667 item that they reveal. This is useful when wanting to know
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4668 the effective color. When {trans} is zero, the transparent
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4669 item is returned. This is useful when wanting to know which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4670 syntax item is effective (e.g. inside parens).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4671 Warning: This function can be very slow. Best speed is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4672 obtained by going through the file in forward direction.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4673
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4674 Example (echoes the name of the syntax item under the cursor): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4675 :echo synIDattr(synID(line("."), col("."), 1), "name")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4676 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4677 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4678 The result is a String, which is the {what} attribute of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4679 syntax ID {synID}. This can be used to obtain information
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4680 about a syntax item.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4681 {mode} can be "gui", "cterm" or "term", to get the attributes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4682 for that mode. When {mode} is omitted, or an invalid value is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4683 used, the attributes for the currently active highlighting are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4684 used (GUI, cterm or term).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4685 Use synIDtrans() to follow linked highlight groups.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4686 {what} result
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4687 "name" the name of the syntax item
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4688 "fg" foreground color (GUI: color name used to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4689 the color, cterm: color number as a string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4690 term: empty string)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4691 "bg" background color (like "fg")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4692 "fg#" like "fg", but for the GUI and the GUI is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4693 running the name in "#RRGGBB" form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4694 "bg#" like "fg#" for "bg"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4695 "bold" "1" if bold
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4696 "italic" "1" if italic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4697 "reverse" "1" if reverse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4698 "inverse" "1" if inverse (= reverse)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4699 "underline" "1" if underlined
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4700 "undercurl" "1" if undercurled
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4702 Example (echoes the color of the syntax item under the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4703 cursor): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4704 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4705 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4706 synIDtrans({synID}) *synIDtrans()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4707 The result is a Number, which is the translated syntax ID of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4708 {synID}. This is the syntax group ID of what is being used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4709 highlight the character. Highlight links given with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4710 ":highlight link" are followed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4711
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4712 system({expr} [, {input}]) *system()* *E677*
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4713 Get the output of the shell command {expr}.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4714 When {input} is given, this string is written to a file and
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4715 passed as stdin to the command. The string is written as-is,
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4716 you need to take care of using the correct line separators
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
4717 yourself. Pipes are not used.
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4718 Note: newlines in {expr} may cause the command to fail. The
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4719 characters in 'shellquote' and 'shellxquote' may also cause
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
4720 trouble.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4721 This is not to be used for interactive commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4722 The result is a String. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4723
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4724 :let files = system("ls")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4725
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4726 < To make the result more system-independent, the shell output
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4727 is filtered to replace <CR> with <NL> for Macintosh, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4728 <CR><NL> with <NL> for DOS-like systems.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4729 The command executed is constructed using several options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4730 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4731 ({tmp} is an automatically generated file name).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4732 For Unix and OS/2 braces are put around {expr} to allow for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4733 concatenated commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4734
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4735 The command will be executed in "cooked" mode, so that a
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4736 CTRL-C will interrupt the command (on Unix at least).
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4737
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4738 The resulting error code can be found in |v:shell_error|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4739 This function will fail in |restricted-mode|.
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
4740
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
4741 Note that any wrong value in the options mentioned above may
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
4742 make the function fail. It has also been reported to fail
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
4743 when using a security agent application.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4744 Unlike ":!cmd" there is no automatic check for changed files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4745 Use |:checktime| to force a check.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4746
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4747
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4748 tabpagebuflist([{arg}]) *tabpagebuflist()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4749 The result is a |List|, where each item is the number of the
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4750 buffer associated with each window in the current tab page.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4751 {arg} specifies the number of tab page to be used. When
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4752 omitted the current tab page is used.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4753 When {arg} is invalid the number zero is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4754 To get a list of all buffers in all tabs use this: >
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4755 tablist = []
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4756 for i in range(tabpagenr('$'))
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4757 call extend(tablist, tabpagebuflist(i + 1))
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4758 endfor
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4759 < Note that a buffer may appear in more than one window.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4760
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4761
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4762 tabpagenr([{arg}]) *tabpagenr()*
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4763 The result is a Number, which is the number of the current
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4764 tab page. The first tab page has number 1.
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4765 When the optional argument is "$", the number of the last tab
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4766 page is returned (the tab page count).
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4767 The number can be used with the |:tab| command.
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4768
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4769
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4770 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()*
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4771 Like |winnr()| but for tab page {arg}.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4772 {tabarg} specifies the number of tab page to be used.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4773 {arg} is used like with |winnr()|:
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4774 - When omitted the current window number is returned. This is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4775 the window which will be used when going to this tab page.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4776 - When "$" the number of windows is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4777 - When "#" the previous window nr is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4778 Useful examples: >
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4779 tabpagewinnr(1) " current window of tab page 1
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4780 tabpagewinnr(4, '$') " number of windows in tab page 4
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4781 < When {tabarg} is invalid zero is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
4782
805
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
4783 *tagfiles()*
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
4784 tagfiles() Returns a |List| with the file names used to search for tags
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
4785 for the current buffer. This is the 'tags' option expanded.
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
4786
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
4787
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4788 taglist({expr}) *taglist()*
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4789 Returns a list of tags matching the regular expression {expr}.
438
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
4790 Each list item is a dictionary with at least the following
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
4791 entries:
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4792 name Name of the tag.
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4793 filename Name of the file where the tag is
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4794 defined.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4795 cmd Ex command used to locate the tag in
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4796 the file.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4797 kind Type of the tag. The value for this
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4798 entry depends on the language specific
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4799 kind values generated by the ctags
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4800 tool.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4801 static A file specific tag. Refer to
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4802 |static-tag| for more information.
216
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4803 The "kind" entry is only available when using Exuberant ctags
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4804 generated tags file. More entries may be present, depending
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4805 on the content of the tags file: access, implementation,
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4806 inherits and signature. Refer to the ctags documentation for
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4807 information about these fields. For C code the fields
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4808 "struct", "class" and "enum" may appear, they give the name of
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4809 the entity the tag is contained in.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
4810
216
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4811 The ex-command 'cmd' can be either an ex search pattern, a
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4812 line number or a line number followed by a byte number.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4813
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4814 If there are no matching tags, then an empty list is returned.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4815
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4816 To get an exact tag match, the anchors '^' and '$' should be
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4817 used in {expr}. Refer to |tag-regexp| for more information
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4818 about the tag search regular expression pattern.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4819
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4820 Refer to |'tags'| for information about how the tags file is
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4821 located by Vim. Refer to |tags-file-format| for the format of
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4822 the tags file generated by the different ctags tools.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4823
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4824 tempname() *tempname()* *temp-file-name*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4825 The result is a String, which is the name of a file that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4826 doesn't exist. It can be used for a temporary file. The name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4827 is different for at least 26 consecutive calls. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4828 :let tmpfile = tempname()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4829 :exe "redir > " . tmpfile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4830 < For Unix, the file will be in a private directory (only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4831 accessible by the current user) to avoid security problems
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4832 (e.g., a symlink attack or other people reading your file).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4833 When Vim exits the directory and all files in it are deleted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4834 For MS-Windows forward slashes are used when the 'shellslash'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4835 option is set or when 'shellcmdflag' starts with '-'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4836
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4837 tolower({expr}) *tolower()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4838 The result is a copy of the String given, with all uppercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4839 characters turned into lowercase (just like applying |gu| to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4840 the string).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4841
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4842 toupper({expr}) *toupper()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4843 The result is a copy of the String given, with all lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4844 characters turned into uppercase (just like applying |gU| to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4845 the string).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4846
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4847 tr({src}, {fromstr}, {tostr}) *tr()*
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4848 The result is a copy of the {src} string with all characters
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4849 which appear in {fromstr} replaced by the character in that
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4850 position in the {tostr} string. Thus the first character in
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4851 {fromstr} is translated into the first character in {tostr}
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4852 and so on. Exactly like the unix "tr" command.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4853 This code also deals with multibyte characters properly.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4854
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4855 Examples: >
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4856 echo tr("hello there", "ht", "HT")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4857 < returns "Hello THere" >
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4858 echo tr("<blob>", "<>", "{}")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4859 < returns "{blob}"
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
4860
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4861 *type()*
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4862 type({expr}) The result is a Number, depending on the type of {expr}:
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4863 Number: 0
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4864 String: 1
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4865 Funcref: 2
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4866 List: 3
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4867 Dictionary: 4
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4868 To avoid the magic numbers it should be used this way: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4869 :if type(myvar) == type(0)
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4870 :if type(myvar) == type("")
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4871 :if type(myvar) == type(function("tr"))
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
4872 :if type(myvar) == type([])
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
4873 :if type(myvar) == type({})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4874
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4875 values({dict}) *values()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4876 Return a |List| with all the values of {dict}. The |List| is
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4877 in arbitrary order.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4878
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4879
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4880 virtcol({expr}) *virtcol()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4881 The result is a Number, which is the screen column of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4882 position given with {expr}. That is, the last screen position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4883 occupied by the character at that position, when the screen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4884 would be of unlimited width. When there is a <Tab> at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4885 position, the returned Number will be the column at the end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4886 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4887 set to 8, it returns 8.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4888 For the use of {expr} see |col()|. Additionally you can use
688
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
4889 [lnum, col]: a |List| with the line and column number. When
bcd2edc4539e updated for version 7.0207
vimboss
parents: 685
diff changeset
4890 "lnum" or "col" is out of range then virtcol() returns zero.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
4891 When 'virtualedit' is used it can be [lnum, col, off], where
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
4892 "off" is the offset in screen columns from the start of the
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
4893 character. E.g., a position within a Tab or after the last
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
4894 character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4895 For the byte position use |col()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4896 When Virtual editing is active in the current mode, a position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4897 beyond the end of the line can be returned. |'virtualedit'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4898 The accepted positions are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4899 . the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4900 $ the end of the cursor line (the result is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4901 number of displayed characters in the cursor line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4902 plus one)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4903 'x position of mark x (if the mark is not set, 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4904 returned)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4905 Note that only marks in the current file can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4906 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4907 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4908 virtcol("$") with text "foo^Lbar", returns 9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4909 virtcol("'t") with text " there", with 't at 'h', returns 6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4910 < The first column is 1. 0 is returned for an error.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4911
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4912 visualmode([expr]) *visualmode()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4913 The result is a String, which describes the last Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4914 used. Initially it returns an empty string, but once Visual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4915 mode has been used, it returns "v", "V", or "<CTRL-V>" (a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4916 single CTRL-V character) for character-wise, line-wise, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4917 block-wise Visual mode respectively.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4918 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4919 :exe "normal " . visualmode()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4920 < This enters the same Visual mode as before. It is also useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4921 in scripts if you wish to act differently depending on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4922 Visual mode that was used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4923
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4924 If an expression is supplied that results in a non-zero number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4925 or a non-empty string, then the Visual mode will be cleared
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4926 and the old value is returned. Note that " " and "0" are also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4927 non-empty strings, thus cause the mode to be cleared.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4928
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4929 *winbufnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4930 winbufnr({nr}) The result is a Number, which is the number of the buffer
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
4931 associated with window {nr}. When {nr} is zero, the number of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4932 the buffer in the current window is returned. When window
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4933 {nr} doesn't exist, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4934 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4935 :echo "The file in the current window is " . bufname(winbufnr(0))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4936 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4937 *wincol()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4938 wincol() The result is a Number, which is the virtual column of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4939 cursor in the window. This is counting screen cells from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4940 left side of the window. The leftmost column is one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4941
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4942 winheight({nr}) *winheight()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4943 The result is a Number, which is the height of window {nr}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4944 When {nr} is zero, the height of the current window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4945 returned. When window {nr} doesn't exist, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4946 An existing window always has a height of zero or more.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4947 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4948 :echo "The current window has " . winheight(0) . " lines."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4949 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4950 *winline()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4951 winline() The result is a Number, which is the screen line of the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4952 in the window. This is counting screen lines from the top of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4953 the window. The first line is one.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4954 If the cursor was moved the view on the file will be updated
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4955 first, this may cause a scroll.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4956
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4957 *winnr()*
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4958 winnr([{arg}]) The result is a Number, which is the number of the current
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4959 window. The top window has number 1.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4960 When the optional argument is "$", the number of the
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
4961 last window is returned (the window count).
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4962 When the optional argument is "#", the number of the last
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4963 accessed window is returned (where |CTRL-W_p| goes to).
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4964 If there is no previous window 0 is returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4965 The number can be used with |CTRL-W_w| and ":wincmd w"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4966 |:wincmd|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4967
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4968 *winrestcmd()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4969 winrestcmd() Returns a sequence of |:resize| commands that should restore
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4970 the current window sizes. Only works properly when no windows
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4971 are opened or closed and the current window and tab page is
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4972 unchanged.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4973 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4974 :let cmd = winrestcmd()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4975 :call MessWithWindowSizes()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4976 :exe cmd
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4977 <
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4978 *winrestview()*
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4979 winrestview({dict})
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4980 Uses the |Dictionary| returned by |winsaveview()| to restore
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4981 the view of the current window.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4982 If you have changed the values the result is unpredictable.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4983 If the window size changed the result won't be the same.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4984
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4985 *winsaveview()*
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4986 winsaveview() Returns a |Dictionary| that contains information to restore
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4987 the view of the current window. Use |winrestview()| to
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4988 restore the view.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4989 This is useful if you have a mapping that jumps around in the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4990 buffer and you want to go back to the original view.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4991 This does not save fold information. Use the 'foldenable'
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
4992 option to temporarily switch off folding, so that folds are
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
4993 not opened when moving around.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4994 The return value includes:
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4995 lnum cursor line number
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4996 col cursor column
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4997 coladd cursor column offset for 'virtualedit'
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4998 curswant column for vertical movement
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
4999 topline first line in the window
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
5000 topfill filler lines, only in diff mode
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
5001 leftcol first column displayed
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
5002 skipcol columns skipped
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
5003 Note that no option values are saved.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
5004
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5005
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5006 winwidth({nr}) *winwidth()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5007 The result is a Number, which is the width of window {nr}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5008 When {nr} is zero, the width of the current window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5009 returned. When window {nr} doesn't exist, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5010 An existing window always has a width of zero or more.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5011 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5012 :echo "The current window has " . winwidth(0) . " columns."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5013 :if winwidth(0) <= 50
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5014 : exe "normal 50\<C-W>|"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5015 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5016 <
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5017 *writefile()*
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5018 writefile({list}, {fname} [, {binary}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5019 Write |List| {list} to file {fname}. Each list item is
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5020 separated with a NL. Each list item must be a String or
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5021 Number.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5022 When {binary} is equal to "b" binary mode is used: There will
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5023 not be a NL after the last list item. An empty item at the
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5024 end does cause the last line in the file to end in a NL.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5025 All NL characters are replaced with a NUL character.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5026 Inserting CR characters needs to be done before passing {list}
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5027 to writefile().
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5028 An existing file is overwritten, if possible.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5029 When the write fails -1 is returned, otherwise 0. There is an
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5030 error message if the file can't be created or when writing
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5031 fails.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5032 Also see |readfile()|.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5033 To copy a file byte for byte: >
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5034 :let fl = readfile("foo", "b")
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5035 :call writefile(fl, "foocopy", "b")
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5036 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5037
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5038 *feature-list*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5039 There are three types of features:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5040 1. Features that are only supported when they have been enabled when Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5041 was compiled |+feature-list|. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5042 :if has("cindent")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5043 2. Features that are only supported when certain conditions have been met.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5044 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5045 :if has("gui_running")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5046 < *has-patch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5047 3. Included patches. First check |v:version| for the version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5048 Then the "patch123" feature means that patch 123 has been included for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5049 this version. Example (checking version 6.2.148 or later): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5050 :if v:version > 602 || v:version == 602 && has("patch148")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5051
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5052 all_builtin_terms Compiled with all builtin terminals enabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5053 amiga Amiga version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5054 arabic Compiled with Arabic support |Arabic|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5055 arp Compiled with ARP support (Amiga).
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
5056 autocmd Compiled with autocommand support. |autocommand|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5057 balloon_eval Compiled with |balloon-eval| support.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
5058 balloon_multiline GUI supports multiline balloons.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5059 beos BeOS version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5060 browse Compiled with |:browse| support, and browse() will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5061 work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5062 builtin_terms Compiled with some builtin terminals.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5063 byte_offset Compiled with support for 'o' in 'statusline'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5064 cindent Compiled with 'cindent' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5065 clientserver Compiled with remote invocation support |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5066 clipboard Compiled with 'clipboard' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5067 cmdline_compl Compiled with |cmdline-completion| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5068 cmdline_hist Compiled with |cmdline-history| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5069 cmdline_info Compiled with 'showcmd' and 'ruler' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5070 comments Compiled with |'comments'| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5071 cryptv Compiled with encryption support |encryption|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5072 cscope Compiled with |cscope| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5073 compatible Compiled to be very Vi compatible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5074 debug Compiled with "DEBUG" defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5075 dialog_con Compiled with console dialog support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5076 dialog_gui Compiled with GUI dialog support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5077 diff Compiled with |vimdiff| and 'diff' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5078 digraphs Compiled with support for digraphs.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5079 dnd Compiled with support for the "~ register |quote_~|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5080 dos32 32 bits DOS (DJGPP) version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5081 dos16 16 bits DOS version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5082 ebcdic Compiled on a machine with ebcdic character set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5083 emacs_tags Compiled with support for Emacs tags.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5084 eval Compiled with expression evaluation support. Always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5085 true, of course!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5086 ex_extra Compiled with extra Ex commands |+ex_extra|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5087 extra_search Compiled with support for |'incsearch'| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5088 |'hlsearch'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5089 farsi Compiled with Farsi support |farsi|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5090 file_in_path Compiled with support for |gf| and |<cfile>|
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5091 filterpipe When 'shelltemp' is off pipes are used for shell
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5092 read/write/filter commands
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5093 find_in_path Compiled with support for include file searches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5094 |+find_in_path|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5095 fname_case Case in file names matters (for Amiga, MS-DOS, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5096 Windows this is not present).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5097 folding Compiled with |folding| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5098 footer Compiled with GUI footer support. |gui-footer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5099 fork Compiled to use fork()/exec() instead of system().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5100 gettext Compiled with message translation |multi-lang|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5101 gui Compiled with GUI enabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5102 gui_athena Compiled with Athena GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5103 gui_gtk Compiled with GTK+ GUI (any version).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5104 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5105 gui_mac Compiled with Macintosh GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5106 gui_motif Compiled with Motif GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5107 gui_photon Compiled with Photon GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5108 gui_win32 Compiled with MS Windows Win32 GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5109 gui_win32s idem, and Win32s system being used (Windows 3.1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5110 gui_running Vim is running in the GUI, or it will start soon.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5111 hangul_input Compiled with Hangul input support. |hangul|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5112 iconv Can use iconv() for conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5113 insert_expand Compiled with support for CTRL-X expansion commands in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5114 Insert mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5115 jumplist Compiled with |jumplist| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5116 keymap Compiled with 'keymap' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5117 langmap Compiled with 'langmap' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5118 libcall Compiled with |libcall()| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5119 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5120 support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5121 lispindent Compiled with support for lisp indenting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5122 listcmds Compiled with commands for the buffer list |:files|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5123 and the argument list |arglist|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5124 localmap Compiled with local mappings and abbr. |:map-local|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5125 mac Macintosh version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5126 macunix Macintosh version of Vim, using Unix files (OS-X).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5127 menu Compiled with support for |:menu|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5128 mksession Compiled with support for |:mksession|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5129 modify_fname Compiled with file name modifiers. |filename-modifiers|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5130 mouse Compiled with support mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5131 mouseshape Compiled with support for 'mouseshape'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5132 mouse_dec Compiled with support for Dec terminal mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5133 mouse_gpm Compiled with support for gpm (Linux console mouse)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5134 mouse_netterm Compiled with support for netterm mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5135 mouse_pterm Compiled with support for qnx pterm mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5136 mouse_xterm Compiled with support for xterm mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5137 multi_byte Compiled with support for editing Korean et al.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5138 multi_byte_ime Compiled with support for IME input method.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5139 multi_lang Compiled with support for multiple languages.
14
946da5994c01 updated for version 7.0006
vimboss
parents: 11
diff changeset
5140 mzscheme Compiled with MzScheme interface |mzscheme|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5141 netbeans_intg Compiled with support for |netbeans|.
33
f6033dcbaf31 updated for version 7.0020
vimboss
parents: 32
diff changeset
5142 netbeans_enabled Compiled with support for |netbeans| and it's used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5143 ole Compiled with OLE automation support for Win32.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5144 os2 OS/2 version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5145 osfiletype Compiled with support for osfiletypes |+osfiletype|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5146 path_extra Compiled with up/downwards search in 'path' and 'tags'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5147 perl Compiled with Perl interface.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5148 postscript Compiled with PostScript file printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5149 printer Compiled with |:hardcopy| support.
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
5150 profile Compiled with |:profile| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5151 python Compiled with Python interface.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5152 qnx QNX version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5153 quickfix Compiled with |quickfix| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5154 rightleft Compiled with 'rightleft' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5155 ruby Compiled with Ruby interface |ruby|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5156 scrollbind Compiled with 'scrollbind' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5157 showcmd Compiled with 'showcmd' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5158 signs Compiled with |:sign| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5159 smartindent Compiled with 'smartindent' support.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
5160 sniff Compiled with SNiFF interface support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5161 statusline Compiled with support for 'statusline', 'rulerformat'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5162 and special formats of 'titlestring' and 'iconstring'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5163 sun_workshop Compiled with support for Sun |workshop|.
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 303
diff changeset
5164 spell Compiled with spell checking support |spell|.
529f887b5cb7 updated for version 7.0082
vimboss
parents: 303
diff changeset
5165 syntax Compiled with syntax highlighting support |syntax|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5166 syntax_items There are active syntax highlighting items for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5167 current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5168 system Compiled to use system() instead of fork()/exec().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5169 tag_binary Compiled with binary searching in tags files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5170 |tag-binary-search|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5171 tag_old_static Compiled with support for old static tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5172 |tag-old-static|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5173 tag_any_white Compiled with support for any white characters in tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5174 files |tag-any-white|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5175 tcl Compiled with Tcl interface.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5176 terminfo Compiled with terminfo instead of termcap.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5177 termresponse Compiled with support for |t_RV| and |v:termresponse|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5178 textobjects Compiled with support for |text-objects|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5179 tgetent Compiled with tgetent support, able to use a termcap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5180 or terminfo file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5181 title Compiled with window title support |'title'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5182 toolbar Compiled with support for |gui-toolbar|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5183 unix Unix version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5184 user_commands User-defined commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5185 viminfo Compiled with viminfo support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5186 vim_starting True while initial source'ing takes place.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5187 vertsplit Compiled with vertically split windows |:vsplit|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5188 virtualedit Compiled with 'virtualedit' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5189 visual Compiled with Visual mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5190 visualextra Compiled with extra Visual mode commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5191 |blockwise-operators|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5192 vms VMS version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5193 vreplace Compiled with |gR| and |gr| commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5194 wildignore Compiled with 'wildignore' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5195 wildmenu Compiled with 'wildmenu' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5196 windows Compiled with support for more than one window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5197 winaltkeys Compiled with 'winaltkeys' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5198 win16 Win16 version of Vim (MS-Windows 3.1).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5199 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5200 win64 Win64 version of Vim (MS-Windows 64 bit).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5201 win32unix Win32 version of Vim, using Unix files (Cygwin)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5202 win95 Win32 version for MS-Windows 95/98/ME.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5203 writebackup Compiled with 'writebackup' default on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5204 xfontset Compiled with X fontset support |xfontset|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5205 xim Compiled with X input method support |xim|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5206 xsmp Compiled with X session management support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5207 xsmp_interact Compiled with interactive X session management support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5208 xterm_clipboard Compiled with support for xterm clipboard.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5209 xterm_save Compiled with support for saving and restoring the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5210 xterm screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5211 x11 Compiled with X11 support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5212
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5213 *string-match*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5214 Matching a pattern in a String
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5215
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5216 A regexp pattern as explained at |pattern| is normally used to find a match in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5217 the buffer lines. When a pattern is used to find a match in a String, almost
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5218 everything works in the same way. The difference is that a String is handled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5219 like it is one line. When it contains a "\n" character, this is not seen as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5220 line break for the pattern. It can be matched with a "\n" in the pattern, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5221 with ".". Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5222 :let a = "aaaa\nxxxx"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5223 :echo matchstr(a, "..\n..")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5224 aa
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5225 xx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5226 :echo matchstr(a, "a.x")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5227 a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5228 x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5229
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5230 Don't forget that "^" will only match at the first character of the String and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5231 "$" at the last character of the string. They don't match after or before a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5232 "\n".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5234 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5235 5. Defining functions *user-functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5236
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5237 New functions can be defined. These can be called just like builtin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5238 functions. The function executes a sequence of Ex commands. Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5239 commands can be executed with the |:normal| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5240
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5241 The function name must start with an uppercase letter, to avoid confusion with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5242 builtin functions. To prevent from using the same name in different scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5243 avoid obvious, short names. A good habit is to start the function name with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5244 the name of the script, e.g., "HTMLcolor()".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5245
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5246 It's also possible to use curly braces, see |curly-braces-names|. And the
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5247 |autoload| facility is useful to define a function only when it's called.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5248
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5249 *local-function*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5250 A function local to a script must start with "s:". A local script function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5251 can only be called from within the script and from functions, user commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5252 and autocommands defined in the script. It is also possible to call the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5253 function from a mappings defined in the script, but then |<SID>| must be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5254 instead of "s:" when the mapping is expanded outside of the script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5255
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5256 *:fu* *:function* *E128* *E129* *E123*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5257 :fu[nction] List all functions and their arguments.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5258
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5259 :fu[nction] {name} List function {name}.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5260 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5261 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5262 :function dict.init
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5263
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5264 :fu[nction] /{pattern} List functions with a name matching {pattern}.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5265 Example that lists all functions ending with "File": >
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
5266 :function /File$
482
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5267 <
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5268 *:function-verbose*
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5269 When 'verbose' is non-zero, listing a function will also display where it was
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5270 last defined. Example: >
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5271
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5272 :verbose function SetFileTypeSH
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5273 function SetFileTypeSH(name)
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5274 Last set from /usr/share/vim/vim-7.0/filetype.vim
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5275 <
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 482
diff changeset
5276 See |:verbose-cmd| for more information.
482
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5277
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
5278 *E124* *E125*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5279 :fu[nction][!] {name}([arguments]) [range] [abort] [dict]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5280 Define a new function by the name {name}. The name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5281 must be made of alphanumeric characters and '_', and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5282 must start with a capital or "s:" (see above).
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5283
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5284 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5285 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5286 :function dict.init(arg)
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5287 < "dict" must be an existing dictionary. The entry
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5288 "init" is added if it didn't exist yet. Otherwise [!]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5289 is required to overwrite an existing function. The
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5290 result is a |Funcref| to a numbered function. The
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5291 function can only be used with a |Funcref| and will be
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5292 deleted if there are no more references to it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5293 *E127* *E122*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5294 When a function by this name already exists and [!] is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5295 not used an error message is given. When [!] is used,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5296 an existing function is silently replaced. Unless it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5297 is currently being executed, that is an error.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5298
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5299 For the {arguments} see |function-argument|.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5300
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5301 *a:firstline* *a:lastline*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5302 When the [range] argument is added, the function is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5303 expected to take care of a range itself. The range is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5304 passed as "a:firstline" and "a:lastline". If [range]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5305 is excluded, ":{range}call" will call the function for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5306 each line in the range, with the cursor on the start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5307 of each line. See |function-range-example|.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5308
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5309 When the [abort] argument is added, the function will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5310 abort as soon as an error is detected.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5311
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5312 When the [dict] argument is added, the function must
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5313 be invoked through an entry in a |Dictionary|. The
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5314 local variable "self" will then be set to the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5315 dictionary. See |Dictionary-function|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5316
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
5317 The last used search pattern and the redo command "."
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
5318 will not be changed by the function.
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
5319
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5320 *:endf* *:endfunction* *E126* *E193*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5321 :endf[unction] The end of a function definition. Must be on a line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5322 by its own, without other commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5324 *:delf* *:delfunction* *E130* *E131*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5325 :delf[unction] {name} Delete function {name}.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5326 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5327 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5328 :delfunc dict.init
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5329 < This will remove the "init" entry from "dict". The
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5330 function is deleted if there are no more references to
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5331 it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5332 *:retu* *:return* *E133*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5333 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5334 evaluated and returned as the result of the function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5335 If "[expr]" is not given, the number 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5336 When a function ends without an explicit ":return",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5337 the number 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5338 Note that there is no check for unreachable lines,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5339 thus there is no warning if commands follow ":return".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5340
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5341 If the ":return" is used after a |:try| but before the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5342 matching |:finally| (if present), the commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5343 following the ":finally" up to the matching |:endtry|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5344 are executed first. This process applies to all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5345 nested ":try"s inside the function. The function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5346 returns at the outermost ":endtry".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5347
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5348 *function-argument* *a:var*
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5349 An argument can be defined by giving its name. In the function this can then
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5350 be used as "a:name" ("a:" for argument).
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5351 *a:0* *a:1* *a:000* *E740*
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5352 Up to 20 arguments can be given, separated by commas. After the named
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5353 arguments an argument "..." can be specified, which means that more arguments
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5354 may optionally be following. In the function the extra arguments can be used
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5355 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5356 can be 0). "a:000" is set to a |List| that contains these arguments. Note
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5357 that "a:1" is the same as "a:000[0]".
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5358 *E742*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5359 The a: scope and the variables in it cannot be changed, they are fixed.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5360 However, if a |List| or |Dictionary| is used, you can changes their contents.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5361 Thus you can pass a |List| to a function and have the function add an item to
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5362 it. If you want to make sure the function cannot change a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5363 |Dictionary| use |:lockvar|.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5364
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5365 When not using "...", the number of arguments in a function call must be equal
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5366 to the number of named arguments. When using "...", the number of arguments
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5367 may be larger.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5368
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5369 It is also possible to define a function without any arguments. You must
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5370 still supply the () then. The body of the function follows in the next lines,
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5371 until the matching |:endfunction|. It is allowed to define another function
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5372 inside a function body.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5373
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
5374 *local-variables*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5375 Inside a function variables can be used. These are local variables, which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5376 will disappear when the function returns. Global variables need to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5377 accessed with "g:".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5378
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5379 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5380 :function Table(title, ...)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5381 : echohl Title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5382 : echo a:title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5383 : echohl None
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5384 : echo a:0 . " items:"
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5385 : for s in a:000
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5386 : echon ' ' . s
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5387 : endfor
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5388 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5389
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5390 This function can then be called with: >
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5391 call Table("Table", "line1", "line2")
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5392 call Table("Empty Table")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5393
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5394 To return more than one value, pass the name of a global variable: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5395 :function Compute(n1, n2, divname)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5396 : if a:n2 == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5397 : return "fail"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5398 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5399 : let g:{a:divname} = a:n1 / a:n2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5400 : return "ok"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5401 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5402
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5403 This function can then be called with: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5404 :let success = Compute(13, 1324, "div")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5405 :if success == "ok"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5406 : echo div
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5407 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5408
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5409 An alternative is to return a command that can be executed. This also works
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5410 with local variables in a calling function. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5411 :function Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5412 : execute Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5413 : echo "line " . lnum . " column " . col
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5414 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5415
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5416 :function Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5417 : return "let lnum = " . line(".") . " | let col = " . col(".")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5418 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5419
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5420 The names "lnum" and "col" could also be passed as argument to Bar(), to allow
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5421 the caller to set the names.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5422
786
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
5423 *:cal* *:call* *E107* *E117*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5424 :[range]cal[l] {name}([arguments])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5425 Call a function. The name of the function and its arguments
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5426 are as specified with |:function|. Up to 20 arguments can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5427 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5428 Without a range and for functions that accept a range, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5429 function is called once. When a range is given the cursor is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5430 positioned at the start of the first line before executing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5431 function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5432 When a range is given and the function doesn't handle it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5433 itself, the function is executed for each line in the range,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5434 with the cursor in the first column of that line. The cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5435 is left at the last line (possibly moved by the last function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5436 call). The arguments are re-evaluated for each line. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5437 this works:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5438 *function-range-example* >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5439 :function Mynumber(arg)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5440 : echo line(".") . " " . a:arg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5441 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5442 :1,5call Mynumber(getline("."))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5443 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5444 The "a:firstline" and "a:lastline" are defined anyway, they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5445 can be used to do something different at the start or end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5446 the range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5447
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5448 Example of a function that handles the range itself: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5449
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5450 :function Cont() range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5451 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5452 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5453 :4,8call Cont()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5454 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5455 This function inserts the continuation character "\" in front
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5456 of all the lines in the range, except the first one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5457
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5458 *E132*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5459 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5460 option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5461
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5462
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5463 AUTOMATICALLY LOADING FUNCTIONS ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5464 *autoload-functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5465 When using many or large functions, it's possible to automatically define them
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5466 only when they are used. There are two methods: with an autocommand and with
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5467 the "autoload" directory in 'runtimepath'.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5468
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5469
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5470 Using an autocommand ~
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5471
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
5472 This is introduced in the user manual, section |41.14|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
5473
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5474 The autocommand is useful if you have a plugin that is a long Vim script file.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5475 You can define the autocommand and quickly quit the script with |:finish|.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5476 That makes Vim startup faster. The autocommand should then load the same file
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5477 again, setting a variable to skip the |:finish| command.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5478
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5479 Use the FuncUndefined autocommand event with a pattern that matches the
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5480 function(s) to be defined. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5481
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5482 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5483
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5484 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5485 "BufNet". Also see |FuncUndefined|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5486
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5487
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5488 Using an autoload script ~
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5489 *autoload* *E746*
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
5490 This is introduced in the user manual, section |41.15|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
5491
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5492 Using a script in the "autoload" directory is simpler, but requires using
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5493 exactly the right file name. A function that can be autoloaded has a name
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5494 like this: >
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5495
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5496 :call filename#funcname()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5497
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5498 When such a function is called, and it is not defined yet, Vim will search the
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5499 "autoload" directories in 'runtimepath' for a script file called
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5500 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5501 then define the function like this: >
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5502
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5503 function filename#funcname()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5504 echo "Done!"
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5505 endfunction
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5506
530
339999b511a0 updated for version 7.0148
vimboss
parents: 523
diff changeset
5507 The file name and the name used before the # in the function must match
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5508 exactly, and the defined function must have the name exactly as it will be
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5509 called.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5510
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5511 It is possible to use subdirectories. Every # in the function name works like
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5512 a path separator. Thus when calling a function: >
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5513
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5514 :call foo#bar#func()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5515
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5516 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5517
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5518 This also works when reading a variable that has not been set yet: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5519
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5520 :let l = foo#bar#lvar
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5521
557
862863033fdd updated for version 7.0158
vimboss
parents: 555
diff changeset
5522 However, when the autoload script was already loaded it won't be loaded again
862863033fdd updated for version 7.0158
vimboss
parents: 555
diff changeset
5523 for an unknown variable.
862863033fdd updated for version 7.0158
vimboss
parents: 555
diff changeset
5524
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5525 When assigning a value to such a variable nothing special happens. This can
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5526 be used to pass settings to the autoload script before it's loaded: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5527
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5528 :let foo#bar#toggle = 1
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
5529 :call foo#bar#func()
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5530
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
5531 Note that when you make a mistake and call a function that is supposed to be
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
5532 defined in an autoload script, but the script doesn't actually define the
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
5533 function, the script will be sourced every time you try to call the function.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5534 And you will get an error message every time.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5535
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5536 Also note that if you have two script files, and one calls a function in the
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5537 other and vise versa, before the used function is defined, it won't work.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
5538 Avoid using the autoload functionality at the toplevel.
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
5539
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
5540 Hint: If you distribute a bunch of scripts you can pack them together with the
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
5541 |vimball| utility. Also read the user manual |distribute-script|.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
5542
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5543 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5544 6. Curly braces names *curly-braces-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5545
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5546 Wherever you can use a variable, you can use a "curly braces name" variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5547 This is a regular variable name with one or more expressions wrapped in braces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5548 {} like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5549 my_{adjective}_variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5550
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5551 When Vim encounters this, it evaluates the expression inside the braces, puts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5552 that in place of the expression, and re-interprets the whole as a variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5553 name. So in the above example, if the variable "adjective" was set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5554 "noisy", then the reference would be to "my_noisy_variable", whereas if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5555 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5556
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5557 One application for this is to create a set of variables governed by an option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5558 value. For example, the statement >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5559 echo my_{&background}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5560
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5561 would output the contents of "my_dark_message" or "my_light_message" depending
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5562 on the current value of 'background'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5563
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5564 You can use multiple brace pairs: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5565 echo my_{adverb}_{adjective}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5566 ..or even nest them: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5567 echo my_{ad{end_of_word}}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5568 where "end_of_word" is either "verb" or "jective".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5569
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5570 However, the expression inside the braces must evaluate to a valid single
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
5571 variable name, e.g. this is invalid: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5572 :let foo='a + b'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5573 :echo c{foo}d
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5574 .. since the result of expansion is "ca + bd", which is not a variable name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5575
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5576 *curly-braces-function-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5577 You can call and define functions by an evaluated name in a similar way.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5578 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5579 :let func_end='whizz'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5580 :call my_func_{func_end}(parameter)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5581
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5582 This would call the function "my_func_whizz(parameter)".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5583
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5584 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5585 7. Commands *expression-commands*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5586
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5587 :let {var-name} = {expr1} *:let* *E18*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5588 Set internal variable {var-name} to the result of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5589 expression {expr1}. The variable will get the type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5590 from the {expr}. If {var-name} didn't exist yet, it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5591 is created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5592
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5593 :let {var-name}[{idx}] = {expr1} *E689*
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5594 Set a list item to the result of the expression
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5595 {expr1}. {var-name} must refer to a list and {idx}
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5596 must be a valid index in that list. For nested list
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5597 the index can be repeated.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5598 This cannot be used to add an item to a list.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5599
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5600 *E711* *E719*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5601 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5602 Set a sequence of items in a |List| to the result of
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5603 the expression {expr1}, which must be a list with the
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5604 correct number of items.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5605 {idx1} can be omitted, zero is used instead.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5606 {idx2} can be omitted, meaning the end of the list.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5607 When the selected range of items is partly past the
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5608 end of the list, items will be added.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5609
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
5610 *:let+=* *:let-=* *:let.=* *E734*
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5611 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5612 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5613 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5614 These fail if {var} was not set yet and when the type
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5615 of {var} and {expr1} don't fit the operator.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5616
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5617
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5618 :let ${env-name} = {expr1} *:let-environment* *:let-$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5619 Set environment variable {env-name} to the result of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5620 the expression {expr1}. The type is always String.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5621 :let ${env-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5622 Append {expr1} to the environment variable {env-name}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5623 If the environment variable didn't exist yet this
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5624 works like "=".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5625
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5626 :let @{reg-name} = {expr1} *:let-register* *:let-@*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5627 Write the result of the expression {expr1} in register
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5628 {reg-name}. {reg-name} must be a single letter, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5629 must be the name of a writable register (see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5630 |registers|). "@@" can be used for the unnamed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5631 register, "@/" for the search pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5632 If the result of {expr1} ends in a <CR> or <NL>, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5633 register will be linewise, otherwise it will be set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5634 characterwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5635 This can be used to clear the last search pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5636 :let @/ = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5637 < This is different from searching for an empty string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5638 that would match everywhere.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5639
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5640 :let @{reg-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5641 Append {expr1} to register {reg-name}. If the
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5642 register was empty it's like setting it to {expr1}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5643
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5644 :let &{option-name} = {expr1} *:let-option* *:let-star*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5645 Set option {option-name} to the result of the
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5646 expression {expr1}. A String or Number value is
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5647 always converted to the type of the option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5648 For an option local to a window or buffer the effect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5649 is just like using the |:set| command: both the local
555
a5efb97bc104 updated for version 7.0157
vimboss
parents: 548
diff changeset
5650 value and the global value are changed.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5651 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5652 :let &path = &path . ',/usr/local/include'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5653
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5654 :let &{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5655 For a string option: Append {expr1} to the value.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5656 Does not insert a comma like |:set+=|.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5657
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5658 :let &{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5659 :let &{option-name} -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5660 For a number or boolean option: Add or subtract
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5661 {expr1}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5662
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5663 :let &l:{option-name} = {expr1}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5664 :let &l:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5665 :let &l:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5666 :let &l:{option-name} -= {expr1}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5667 Like above, but only set the local value of an option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5668 (if there is one). Works like |:setlocal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5669
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5670 :let &g:{option-name} = {expr1}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5671 :let &g:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5672 :let &g:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5673 :let &g:{option-name} -= {expr1}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5674 Like above, but only set the global value of an option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5675 (if there is one). Works like |:setglobal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5676
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5677 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5678 {expr1} must evaluate to a |List|. The first item in
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5679 the list is assigned to {name1}, the second item to
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5680 {name2}, etc.
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5681 The number of names must match the number of items in
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5682 the |List|.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5683 Each name can be one of the items of the ":let"
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5684 command as mentioned above.
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5685 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5686 :let [s, item] = GetItem(s)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5687 < Detail: {expr1} is evaluated first, then the
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5688 assignments are done in sequence. This matters if
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5689 {name2} depends on {name1}. Example: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5690 :let x = [0, 1]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5691 :let i = 0
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5692 :let [i, x[i]] = [1, 2]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5693 :echo x
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5694 < The result is [0, 2].
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5695
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5696 :let [{name1}, {name2}, ...] .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5697 :let [{name1}, {name2}, ...] += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5698 :let [{name1}, {name2}, ...] -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5699 Like above, but append/add/subtract the value for each
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5700 |List| item.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5701
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5702 :let [{name}, ..., ; {lastname}] = {expr1}
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5703 Like |:let-unpack| above, but the |List| may have more
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5704 items than there are names. A list of the remaining
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5705 items is assigned to {lastname}. If there are no
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5706 remaining items {lastname} is set to an empty list.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5707 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5708 :let [a, b; rest] = ["aval", "bval", 3, 4]
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
5709 <
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5710 :let [{name}, ..., ; {lastname}] .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5711 :let [{name}, ..., ; {lastname}] += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5712 :let [{name}, ..., ; {lastname}] -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5713 Like above, but append/add/subtract the value for each
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5714 |List| item.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5715 *E106*
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5716 :let {var-name} .. List the value of variable {var-name}. Multiple
123
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
5717 variable names may be given. Special names recognized
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
5718 here: *E738*
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
5719 g: global variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
5720 b: local buffer variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
5721 w: local window variables
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5722 t: local tab page variables
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
5723 s: script-local variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
5724 l: local function variables
123
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
5725 v: Vim variables.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5726
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5727 :let List the values of all variables. The type of the
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5728 variable is indicated before the value:
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5729 <nothing> String
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5730 # Number
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5731 * Funcref
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5732
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5733
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5734 :unl[et][!] {name} ... *:unlet* *:unl* *E108*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5735 Remove the internal variable {name}. Several variable
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5736 names can be given, they are all removed. The name
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5737 may also be a |List| or |Dictionary| item.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5738 With [!] no error message is given for non-existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5739 variables.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5740 One or more items from a |List| can be removed: >
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
5741 :unlet list[3] " remove fourth item
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
5742 :unlet list[3:] " remove fourth item to last
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5743 < One item from a |Dictionary| can be removed at a time: >
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
5744 :unlet dict['two']
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
5745 :unlet dict.two
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5746
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5747 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5748 Lock the internal variable {name}. Locking means that
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5749 it can no longer be changed (until it is unlocked).
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5750 A locked variable can be deleted: >
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5751 :lockvar v
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5752 :let v = 'asdf' " fails!
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5753 :unlet v
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5754 < *E741*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5755 If you try to change a locked variable you get an
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5756 error message: "E741: Value of {name} is locked"
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5757
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5758 [depth] is relevant when locking a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5759 |Dictionary|. It specifies how deep the locking goes:
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5760 1 Lock the |List| or |Dictionary| itself,
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5761 cannot add or remove items, but can
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5762 still change their values.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5763 2 Also lock the values, cannot change
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5764 the items. If an item is a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5765 |Dictionary|, cannot add or remove
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5766 items, but can still change the
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5767 values.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5768 3 Like 2 but for the |List| /
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5769 |Dictionary| in the |List| /
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5770 |Dictionary|, one level deeper.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5771 The default [depth] is 2, thus when {name} is a |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5772 or |Dictionary| the values cannot be changed.
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5773 *E743*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5774 For unlimited depth use [!] and omit [depth].
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5775 However, there is a maximum depth of 100 to catch
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5776 loops.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5777
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5778 Note that when two variables refer to the same |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5779 and you lock one of them, the |List| will also be
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5780 locked when used through the other variable.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5781 Example: >
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5782 :let l = [0, 1, 2, 3]
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5783 :let cl = l
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5784 :lockvar l
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5785 :let cl[1] = 99 " won't work!
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5786 < You may want to make a copy of a list to avoid this.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5787 See |deepcopy()|.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5788
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5789
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5790 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5791 Unlock the internal variable {name}. Does the
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5792 opposite of |:lockvar|.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5793
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5794
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5795 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5796 :en[dif] Execute the commands until the next matching ":else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5797 or ":endif" if {expr1} evaluates to non-zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5798
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5799 From Vim version 4.5 until 5.0, every Ex command in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5800 between the ":if" and ":endif" is ignored. These two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5801 commands were just to allow for future expansions in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5802 backwards compatible way. Nesting was allowed. Note
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5803 that any ":else" or ":elseif" was ignored, the "else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5804 part was not executed either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5805
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5806 You can use this to remain compatible with older
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5807 versions: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5808 :if version >= 500
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5809 : version-5-specific-commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5810 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5811 < The commands still need to be parsed to find the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5812 "endif". Sometimes an older Vim has a problem with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5813 new command. For example, ":silent" is recognized as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5814 a ":substitute" command. In that case ":execute" can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5815 avoid problems: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5816 :if version >= 600
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5817 : execute "silent 1,$delete"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5818 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5819 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5820 NOTE: The ":append" and ":insert" commands don't work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5821 properly in between ":if" and ":endif".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5822
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5823 *:else* *:el* *E581* *E583*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5824 :el[se] Execute the commands until the next matching ":else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5825 or ":endif" if they previously were not being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5826 executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5827
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5828 *:elseif* *:elsei* *E582* *E584*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5829 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5830 is no extra ":endif".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5831
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5832 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5833 *E170* *E585* *E588* *E733*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5834 :endw[hile] Repeat the commands between ":while" and ":endwhile",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5835 as long as {expr1} evaluates to non-zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5836 When an error is detected from a command inside the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5837 loop, execution continues after the "endwhile".
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5838 Example: >
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5839 :let lnum = 1
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5840 :while lnum <= line("$")
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5841 :call FixLine(lnum)
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5842 :let lnum = lnum + 1
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5843 :endwhile
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5844 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5845 NOTE: The ":append" and ":insert" commands don't work
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
5846 properly inside a ":while" and ":for" loop.
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5847
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
5848 :for {var} in {list} *:for* *E690* *E732*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5849 :endfo[r] *:endfo* *:endfor*
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5850 Repeat the commands between ":for" and ":endfor" for
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
5851 each item in {list}. Variable {var} is set to the
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5852 value of each item.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5853 When an error is detected for a command inside the
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5854 loop, execution continues after the "endfor".
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
5855 Changing {list} inside the loop affects what items are
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
5856 used. Make a copy if this is unwanted: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5857 :for item in copy(mylist)
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5858 < When not making a copy, Vim stores a reference to the
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5859 next item in the list, before executing the commands
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5860 with the current item. Thus the current item can be
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5861 removed without effect. Removing any later item means
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5862 it will not be found. Thus the following example
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5863 works (an inefficient way to make a list empty): >
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5864 :for item in mylist
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5865 :call remove(mylist, 0)
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5866 :endfor
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5867 < Note that reordering the list (e.g., with sort() or
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5868 reverse()) may have unexpected effects.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5869 Note that the type of each list item should be
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5870 identical to avoid errors for the type of {var}
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5871 changing. Unlet the variable at the end of the loop
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5872 to allow multiple item types.
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5873
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5874 :for [{var1}, {var2}, ...] in {listlist}
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5875 :endfo[r]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5876 Like ":for" above, but each item in {listlist} must be
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5877 a list, of which each item is assigned to {var1},
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5878 {var2}, etc. Example: >
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5879 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5880 :echo getline(lnum)[col]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5881 :endfor
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5882 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5883 *:continue* *:con* *E586*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5884 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5885 to the start of the loop.
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5886 If it is used after a |:try| inside the loop but
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5887 before the matching |:finally| (if present), the
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5888 commands following the ":finally" up to the matching
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5889 |:endtry| are executed first. This process applies to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5890 all nested ":try"s inside the loop. The outermost
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5891 ":endtry" then jumps back to the start of the loop.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5892
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5893 *:break* *:brea* *E587*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5894 :brea[k] When used inside a ":while" or ":for" loop, skips to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5895 the command after the matching ":endwhile" or
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5896 ":endfor".
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5897 If it is used after a |:try| inside the loop but
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5898 before the matching |:finally| (if present), the
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5899 commands following the ":finally" up to the matching
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5900 |:endtry| are executed first. This process applies to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5901 all nested ":try"s inside the loop. The outermost
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
5902 ":endtry" then jumps to the command after the loop.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5903
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5904 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5905 :endt[ry] Change the error handling for the commands between
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5906 ":try" and ":endtry" including everything being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5907 executed across ":source" commands, function calls,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5908 or autocommand invocations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5909
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5910 When an error or interrupt is detected and there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5911 a |:finally| command following, execution continues
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5912 after the ":finally". Otherwise, or when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5913 ":endtry" is reached thereafter, the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5914 (dynamically) surrounding ":try" is checked for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5915 a corresponding ":finally" etc. Then the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5916 processing is terminated. (Whether a function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5917 definition has an "abort" argument does not matter.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5918 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5919 :try | edit too much | finally | echo "cleanup" | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5920 :echo "impossible" " not reached, script terminated above
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5921 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5922 Moreover, an error or interrupt (dynamically) inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5923 ":try" and ":endtry" is converted to an exception. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5924 can be caught as if it were thrown by a |:throw|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5925 command (see |:catch|). In this case, the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5926 processing is not terminated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5927
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5928 The value "Vim:Interrupt" is used for an interrupt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5929 exception. An error in a Vim command is converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5930 to a value of the form "Vim({command}):{errmsg}",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5931 other errors are converted to a value of the form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5932 "Vim:{errmsg}". {command} is the full command name,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5933 and {errmsg} is the message that is displayed if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5934 error exception is not caught, always beginning with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5935 the error number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5936 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5937 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5938 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5939 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5940 *:cat* *:catch* *E603* *E604* *E605*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5941 :cat[ch] /{pattern}/ The following commands until the next ":catch",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5942 |:finally|, or |:endtry| that belongs to the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5943 |:try| as the ":catch" are executed when an exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5944 matching {pattern} is being thrown and has not yet
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5945 been caught by a previous ":catch". Otherwise, these
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5946 commands are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5947 When {pattern} is omitted all errors are caught.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5948 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5949 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5950 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5951 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5952 :catch /^Vim(write):/ " catch all errors in :write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5953 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5954 :catch /my-exception/ " catch user exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5955 :catch /.*/ " catch everything
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5956 :catch " same as /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5957 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5958 Another character can be used instead of / around the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5959 {pattern}, so long as it does not have a special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5960 meaning (e.g., '|' or '"') and doesn't occur inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5961 {pattern}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5962 NOTE: It is not reliable to ":catch" the TEXT of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5963 an error message because it may vary in different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5964 locales.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5965
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5966 *:fina* *:finally* *E606* *E607*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5967 :fina[lly] The following commands until the matching |:endtry|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5968 are executed whenever the part between the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5969 |:try| and the ":finally" is left: either by falling
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5970 through to the ":finally" or by a |:continue|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5971 |:break|, |:finish|, or |:return|, or by an error or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5972 interrupt or exception (see |:throw|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5973
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5974 *:th* *:throw* *E608*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5975 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5976 If the ":throw" is used after a |:try| but before the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5977 first corresponding |:catch|, commands are skipped
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5978 until the first ":catch" matching {expr1} is reached.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5979 If there is no such ":catch" or if the ":throw" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5980 used after a ":catch" but before the |:finally|, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5981 commands following the ":finally" (if present) up to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5982 the matching |:endtry| are executed. If the ":throw"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5983 is after the ":finally", commands up to the ":endtry"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5984 are skipped. At the ":endtry", this process applies
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5985 again for the next dynamically surrounding ":try"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5986 (which may be found in a calling function or sourcing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5987 script), until a matching ":catch" has been found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5988 If the exception is not caught, the command processing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5989 is terminated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5990 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5991 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5992 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5993
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5994 *:ec* *:echo*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5995 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5996 first {expr1} starts on a new line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5997 Also see |:comment|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5998 Use "\n" to start a new line. Use "\r" to move the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5999 cursor to the first column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6000 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6001 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6002 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6003 :echo "the value of 'shell' is" &shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6004 < A later redraw may make the message disappear again.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6005 To avoid that a command from before the ":echo" causes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6006 a redraw afterwards (redraws are often postponed until
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6007 you type something), force a redraw with the |:redraw|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6008 command. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6009 :new | redraw | echo "there is a new window"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6010 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6011 *:echon*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6012 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6013 |:comment|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6014 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6015 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6016 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6017 :echon "the value of 'shell' is " &shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6018 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6019 Note the difference between using ":echo", which is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6020 Vim command, and ":!echo", which is an external shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6021 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6022 :!echo % --> filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6023 < The arguments of ":!" are expanded, see |:_%|. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6024 :!echo "%" --> filename or "filename"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6025 < Like the previous example. Whether you see the double
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6026 quotes or not depends on your 'shell'. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6027 :echo % --> nothing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6028 < The '%' is an illegal character in an expression. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6029 :echo "%" --> %
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6030 < This just echoes the '%' character. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6031 :echo expand("%") --> filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6032 < This calls the expand() function to expand the '%'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6033
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6034 *:echoh* *:echohl*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6035 :echoh[l] {name} Use the highlight group {name} for the following
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6036 |:echo|, |:echon| and |:echomsg| commands. Also used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6037 for the |input()| prompt. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6038 :echohl WarningMsg | echo "Don't panic!" | echohl None
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6039 < Don't forget to set the group back to "None",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6040 otherwise all following echo's will be highlighted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6041
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6042 *:echom* *:echomsg*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6043 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6044 message in the |message-history|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6045 Spaces are placed between the arguments as with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6046 |:echo| command. But unprintable characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6047 displayed, not interpreted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6048 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6049 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6050 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6051 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6052 *:echoe* *:echoerr*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6053 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6054 message in the |message-history|. When used in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6055 script or function the line number will be added.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6056 Spaces are placed between the arguments as with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6057 :echo command. When used inside a try conditional,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6058 the message is raised as an error exception instead
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6059 (see |try-echoerr|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6060 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6061 :echoerr "This script just failed!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6062 < If you just want a highlighted message use |:echohl|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6063 And to get a beep: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6064 :exe "normal \<Esc>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6065 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6066 *:exe* *:execute*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6067 :exe[cute] {expr1} .. Executes the string that results from the evaluation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6068 of {expr1} as an Ex command. Multiple arguments are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6069 concatenated, with a space in between. {expr1} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6070 used as the processed command, command line editing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6071 keys are not recognized.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6072 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6073 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6074 :execute "buffer " nextbuf
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6075 :execute "normal " count . "w"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6076 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6077 ":execute" can be used to append a command to commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6078 that don't accept a '|'. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6079 :execute '!ls' | echo "theend"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6080
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6081 < ":execute" is also a nice way to avoid having to type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6082 control characters in a Vim script for a ":normal"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6083 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6084 :execute "normal ixxx\<Esc>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6085 < This has an <Esc> character, see |expr-string|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6086
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6087 Note: The executed string may be any command-line, but
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
6088 you cannot start or end a "while", "for" or "if"
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
6089 command. Thus this is illegal: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6090 :execute 'while i > 5'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6091 :execute 'echo "test" | break'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6092 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6093 It is allowed to have a "while" or "if" command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6094 completely in the executed string: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6095 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6096 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6097
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6098 *:comment*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6099 ":execute", ":echo" and ":echon" cannot be followed by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6100 a comment directly, because they see the '"' as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6101 start of a string. But, you can use '|' followed by a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6102 comment. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6103 :echo "foo" | "this is a comment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6105 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6106 8. Exception handling *exception-handling*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6107
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6108 The Vim script language comprises an exception handling feature. This section
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6109 explains how it can be used in a Vim script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6110
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6111 Exceptions may be raised by Vim on an error or on interrupt, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6112 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6113 exception by using the ":throw" command, see |throw-catch|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6114
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6115
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6116 TRY CONDITIONALS *try-conditionals*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6118 Exceptions can be caught or can cause cleanup code to be executed. You can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6119 use a try conditional to specify catch clauses (that catch exceptions) and/or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6120 a finally clause (to be executed for cleanup).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6121 A try conditional begins with a |:try| command and ends at the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6122 |:endtry| command. In between, you can use a |:catch| command to start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6123 a catch clause, or a |:finally| command to start a finally clause. There may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6124 be none or multiple catch clauses, but there is at most one finally clause,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6125 which must not be followed by any catch clauses. The lines before the catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6126 clauses and the finally clause is called a try block. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6128 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6129 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6130 : ... TRY BLOCK
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6131 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6132 :catch /{pattern}/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6133 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6134 : ... CATCH CLAUSE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6135 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6136 :catch /{pattern}/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6137 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6138 : ... CATCH CLAUSE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6139 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6140 :finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6141 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6142 : ... FINALLY CLAUSE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6143 : ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6144 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6145
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6146 The try conditional allows to watch code for exceptions and to take the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6147 appropriate actions. Exceptions from the try block may be caught. Exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6148 from the try block and also the catch clauses may cause cleanup actions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6149 When no exception is thrown during execution of the try block, the control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6150 is transferred to the finally clause, if present. After its execution, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6151 script continues with the line following the ":endtry".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6152 When an exception occurs during execution of the try block, the remaining
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6153 lines in the try block are skipped. The exception is matched against the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6154 patterns specified as arguments to the ":catch" commands. The catch clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6155 after the first matching ":catch" is taken, other catch clauses are not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6156 executed. The catch clause ends when the next ":catch", ":finally", or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6157 ":endtry" command is reached - whatever is first. Then, the finally clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6158 (if present) is executed. When the ":endtry" is reached, the script execution
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6159 continues in the following line as usual.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6160 When an exception that does not match any of the patterns specified by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6161 ":catch" commands is thrown in the try block, the exception is not caught by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6162 that try conditional and none of the catch clauses is executed. Only the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6163 finally clause, if present, is taken. The exception pends during execution of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6164 the finally clause. It is resumed at the ":endtry", so that commands after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6165 the ":endtry" are not executed and the exception might be caught elsewhere,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6166 see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6167 When during execution of a catch clause another exception is thrown, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6168 remaining lines in that catch clause are not executed. The new exception is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6169 not matched against the patterns in any of the ":catch" commands of the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6170 try conditional and none of its catch clauses is taken. If there is, however,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6171 a finally clause, it is executed, and the exception pends during its
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6172 execution. The commands following the ":endtry" are not executed. The new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6173 exception might, however, be caught elsewhere, see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6174 When during execution of the finally clause (if present) an exception is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6175 thrown, the remaining lines in the finally clause are skipped. If the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6176 clause has been taken because of an exception from the try block or one of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6177 catch clauses, the original (pending) exception is discarded. The commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6178 following the ":endtry" are not executed, and the exception from the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6179 clause is propagated and can be caught elsewhere, see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6180
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6181 The finally clause is also executed, when a ":break" or ":continue" for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6182 a ":while" loop enclosing the complete try conditional is executed from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6183 try block or a catch clause. Or when a ":return" or ":finish" is executed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6184 from the try block or a catch clause of a try conditional in a function or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6185 sourced script, respectively. The ":break", ":continue", ":return", or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6186 ":finish" pends during execution of the finally clause and is resumed when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6187 ":endtry" is reached. It is, however, discarded when an exception is thrown
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6188 from the finally clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6189 When a ":break" or ":continue" for a ":while" loop enclosing the complete
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6190 try conditional or when a ":return" or ":finish" is encountered in the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6191 clause, the rest of the finally clause is skipped, and the ":break",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6192 ":continue", ":return" or ":finish" is executed as usual. If the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6193 clause has been taken because of an exception or an earlier ":break",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6194 ":continue", ":return", or ":finish" from the try block or a catch clause,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6195 this pending exception or command is discarded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6196
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6197 For examples see |throw-catch| and |try-finally|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6198
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6199
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6200 NESTING OF TRY CONDITIONALS *try-nesting*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6201
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6202 Try conditionals can be nested arbitrarily. That is, a complete try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6203 conditional can be put into the try block, a catch clause, or the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6204 clause of another try conditional. If the inner try conditional does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6205 catch an exception thrown in its try block or throws a new exception from one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6206 of its catch clauses or its finally clause, the outer try conditional is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6207 checked according to the rules above. If the inner try conditional is in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6208 try block of the outer try conditional, its catch clauses are checked, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6209 otherwise only the finally clause is executed. It does not matter for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6210 nesting, whether the inner try conditional is directly contained in the outer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6211 one, or whether the outer one sources a script or calls a function containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6212 the inner try conditional.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6213
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6214 When none of the active try conditionals catches an exception, just their
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6215 finally clauses are executed. Thereafter, the script processing terminates.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6216 An error message is displayed in case of an uncaught exception explicitly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6217 thrown by a ":throw" command. For uncaught error and interrupt exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6218 implicitly raised by Vim, the error message(s) or interrupt message are shown
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6219 as usual.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6220
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6221 For examples see |throw-catch|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6222
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6224 EXAMINING EXCEPTION HANDLING CODE *except-examine*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6225
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6226 Exception handling code can get tricky. If you are in doubt what happens, set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6227 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6228 script file. Then you see when an exception is thrown, discarded, caught, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6229 finished. When using a verbosity level of at least 14, things pending in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6230 a finally clause are also shown. This information is also given in debug mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6231 (see |debug-scripts|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6232
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6234 THROWING AND CATCHING EXCEPTIONS *throw-catch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6235
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6236 You can throw any number or string as an exception. Use the |:throw| command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6237 and pass the value to be thrown as argument: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6238 :throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6239 :throw "string"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6240 < *throw-expression*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6241 You can also specify an expression argument. The expression is then evaluated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6242 first, and the result is thrown: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6243 :throw 4705 + strlen("string")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6244 :throw strpart("strings", 0, 6)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6245
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6246 An exception might be thrown during evaluation of the argument of the ":throw"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6247 command. Unless it is caught there, the expression evaluation is abandoned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6248 The ":throw" command then does not throw a new exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6249 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6250
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6251 :function! Foo(arg)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6252 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6253 : throw a:arg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6254 : catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6255 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6256 : return 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6257 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6258 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6259 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6260 : echo "in Bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6261 : return 4710
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6262 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6263 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6264 :throw Foo("arrgh") + Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6265
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6266 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6267 executed. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6268 :throw Foo("foo") + Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6269 however displays "in Bar" and throws 4711.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6270
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6271 Any other command that takes an expression as argument might also be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6272 abandoned by an (uncaught) exception during the expression evaluation. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6273 exception is then propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6274 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6275
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6276 :if Foo("arrgh")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6277 : echo "then"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6278 :else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6279 : echo "else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6280 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6281
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6282 Here neither of "then" or "else" is displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6283
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6284 *catch-order*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6285 Exceptions can be caught by a try conditional with one or more |:catch|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6286 commands, see |try-conditionals|. The values to be caught by each ":catch"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6287 command can be specified as a pattern argument. The subsequent catch clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6288 gets executed when a matching exception is caught.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6289 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6290
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6291 :function! Foo(value)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6292 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6293 : throw a:value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6294 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6295 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6296 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6297 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6298 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6299 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6300 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6301 :call Foo(0x1267)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6302 :call Foo('string')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6303
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6304 The first call to Foo() displays "Number thrown", the second "String thrown".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6305 An exception is matched against the ":catch" commands in the order they are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6306 specified. Only the first match counts. So you should place the more
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6307 specific ":catch" first. The following order does not make sense: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6308
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6309 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6310 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6311 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6312 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6313
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6314 The first ":catch" here matches always, so that the second catch clause is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6315 never taken.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6316
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6317 *throw-variables*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6318 If you catch an exception by a general pattern, you may access the exact value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6319 in the variable |v:exception|: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6320
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6321 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6322 : echo "Number thrown. Value is" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6324 You may also be interested where an exception was thrown. This is stored in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6325 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6326 exception most recently caught as long it is not finished.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6327 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6328
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6329 :function! Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6330 : if v:exception != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6331 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6332 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6333 : echo 'Nothing caught'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6334 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6335 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6336 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6337 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6338 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6339 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6340 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6341 : throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6342 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6343 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6344 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6345 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6346 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6347 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6348 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6349 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6350 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6351 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6352 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6353 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6354 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6355 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6356 :call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6357
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6358 This displays >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6359
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6360 Nothing caught
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6361 Caught "4711" in function Foo, line 4
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6362 Caught "oops" in function Foo, line 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6363 Nothing caught
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6364
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6365 A practical example: The following command ":LineNumber" displays the line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6366 number in the script or function where it has been used: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6367
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6368 :function! LineNumber()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6369 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6370 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6371 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6372 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6373 *try-nested*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6374 An exception that is not caught by a try conditional can be caught by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6375 a surrounding try conditional: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6376
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6377 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6378 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6379 : throw "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6380 : catch /foobar/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6381 : echo "foobar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6382 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6383 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6384 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6385 :catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6386 : echo "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6387 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6388
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6389 The inner try conditional does not catch the exception, just its finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6390 clause is executed. The exception is then caught by the outer try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6391 conditional. The example displays "inner finally" and then "foo".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6392
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6393 *throw-from-catch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6394 You can catch an exception and throw a new one to be caught elsewhere from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6395 catch clause: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6396
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6397 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6398 : throw "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6399 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6400 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6401 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6402 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6403 : call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6404 : catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6405 : echo "Caught foo, throw bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6406 : throw "bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6407 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6408 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6409 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6410 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6411 : call Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6412 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6413 : echo "Caught" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6414 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6415
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6416 This displays "Caught foo, throw bar" and then "Caught bar".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6417
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6418 *rethrow*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6419 There is no real rethrow in the Vim script language, but you may throw
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6420 "v:exception" instead: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6421
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6422 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6423 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6424 : call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6425 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6426 : echo "Rethrow" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6427 : throw v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6428 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6429 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6430 < *try-echoerr*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6431 Note that this method cannot be used to "rethrow" Vim error or interrupt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6432 exceptions, because it is not possible to fake Vim internal exceptions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6433 Trying so causes an error exception. You should throw your own exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6434 denoting the situation. If you want to cause a Vim error exception containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6435 the original error exception value, you can use the |:echoerr| command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6436
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6437 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6438 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6439 : asdf
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6440 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6441 : echoerr v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6442 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6443 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6444 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6445 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6446
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6447 This code displays
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6448
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6449 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6450
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6451
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6452 CLEANUP CODE *try-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6453
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6454 Scripts often change global settings and restore them at their end. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6455 user however interrupts the script by pressing CTRL-C, the settings remain in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6456 an inconsistent state. The same may happen to you in the development phase of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6457 a script when an error occurs or you explicitly throw an exception without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6458 catching it. You can solve these problems by using a try conditional with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6459 a finally clause for restoring the settings. Its execution is guaranteed on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6460 normal control flow, on error, on an explicit ":throw", and on interrupt.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6461 (Note that errors and interrupts from inside the try conditional are converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6462 to exceptions. When not caught, they terminate the script after the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6463 clause has been executed.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6464 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6465
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6466 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6467 : let s:saved_ts = &ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6468 : set ts=17
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6469 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6470 : " Do the hard work here.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6471 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6472 :finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6473 : let &ts = s:saved_ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6474 : unlet s:saved_ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6475 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6476
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6477 This method should be used locally whenever a function or part of a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6478 changes global settings which need to be restored on failure or normal exit of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6479 that function or script part.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6480
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6481 *break-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6482 Cleanup code works also when the try block or a catch clause is left by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6483 a ":continue", ":break", ":return", or ":finish".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6484 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6485
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6486 :let first = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6487 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6488 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6489 : if first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6490 : echo "first"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6491 : let first = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6492 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6493 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6494 : throw "second"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6495 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6496 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6497 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6498 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6499 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6500 : echo "cleanup"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6501 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6502 : echo "still in while"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6503 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6504 :echo "end"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6505
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6506 This displays "first", "cleanup", "second", "cleanup", and "end". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6507
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6508 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6509 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6510 : return 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6511 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6512 : echo "cleanup\n"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6513 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6514 : echo "Foo still active"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6515 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6516 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6517 :echo Foo() "returned by Foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6518
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6519 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6520 extra ":return" in the finally clause. (Above all, this would override the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6521 return value.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6522
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6523 *except-from-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6524 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6525 a finally clause is possible, but not recommended since it abandons the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6526 cleanup actions for the try conditional. But, of course, interrupt and error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6527 exceptions might get raised from a finally clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6528 Example where an error in the finally clause stops an interrupt from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6529 working correctly: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6530
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6531 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6532 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6533 : echo "Press CTRL-C for interrupt"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6534 : while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6535 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6536 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6537 : unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6538 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6539 :catch /novar/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6540 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6541 :echo "Script still running"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6542 :sleep 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6543
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6544 If you need to put commands that could fail into a finally clause, you should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6545 think about catching or ignoring the errors in these commands, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6546 |catch-errors| and |ignore-errors|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6547
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6548
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6549 CATCHING ERRORS *catch-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6550
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6551 If you want to catch specific errors, you just have to put the code to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6552 watched in a try block and add a catch clause for the error message. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6553 presence of the try conditional causes all errors to be converted to an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6554 exception. No message is displayed and |v:errmsg| is not set then. To find
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6555 the right pattern for the ":catch" command, you have to know how the format of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6556 the error exception is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6557 Error exceptions have the following format: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6558
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6559 Vim({cmdname}):{errmsg}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6560 or >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6561 Vim:{errmsg}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6562
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6563 {cmdname} is the name of the command that failed; the second form is used when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6564 the command name is not known. {errmsg} is the error message usually produced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6565 when the error occurs outside try conditionals. It always begins with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6566 a capital "E", followed by a two or three-digit error number, a colon, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6567 a space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6568
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6569 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6570
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6571 The command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6572 :unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6573 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6574 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6575 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6576 Vim(unlet):E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6577
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6578 The command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6579 :dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6580 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6581 E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6582 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6583 Vim:E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6584
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6585 You can catch all ":unlet" errors by a >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6586 :catch /^Vim(unlet):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6587 or all errors for misspelled command names by a >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6588 :catch /^Vim:E492:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6589
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6590 Some error messages may be produced by different commands: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6591 :function nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6592 and >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6593 :delfunction nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6594 both produce the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6595 E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6596 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6597 Vim(function):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6598 or >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6599 Vim(delfunction):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6600 respectively. You can catch the error by its number independently on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6601 command that caused it if you use the following pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6602 :catch /^Vim(\a\+):E128:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6603
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6604 Some commands like >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6605 :let x = novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6606 produce multiple error messages, here: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6607 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6608 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6609 Only the first is used for the exception value, since it is the most specific
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6610 one (see |except-several-errors|). So you can catch it by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6611 :catch /^Vim(\a\+):E121:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6612
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6613 You can catch all errors related to the name "nofunc" by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6614 :catch /\<nofunc\>/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6615
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6616 You can catch all Vim errors in the ":write" and ":read" commands by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6617 :catch /^Vim(\(write\|read\)):E\d\+:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6618
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6619 You can catch all Vim errors by the pattern >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6620 :catch /^Vim\((\a\+)\)\=:E\d\+:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6621 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6622 *catch-text*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6623 NOTE: You should never catch the error message text itself: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6624 :catch /No such variable/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6625 only works in the english locale, but not when the user has selected
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6626 a different language by the |:language| command. It is however helpful to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6627 cite the message text in a comment: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6628 :catch /^Vim(\a\+):E108:/ " No such variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6629
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6630
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6631 IGNORING ERRORS *ignore-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6632
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6633 You can ignore errors in a specific Vim command by catching them locally: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6634
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6635 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6636 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6637 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6638 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6640 But you are strongly recommended NOT to use this simple form, since it could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6641 catch more than you want. With the ":write" command, some autocommands could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6642 be executed and cause errors not related to writing, for instance: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6643
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6644 :au BufWritePre * unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6645
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6646 There could even be such errors you are not responsible for as a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6647 writer: a user of your script might have defined such autocommands. You would
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6648 then hide the error from the user.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6649 It is much better to use >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6650
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6651 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6652 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6653 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6654 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6655
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6656 which only catches real write errors. So catch only what you'd like to ignore
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6657 intentionally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6658
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6659 For a single command that does not cause execution of autocommands, you could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6660 even suppress the conversion of errors to exceptions by the ":silent!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6661 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6662 :silent! nunmap k
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6663 This works also when a try conditional is active.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6664
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6665
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6666 CATCHING INTERRUPTS *catch-interrupt*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6667
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6668 When there are active try conditionals, an interrupt (CTRL-C) is converted to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6669 the exception "Vim:Interrupt". You can catch it like every exception. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6670 script is not terminated, then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6671 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6672
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6673 :function! TASK1()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6674 : sleep 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6675 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6676
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6677 :function! TASK2()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6678 : sleep 20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6679 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6680
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6681 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6682 : let command = input("Type a command: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6683 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6684 : if command == ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6685 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6686 : elseif command == "END"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6687 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6688 : elseif command == "TASK1"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6689 : call TASK1()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6690 : elseif command == "TASK2"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6691 : call TASK2()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6692 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6693 : echo "\nIllegal command:" command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6694 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6695 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6696 : catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6697 : echo "\nCommand interrupted"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6698 : " Caught the interrupt. Continue with next prompt.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6699 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6700 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6702 You can interrupt a task here by pressing CTRL-C; the script then asks for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6703 a new command. If you press CTRL-C at the prompt, the script is terminated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6704
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6705 For testing what happens when CTRL-C would be pressed on a specific line in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6706 your script, use the debug mode and execute the |>quit| or |>interrupt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6707 command on that line. See |debug-scripts|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6708
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6709
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6710 CATCHING ALL *catch-all*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6712 The commands >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6713
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6714 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6715 :catch //
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6716 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6717
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6718 catch everything, error exceptions, interrupt exceptions and exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6719 explicitly thrown by the |:throw| command. This is useful at the top level of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6720 a script in order to catch unexpected things.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6721 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6722
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6723 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6724 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6725 : " do the hard work here
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6726 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6727 :catch /MyException/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6728 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6729 : " handle known problem
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6730 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6731 :catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6732 : echo "Script interrupted"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6733 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6734 : echo "Internal error (" . v:exception . ")"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6735 : echo " - occurred at " . v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6736 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6737 :" end of script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6738
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6739 Note: Catching all might catch more things than you want. Thus, you are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6740 strongly encouraged to catch only for problems that you can really handle by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6741 specifying a pattern argument to the ":catch".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6742 Example: Catching all could make it nearly impossible to interrupt a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6743 by pressing CTRL-C: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6744
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6745 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6746 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6747 : sleep 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6748 : catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6749 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6750 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6751
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6752
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6753 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6754
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6755 Exceptions may be used during execution of autocommands. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6756
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6757 :autocmd User x try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6758 :autocmd User x throw "Oops!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6759 :autocmd User x catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6760 :autocmd User x echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6761 :autocmd User x endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6762 :autocmd User x throw "Arrgh!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6763 :autocmd User x echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6764 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6765 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6766 : doautocmd User x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6767 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6768 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6769 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6770
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6771 This displays "Oops!" and "Arrgh!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6772
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6773 *except-autocmd-Pre*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6774 For some commands, autocommands get executed before the main action of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6775 command takes place. If an exception is thrown and not caught in the sequence
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6776 of autocommands, the sequence and the command that caused its execution are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6777 abandoned and the exception is propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6778 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6779
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6780 :autocmd BufWritePre * throw "FAIL"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6781 :autocmd BufWritePre * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6782 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6783 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6784 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6785 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6786 : echo "Caught:" v:exception "from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6787 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6788
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6789 Here, the ":write" command does not write the file currently being edited (as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6790 you can see by checking 'modified'), since the exception from the BufWritePre
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6791 autocommand abandons the ":write". The exception is then caught and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6792 script displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6793
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6794 Caught: FAIL from BufWrite Auto commands for "*"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6795 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6796 *except-autocmd-Post*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6797 For some commands, autocommands get executed after the main action of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6798 command has taken place. If this main action fails and the command is inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6799 an active try conditional, the autocommands are skipped and an error exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6800 is thrown that can be caught by the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6801 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6802
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6803 :autocmd BufWritePost * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6804 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6805 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6806 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6807 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6808 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6809 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6810
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6811 This just displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6812
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6813 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6814
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6815 If you really need to execute the autocommands even when the main action
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6816 fails, trigger the event from the catch clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6817 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6818
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6819 :autocmd BufWritePre * set noreadonly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6820 :autocmd BufWritePost * set readonly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6821 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6822 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6823 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6824 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6825 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6826 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6827 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6828 You can also use ":silent!": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6829
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6830 :let x = "ok"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6831 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6832 :autocmd BufWritePost * if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6833 :autocmd BufWritePost * let x = "after fail"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6834 :autocmd BufWritePost * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6835 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6836 : silent! write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6837 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6838 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6839 :echo x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6840
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6841 This displays "after fail".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6842
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6843 If the main action of the command does not fail, exceptions from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6844 autocommands will be catchable by the caller of the command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6845
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6846 :autocmd BufWritePost * throw ":-("
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6847 :autocmd BufWritePost * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6848 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6849 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6850 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6851 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6852 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6853 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6854 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6855 *except-autocmd-Cmd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6856 For some commands, the normal action can be replaced by a sequence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6857 autocommands. Exceptions from that sequence will be catchable by the caller
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6858 of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6859 Example: For the ":write" command, the caller cannot know whether the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6860 had actually been written when the exception occurred. You need to tell it in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6861 some way. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6862
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6863 :if !exists("cnt")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6864 : let cnt = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6865 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6866 : autocmd BufWriteCmd * if &modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6867 : autocmd BufWriteCmd * let cnt = cnt + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6868 : autocmd BufWriteCmd * if cnt % 3 == 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6869 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6870 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6871 : autocmd BufWriteCmd * write | set nomodified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6872 : autocmd BufWriteCmd * if cnt % 3 == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6873 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6874 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6875 : autocmd BufWriteCmd * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6876 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6877 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6878 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6879 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6880 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6881 :catch /^BufWriteCmdError$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6882 : if &modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6883 : echo "Error on writing (file contents not changed)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6884 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6885 : echo "Error after writing"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6886 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6887 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6888 : echo "Error on writing"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6889 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6890
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6891 When this script is sourced several times after making changes, it displays
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6892 first >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6893 File successfully written!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6894 then >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6895 Error on writing (file contents not changed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6896 then >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6897 Error after writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6898 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6899
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6900 *except-autocmd-ill*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6901 You cannot spread a try conditional over autocommands for different events.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6902 The following code is ill-formed: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6903
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6904 :autocmd BufWritePre * try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6905 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6906 :autocmd BufWritePost * catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6907 :autocmd BufWritePost * echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6908 :autocmd BufWritePost * endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6909 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6910 :write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6911
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6912
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6913 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6914
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6915 Some programming languages allow to use hierarchies of exception classes or to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6916 pass additional information with the object of an exception class. You can do
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6917 similar things in Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6918 In order to throw an exception from a hierarchy, just throw the complete
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6919 class name with the components separated by a colon, for instance throw the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6920 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6921 When you want to pass additional information with your exception class, add
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6922 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6923 for an error when writing "myfile".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6924 With the appropriate patterns in the ":catch" command, you can catch for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6925 base classes or derived classes of your hierarchy. Additional information in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6926 parentheses can be cut out from |v:exception| with the ":substitute" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6927 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6928
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6929 :function! CheckRange(a, func)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6930 : if a:a < 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6931 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6932 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6933 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6934 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6935 :function! Add(a, b)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6936 : call CheckRange(a:a, "Add")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6937 : call CheckRange(a:b, "Add")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6938 : let c = a:a + a:b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6939 : if c < 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6940 : throw "EXCEPT:MATHERR:OVERFLOW"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6941 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6942 : return c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6943 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6944 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6945 :function! Div(a, b)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6946 : call CheckRange(a:a, "Div")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6947 : call CheckRange(a:b, "Div")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6948 : if (a:b == 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6949 : throw "EXCEPT:MATHERR:ZERODIV"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6950 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6951 : return a:a / a:b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6952 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6953 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6954 :function! Write(file)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6955 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6956 : execute "write" a:file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6957 : catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6958 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6959 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6960 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6961 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6962 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6963 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6964 : " something with arithmetics and I/O
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6965 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6966 :catch /^EXCEPT:MATHERR:RANGE/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6967 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6968 : echo "Range error in" function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6969 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6970 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6971 : echo "Math error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6972 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6973 :catch /^EXCEPT:IO/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6974 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6975 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6976 : if file !~ '^/'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6977 : let file = dir . "/" . file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6978 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6979 : echo 'I/O error for "' . file . '"'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6980 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6981 :catch /^EXCEPT/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6982 : echo "Unspecified error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6983 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6984 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6985
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6986 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6987 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6988 exceptions with the "Vim" prefix; they are reserved for Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6989 Vim error exceptions are parameterized with the name of the command that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6990 failed, if known. See |catch-errors|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6991
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6993 PECULIARITIES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6994 *except-compat*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6995 The exception handling concept requires that the command sequence causing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6996 exception is aborted immediately and control is transferred to finally clauses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6997 and/or a catch clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6998
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6999 In the Vim script language there are cases where scripts and functions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7000 continue after an error: in functions without the "abort" flag or in a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7001 after ":silent!", control flow goes to the following line, and outside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7002 functions, control flow goes to the line following the outermost ":endwhile"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7003 or ":endif". On the other hand, errors should be catchable as exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7004 (thus, requiring the immediate abortion).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7005
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7006 This problem has been solved by converting errors to exceptions and using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7007 immediate abortion (if not suppressed by ":silent!") only when a try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7008 conditional is active. This is no restriction since an (error) exception can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7009 be caught only from an active try conditional. If you want an immediate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7010 termination without catching the error, just use a try conditional without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7011 catch clause. (You can cause cleanup code being executed before termination
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7012 by specifying a finally clause.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7013
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7014 When no try conditional is active, the usual abortion and continuation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7015 behavior is used instead of immediate abortion. This ensures compatibility of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7016 scripts written for Vim 6.1 and earlier.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7017
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7018 However, when sourcing an existing script that does not use exception handling
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7019 commands (or when calling one of its functions) from inside an active try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7020 conditional of a new script, you might change the control flow of the existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7021 script on error. You get the immediate abortion on error and can catch the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7022 error in the new script. If however the sourced script suppresses error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7023 messages by using the ":silent!" command (checking for errors by testing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7024 |v:errmsg| if appropriate), its execution path is not changed. The error is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7025 not converted to an exception. (See |:silent|.) So the only remaining cause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7026 where this happens is for scripts that don't care about errors and produce
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7027 error messages. You probably won't want to use such code from your new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7028 scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7029
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7030 *except-syntax-err*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7031 Syntax errors in the exception handling commands are never caught by any of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7032 the ":catch" commands of the try conditional they belong to. Its finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7033 clauses, however, is executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7034 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7035
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7036 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7037 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7038 : throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7039 : catch /\(/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7040 : echo "in catch with syntax error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7041 : catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7042 : echo "inner catch-all"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7043 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7044 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7045 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7046 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7047 : echo 'outer catch-all caught "' . v:exception . '"'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7048 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7049 : echo "outer finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7050 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7051
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7052 This displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7053 inner finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7054 outer catch-all caught "Vim(catch):E54: Unmatched \("
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7055 outer finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7056 The original exception is discarded and an error exception is raised, instead.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7057
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7058 *except-single-line*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7059 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7060 a single line, but then syntax errors may make it difficult to recognize the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7061 "catch" line, thus you better avoid this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7062 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7063 :try | unlet! foo # | catch | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7064 raises an error exception for the trailing characters after the ":unlet!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7065 argument, but does not see the ":catch" and ":endtry" commands, so that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7066 error exception is discarded and the "E488: Trailing characters" message gets
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7067 displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7068
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7069 *except-several-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7070 When several errors appear in a single command, the first error message is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7071 usually the most specific one and therefor converted to the error exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7072 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7073 echo novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7074 causes >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7075 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7076 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7077 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7078 Vim(echo):E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7079 < *except-syntax-error*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7080 But when a syntax error is detected after a normal error in the same command,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7081 the syntax error is used for the exception being thrown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7082 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7083 unlet novar #
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7084 causes >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7085 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7086 E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7087 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7088 Vim(unlet):E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7089 This is done because the syntax error might change the execution path in a way
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7090 not intended by the user. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7091 try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7092 try | unlet novar # | catch | echo v:exception | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7093 catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7094 echo "outer catch:" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7095 endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7096 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7097 a "E600: Missing :endtry" error message is given, see |except-single-line|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7098
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7099 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7100 9. Examples *eval-examples*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7101
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7102 Printing in Hex ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7103 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7104 :" The function Nr2Hex() returns the Hex string of a number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7105 :func Nr2Hex(nr)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7106 : let n = a:nr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7107 : let r = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7108 : while n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7109 : let r = '0123456789ABCDEF'[n % 16] . r
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7110 : let n = n / 16
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7111 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7112 : return r
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7113 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7114
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7115 :" The function String2Hex() converts each character in a string to a two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7116 :" character Hex string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7117 :func String2Hex(str)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7118 : let out = ''
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7119 : let ix = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7120 : while ix < strlen(a:str)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7121 : let out = out . Nr2Hex(char2nr(a:str[ix]))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7122 : let ix = ix + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7123 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7124 : return out
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7125 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7127 Example of its use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7128 :echo Nr2Hex(32)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7129 result: "20" >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7130 :echo String2Hex("32")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7131 result: "3332"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7132
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7133
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7134 Sorting lines (by Robert Webb) ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7135
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7136 Here is a Vim script to sort lines. Highlight the lines in Vim and type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7137 ":Sort". This doesn't call any external programs so it'll work on any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7138 platform. The function Sort() actually takes the name of a comparison
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7139 function as its argument, like qsort() does in C. So you could supply it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7140 with different comparison functions in order to sort according to date etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7141 >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7142 :" Function for use with Sort(), to compare two strings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7143 :func! Strcmp(str1, str2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7144 : if (a:str1 < a:str2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7145 : return -1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7146 : elseif (a:str1 > a:str2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7147 : return 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7148 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7149 : return 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7150 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7151 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7152
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7153 :" Sort lines. SortR() is called recursively.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7154 :func! SortR(start, end, cmp)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7155 : if (a:start >= a:end)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7156 : return
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7157 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7158 : let partition = a:start - 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7159 : let middle = partition
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7160 : let partStr = getline((a:start + a:end) / 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7161 : let i = a:start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7162 : while (i <= a:end)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7163 : let str = getline(i)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7164 : exec "let result = " . a:cmp . "(str, partStr)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7165 : if (result <= 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7166 : " Need to put it before the partition. Swap lines i and partition.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7167 : let partition = partition + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7168 : if (result == 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7169 : let middle = partition
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7170 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7171 : if (i != partition)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7172 : let str2 = getline(partition)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7173 : call setline(i, str2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7174 : call setline(partition, str)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7175 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7176 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7177 : let i = i + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7178 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7179
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7180 : " Now we have a pointer to the "middle" element, as far as partitioning
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7181 : " goes, which could be anywhere before the partition. Make sure it is at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7182 : " the end of the partition.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7183 : if (middle != partition)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7184 : let str = getline(middle)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7185 : let str2 = getline(partition)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7186 : call setline(middle, str2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7187 : call setline(partition, str)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7188 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7189 : call SortR(a:start, partition - 1, a:cmp)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7190 : call SortR(partition + 1, a:end, a:cmp)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7191 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7192
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7193 :" To Sort a range of lines, pass the range to Sort() along with the name of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7194 :" function that will compare two lines.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7195 :func! Sort(cmp) range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7196 : call SortR(a:firstline, a:lastline, a:cmp)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7197 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7198
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7199 :" :Sort takes a range of lines and sorts them.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7200 :command! -nargs=0 -range Sort <line1>,<line2>call Sort("Strcmp")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7201 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7202 *sscanf*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7203 There is no sscanf() function in Vim. If you need to extract parts from a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7204 line, you can use matchstr() and substitute() to do it. This example shows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7205 how to get the file name, line number and column number out of a line like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7206 "foobar.txt, 123, 45". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7207 :" Set up the match bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7208 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7209 :"get the part matching the whole expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7210 :let l = matchstr(line, mx)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7211 :"get each item out of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7212 :let file = substitute(l, mx, '\1', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7213 :let lnum = substitute(l, mx, '\2', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7214 :let col = substitute(l, mx, '\3', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7215
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7216 The input is in the variable "line", the results in the variables "file",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7217 "lnum" and "col". (idea from Michael Geddes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7218
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7219 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7220 10. No +eval feature *no-eval-feature*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7221
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7222 When the |+eval| feature was disabled at compile time, none of the expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7223 evaluation commands are available. To prevent this from causing Vim scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7224 to generate all kinds of errors, the ":if" and ":endif" commands are still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7225 recognized, though the argument of the ":if" and everything between the ":if"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7226 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7227 only if the commands are at the start of the line. The ":else" command is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7228 recognized.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7229
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7230 Example of how to avoid executing commands when the |+eval| feature is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7231 missing: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7232
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7233 :if 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7234 : echo "Expression evaluation is compiled in"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7235 :else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7236 : echo "You will _never_ see this message"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7237 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7238
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7239 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7240 11. The sandbox *eval-sandbox* *sandbox* *E48*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7241
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7242 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7243 options are evaluated in a sandbox. This means that you are protected from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7244 these expressions having nasty side effects. This gives some safety for when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7245 these options are set from a modeline. It is also used when the command from
620
9e359e5759f6 updated for version 7.0177
vimboss
parents: 615
diff changeset
7246 a tags file is executed and for CTRL-R = in the command line.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7247 The sandbox is also used for the |:sandbox| command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7248
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7249 These items are not allowed in the sandbox:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7250 - changing the buffer text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7251 - defining or changing mapping, autocommands, functions, user commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7252 - setting certain options (see |option-summary|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7253 - executing a shell command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7254 - reading or writing a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7255 - jumping to another buffer or editing a file
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
7256 - executing Python, Perl, etc. commands
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7257 This is not guaranteed 100% secure, but it should block most attacks.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7258
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7259 *:san* *:sandbox*
401
4a1ead01d30b updated for version 7.0105
vimboss
parents: 395
diff changeset
7260 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7261 option that may have been set from a modeline, e.g.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7262 'foldexpr'.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
7263
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7264 *sandbox-option*
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7265 A few options contain an expression. When this expression is evaluated it may
790
c8680debe1cc updated for version 7.0230
vimboss
parents: 786
diff changeset
7266 have to be done in the sandbox to avoid a security risk. But the sandbox is
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7267 restrictive, thus this only happens when the option was set from an insecure
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7268 location. Insecure in this context are:
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7269 - sourcing a .vimrc or .exrc in the current directlry
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7270 - while executing in the sandbox
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7271 - value coming from a modeline
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7272
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7273 Note that when in the sandbox and saving an option value and restoring it, the
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7274 option will still be marked as it was set in the sandbox.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7275
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7276 ==============================================================================
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7277 12. Textlock *textlock*
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7278
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7279 In a few situations it is not allowed to change the text in the buffer, jump
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7280 to another window and some other things that might confuse or break what Vim
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7281 is currently doing. This mostly applies to things that happen when Vim is
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7282 actually doing something else. For example, evaluating the 'balloonexpr' may
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7283 happen any moment the mouse cursor is resting at some position.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7284
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7285 This is not allowed when the textlock is active:
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7286 - changing the buffer text
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7287 - jumping to another buffer or window
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7288 - editing another file
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7289 - closing a window or quitting Vim
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7290 - etc.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
7291
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7293 vim:tw=78:ts=8:ft=help:norl: